Skip to content

Commit

Permalink
Fix schema generation issue
Browse files Browse the repository at this point in the history
  • Loading branch information
cicdw committed Jan 15, 2025
1 parent 42b783b commit 397a871
Show file tree
Hide file tree
Showing 4 changed files with 2,438 additions and 31 deletions.
81 changes: 57 additions & 24 deletions docs/v3/develop/settings-ref.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -871,6 +871,57 @@ Number of seconds a runner should wait between heartbeats for flow runs.

**TOML dotted key path**: `runner.server`

---
## SQLAlchemySettings
Settings for controlling SQLAlchemy behavior
### `pool_size`
Controls connection pool size of database connection pools from the Prefect API. If not set, the default SQLAlchemy pool size will be used.

**Type**: `integer | None`

**Default**: `None`

**TOML dotted key path**: `server.database.sqlalchemy.pool_size`

**Supported environment variables**:
`PREFECT_SERVER_DATABASE_SQLALCHEMY_POOL_SIZE`, `PREFECT_SQLALCHEMY_POOL_SIZE`

### `pool_recycle`
This setting causes the pool to recycle connections after the given number of seconds has passed; set it to -1 to avoid recycling entirely.

**Type**: `integer`

**Default**: `3600`

**TOML dotted key path**: `server.database.sqlalchemy.pool_recycle`

**Supported environment variables**:
`PREFECT_SERVER_DATABASE_SQLALCHEMY_POOL_RECYCLE`

### `pool_timeout`
Number of seconds to wait before giving up on getting a connection from the pool. Defaults to 30 seconds.

**Type**: `number | None`

**Default**: `30.0`

**TOML dotted key path**: `server.database.sqlalchemy.pool_timeout`

**Supported environment variables**:
`PREFECT_SERVER_DATABASE_SQLALCHEMY_POOL_TIMEOUT`

### `max_overflow`
Controls maximum overflow of the connection pool. If not set, the default SQLAlchemy maximum overflow value will be used.

**Type**: `integer | None`

**Default**: `None`

**TOML dotted key path**: `server.database.sqlalchemy.max_overflow`

**Supported environment variables**:
`PREFECT_SERVER_DATABASE_SQLALCHEMY_MAX_OVERFLOW`, `PREFECT_SQLALCHEMY_MAX_OVERFLOW`

---
## ServerAPISettings
Settings for controlling API server behavior
Expand Down Expand Up @@ -1039,6 +1090,12 @@ The default limit applied to queries that can return multiple objects, such as `
---
## ServerDatabaseSettings
Settings for controlling server database behavior
### `sqlalchemy`

**Type**: [SQLAlchemySettings](#sqlalchemysettings)

**TOML dotted key path**: `server.database.sqlalchemy`

### `connection_url`

A database connection URL in a SQLAlchemy-compatible
Expand Down Expand Up @@ -1182,18 +1239,6 @@ A connection timeout, in seconds, applied to database connections. Defaults to `
**Supported environment variables**:
`PREFECT_SERVER_DATABASE_CONNECTION_TIMEOUT`, `PREFECT_API_DATABASE_CONNECTION_TIMEOUT`

### `sqlalchemy_pool_size`
Controls connection pool size of database connection pools from the Prefect API. If not set, the default SQLAlchemy pool size will be used.

**Type**: `integer | None`

**Default**: `None`

**TOML dotted key path**: `server.database.sqlalchemy_pool_size`

**Supported environment variables**:
`PREFECT_SERVER_DATABASE_SQLALCHEMY_POOL_SIZE`, `PREFECT_SQLALCHEMY_POOL_SIZE`

### `connection_app_name`
Controls the application_name field for connections opened from the connection pool when using a PostgreSQL database with the Prefect API.

Expand All @@ -1206,18 +1251,6 @@ Controls the application_name field for connections opened from the connection p
**Supported environment variables**:
`PREFECT_SERVER_DATABASE_CONNECTION_APP_NAME`

### `sqlalchemy_max_overflow`
Controls maximum overflow of the connection pool when using a PostgreSQL database with the Prefect API. If not set, the default SQLAlchemy maximum overflow value will be used.

**Type**: `integer | None`

**Default**: `None`

**TOML dotted key path**: `server.database.sqlalchemy_max_overflow`

**Supported environment variables**:
`PREFECT_SERVER_DATABASE_SQLALCHEMY_MAX_OVERFLOW`, `PREFECT_SQLALCHEMY_MAX_OVERFLOW`

---
## ServerDeploymentsSettings
### `concurrency_slot_wait_seconds`
Expand Down
Loading

0 comments on commit 397a871

Please sign in to comment.