> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.
# configurations
# `prefect.server.database.configurations`
## Classes
### `ConnectionTracker` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L56](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L56)
A test utility which tracks the connections given out by a connection pool, to
make it easy to see which connections are currently checked out and open.
**Methods:**
#### `clear` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L110](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L110)
```python theme={null}
clear(self) -> None
```
#### `on_close` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L89](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L89)
```python theme={null}
on_close(self, adapted_connection: AdaptedConnection, connection_record: ConnectionPoolEntry) -> None
```
#### `on_close_detached` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L100](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L100)
```python theme={null}
on_close_detached(self, adapted_connection: AdaptedConnection) -> None
```
#### `on_connect` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L80](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L80)
```python theme={null}
on_connect(self, adapted_connection: AdaptedConnection, connection_record: ConnectionPoolEntry) -> None
```
#### `track_pool` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L75](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L75)
```python theme={null}
track_pool(self, pool: sa.pool.Pool) -> None
```
### `BaseDatabaseConfiguration` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L121](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L121)
Abstract base class used to inject database connection configuration into Prefect.
This configuration is responsible for defining how Prefect REST API creates and manages
database connections and sessions.
**Methods:**
#### `begin_transaction` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L212](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L212)
```python theme={null}
begin_transaction(self, session: AsyncSession, with_for_update: bool = False) -> AbstractAsyncContextManager[AsyncSessionTransaction]
```
Enter a transaction for a session
#### `create_db` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L196](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L196)
```python theme={null}
create_db(self, connection: AsyncConnection, base_metadata: sa.MetaData) -> None
```
Create the database
#### `drop_db` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L202](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L202)
```python theme={null}
drop_db(self, connection: AsyncConnection, base_metadata: sa.MetaData) -> None
```
Drop the database
#### `engine` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L186](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L186)
```python theme={null}
engine(self) -> AsyncEngine
```
Returns a SqlAlchemy engine
#### `is_inmemory` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L208](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L208)
```python theme={null}
is_inmemory(self) -> bool
```
Returns true if database is run in memory
#### `session` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L190](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L190)
```python theme={null}
session(self, engine: AsyncEngine) -> AsyncSession
```
Retrieves a SQLAlchemy session for an engine.
#### `unique_key` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L179](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L179)
```python theme={null}
unique_key(self) -> tuple[Hashable, ...]
```
Returns a key used to determine whether to instantiate a new DB interface.
### `AsyncPostgresConfiguration` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L219](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L219)
**Methods:**
#### `begin_transaction` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L420](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L420)
```python theme={null}
begin_transaction(self, session: AsyncSession, with_for_update: bool = False) -> AsyncGenerator[AsyncSessionTransaction, None]
```
#### `begin_transaction` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L212](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L212)
```python theme={null}
begin_transaction(self, session: AsyncSession, with_for_update: bool = False) -> AbstractAsyncContextManager[AsyncSessionTransaction]
```
Enter a transaction for a session
#### `create_db` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L428](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L428)
```python theme={null}
create_db(self, connection: AsyncConnection, base_metadata: sa.MetaData) -> None
```
Create the database
#### `create_db` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L196](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L196)
```python theme={null}
create_db(self, connection: AsyncConnection, base_metadata: sa.MetaData) -> None
```
Create the database
#### `drop_db` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L435](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L435)
```python theme={null}
drop_db(self, connection: AsyncConnection, base_metadata: sa.MetaData) -> None
```
Drop the database
#### `drop_db` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L202](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L202)
```python theme={null}
drop_db(self, connection: AsyncConnection, base_metadata: sa.MetaData) -> None
```
Drop the database
#### `engine` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L220](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L220)
```python theme={null}
engine(self) -> AsyncEngine
```
Retrieves an async SQLAlchemy engine.
**Returns:**
* a SQLAlchemy engine
#### `engine` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L186](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L186)
```python theme={null}
engine(self) -> AsyncEngine
```
Returns a SqlAlchemy engine
#### `is_inmemory` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L442](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L442)
```python theme={null}
is_inmemory(self) -> bool
```
Returns true if database is run in memory
#### `is_inmemory` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L208](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L208)
```python theme={null}
is_inmemory(self) -> bool
```
Returns true if database is run in memory
#### `schedule_engine_disposal` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L386](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L386)
```python theme={null}
schedule_engine_disposal(self, cache_key: _EngineCacheKey) -> None
```
Dispose of an engine once the event loop is closing.
See caveats at `add_event_loop_shutdown_callback`.
We attempted to lazily clean up old engines when new engines are created, but
if the loop the engine is attached to is already closed then the connections
cannot be cleaned up properly and warnings are displayed.
Engine disposal should only be important when running the application
ephemerally. Notably, this is an issue in our tests where many short-lived event
loops and engines are created which can consume all of the available database
connection slots. Users operating at a scale where connection limits are
encountered should be encouraged to use a standalone server.
#### `session` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L410](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L410)
```python theme={null}
session(self, engine: AsyncEngine) -> AsyncSession
```
Retrieves a SQLAlchemy session for an engine.
**Args:**
* `engine`: a sqlalchemy engine
#### `session` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L190](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L190)
```python theme={null}
session(self, engine: AsyncEngine) -> AsyncSession
```
Retrieves a SQLAlchemy session for an engine.
#### `unique_key` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L179](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L179)
```python theme={null}
unique_key(self) -> tuple[Hashable, ...]
```
Returns a key used to determine whether to instantiate a new DB interface.
### `AioSqliteConfiguration` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L448](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L448)
**Methods:**
#### `begin_sqlite_conn` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L585](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L585)
```python theme={null}
begin_sqlite_conn(self, conn: aiosqlite.AsyncAdapt_aiosqlite_connection) -> None
```
#### `begin_sqlite_stmt` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L594](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L594)
```python theme={null}
begin_sqlite_stmt(self, conn: sa.Connection) -> None
```
#### `begin_transaction` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L607](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L607)
```python theme={null}
begin_transaction(self, session: AsyncSession, with_for_update: bool = False) -> AsyncGenerator[AsyncSessionTransaction, None]
```
#### `begin_transaction` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L212](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L212)
```python theme={null}
begin_transaction(self, session: AsyncSession, with_for_update: bool = False) -> AbstractAsyncContextManager[AsyncSessionTransaction]
```
Enter a transaction for a session
#### `create_db` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L627](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L627)
```python theme={null}
create_db(self, connection: AsyncConnection, base_metadata: sa.MetaData) -> None
```
Create the database
#### `create_db` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L196](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L196)
```python theme={null}
create_db(self, connection: AsyncConnection, base_metadata: sa.MetaData) -> None
```
Create the database
#### `drop_db` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L634](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L634)
```python theme={null}
drop_db(self, connection: AsyncConnection, base_metadata: sa.MetaData) -> None
```
Drop the database
#### `drop_db` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L202](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L202)
```python theme={null}
drop_db(self, connection: AsyncConnection, base_metadata: sa.MetaData) -> None
```
Drop the database
#### `engine` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L452](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L452)
```python theme={null}
engine(self) -> AsyncEngine
```
Retrieves an async SQLAlchemy engine.
**Returns:**
* a SQLAlchemy engine
#### `engine` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L186](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L186)
```python theme={null}
engine(self) -> AsyncEngine
```
Returns a SqlAlchemy engine
#### `is_inmemory` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L641](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L641)
```python theme={null}
is_inmemory(self) -> bool
```
Returns true if database is run in memory
#### `is_inmemory` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L208](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L208)
```python theme={null}
is_inmemory(self) -> bool
```
Returns true if database is run in memory
#### `schedule_engine_disposal` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L510](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L510)
```python theme={null}
schedule_engine_disposal(self, cache_key: _EngineCacheKey) -> None
```
Dispose of an engine once the event loop is closing.
See caveats at `add_event_loop_shutdown_callback`.
We attempted to lazily clean up old engines when new engines are created, but
if the loop the engine is attached to is already closed then the connections
cannot be cleaned up properly and warnings are displayed.
Engine disposal should only be important when running the application
ephemerally. Notably, this is an issue in our tests where many short-lived event
loops and engines are created which can consume all of the available database
connection slots. Users operating at a scale where connection limits are
encountered should be encouraged to use a standalone server.
#### `session` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L618](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L618)
```python theme={null}
session(self, engine: AsyncEngine) -> AsyncSession
```
Retrieves a SQLAlchemy session for an engine.
**Args:**
* `engine`: a sqlalchemy engine
#### `session` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L190](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L190)
```python theme={null}
session(self, engine: AsyncEngine) -> AsyncSession
```
Retrieves a SQLAlchemy session for an engine.
#### `setup_sqlite` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L534](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L534)
```python theme={null}
setup_sqlite(self, conn: DBAPIConnection, record: ConnectionPoolEntry) -> None
```
Issue PRAGMA statements to SQLITE on connect. PRAGMAs only last for the
duration of the connection. See [https://www.sqlite.org/pragma.html](https://www.sqlite.org/pragma.html) for more info.
#### `unique_key` [https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L179](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/server/database/configurations.py#L179)
```python theme={null}
unique_key(self) -> tuple[Hashable, ...]
```
Returns a key used to determine whether to instantiate a new DB interface.