Skip to content

Base API Reference

The Base class manages the global driver connection, database configuration, and model registry for the OGM system.

Class Definition

Base

Bases: BaseModel

Static base class for all Neo4j ORM models

set_driver classmethod

set_driver(driver: Driver)

get_driver classmethod

get_driver() -> Driver

set_database classmethod

set_database(database: str)

Set the default database for all OGM operations

get_database classmethod

get_database()

Get the configured database or DEFAULT_DATABASE

discover_models classmethod

discover_models()

Models are automatically discovered via import-time registration

get_registry classmethod

get_registry()

Return the simple model registry dict

get_class_by_name classmethod

get_class_by_name(name)

Get a model class by its name