> ## Documentation Index
> Fetch the complete documentation index at: /docs/llms.txt
> Use this file to discover all available pages before exploring further.

# database

# `prefect.settings.models.server.database`

## Functions

### `warn_on_database_password_value_without_usage` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/database.py#L340](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/database.py#L340)</sup>

```python theme={null}
warn_on_database_password_value_without_usage(settings: ServerDatabaseSettings) -> None
```

Validator for settings warning if the database password is set but not used.

## Classes

### `SQLAlchemyTLSSettings` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/database.py#L18](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/database.py#L18)</sup>

Settings for controlling SQLAlchemy mTLS context when
using a PostgreSQL database.

**Methods:**

#### `settings_customise_sources` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/base.py#L33](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/base.py#L33)</sup>

```python theme={null}
settings_customise_sources(cls, settings_cls: type[BaseSettings], init_settings: PydanticBaseSettingsSource, env_settings: PydanticBaseSettingsSource, dotenv_settings: PydanticBaseSettingsSource, file_secret_settings: PydanticBaseSettingsSource) -> tuple[PydanticBaseSettingsSource, ...]
```

Define an order for Prefect settings sources.

The order of the returned callables decides the priority of inputs; first item is the highest priority.

See [https://docs.pydantic.dev/latest/concepts/pydantic\_settings/#customise-settings-sources](https://docs.pydantic.dev/latest/concepts/pydantic_settings/#customise-settings-sources)

#### `to_environment_variables` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/base.py#L124](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/base.py#L124)</sup>

```python theme={null}
to_environment_variables(self, exclude_unset: bool = False, include_secrets: bool = True, include_aliases: bool = False) -> dict[str, str]
```

Convert the settings object to a dictionary of environment variables.

### `SQLAlchemyConnectArgsSettings` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/database.py#L54](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/database.py#L54)</sup>

Settings for controlling SQLAlchemy connection behavior; note that these settings only take effect when
using a PostgreSQL database.

**Methods:**

#### `settings_customise_sources` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/base.py#L33](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/base.py#L33)</sup>

```python theme={null}
settings_customise_sources(cls, settings_cls: type[BaseSettings], init_settings: PydanticBaseSettingsSource, env_settings: PydanticBaseSettingsSource, dotenv_settings: PydanticBaseSettingsSource, file_secret_settings: PydanticBaseSettingsSource) -> tuple[PydanticBaseSettingsSource, ...]
```

Define an order for Prefect settings sources.

The order of the returned callables decides the priority of inputs; first item is the highest priority.

See [https://docs.pydantic.dev/latest/concepts/pydantic\_settings/#customise-settings-sources](https://docs.pydantic.dev/latest/concepts/pydantic_settings/#customise-settings-sources)

#### `to_environment_variables` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/base.py#L124](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/base.py#L124)</sup>

```python theme={null}
to_environment_variables(self, exclude_unset: bool = False, include_secrets: bool = True, include_aliases: bool = False) -> dict[str, str]
```

Convert the settings object to a dictionary of environment variables.

### `SQLAlchemySettings` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/database.py#L99](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/database.py#L99)</sup>

Settings for controlling SQLAlchemy behavior; note that these settings only take effect when
using a PostgreSQL database.

**Methods:**

#### `settings_customise_sources` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/base.py#L33](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/base.py#L33)</sup>

```python theme={null}
settings_customise_sources(cls, settings_cls: type[BaseSettings], init_settings: PydanticBaseSettingsSource, env_settings: PydanticBaseSettingsSource, dotenv_settings: PydanticBaseSettingsSource, file_secret_settings: PydanticBaseSettingsSource) -> tuple[PydanticBaseSettingsSource, ...]
```

Define an order for Prefect settings sources.

The order of the returned callables decides the priority of inputs; first item is the highest priority.

See [https://docs.pydantic.dev/latest/concepts/pydantic\_settings/#customise-settings-sources](https://docs.pydantic.dev/latest/concepts/pydantic_settings/#customise-settings-sources)

#### `to_environment_variables` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/base.py#L124](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/base.py#L124)</sup>

```python theme={null}
to_environment_variables(self, exclude_unset: bool = False, include_secrets: bool = True, include_aliases: bool = False) -> dict[str, str]
```

Convert the settings object to a dictionary of environment variables.

### `ServerDatabaseSettings` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/database.py#L145](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/database.py#L145)</sup>

Settings for controlling server database behavior

**Methods:**

#### `emit_warnings` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/database.py#L334](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/database.py#L334)</sup>

```python theme={null}
emit_warnings(self) -> Self
```

More post-hoc validation of settings, including warnings for misconfigurations.

#### `set_deprecated_sqlalchemy_settings_on_child_model_and_warn` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/database.py#L305](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/database.py#L305)</sup>

```python theme={null}
set_deprecated_sqlalchemy_settings_on_child_model_and_warn(cls, values: dict[str, Any]) -> dict[str, Any]
```

Set deprecated settings on the child model.

#### `settings_customise_sources` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/base.py#L33](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/base.py#L33)</sup>

```python theme={null}
settings_customise_sources(cls, settings_cls: type[BaseSettings], init_settings: PydanticBaseSettingsSource, env_settings: PydanticBaseSettingsSource, dotenv_settings: PydanticBaseSettingsSource, file_secret_settings: PydanticBaseSettingsSource) -> tuple[PydanticBaseSettingsSource, ...]
```

Define an order for Prefect settings sources.

The order of the returned callables decides the priority of inputs; first item is the highest priority.

See [https://docs.pydantic.dev/latest/concepts/pydantic\_settings/#customise-settings-sources](https://docs.pydantic.dev/latest/concepts/pydantic_settings/#customise-settings-sources)

#### `to_environment_variables` <sup>[https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/base.py#L124](https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/base.py#L124)</sup>

```python theme={null}
to_environment_variables(self, exclude_unset: bool = False, include_secrets: bool = True, include_aliases: bool = False) -> dict[str, str]
```

Convert the settings object to a dictionary of environment variables.