Skip to content

PostgresDataApi

laktory.models.resources.databricks.PostgresDataApi ¤

Bases: PostgresDataApiBase

Lakebase Autoscaling (Postgres) Data API

REST API over the schemas of a database. spec must set at least one field on create, typically db_schemas (the schemas must exist). Can also be declared as the data_api of a PostgresDatabase.

Examples:

import io

from laktory import models

api_yaml = '''
parent: projects/app/branches/production/databases/app-db
spec:
  db_schemas:
  - public
  db_max_rows: 1000
'''
api = models.resources.databricks.PostgresDataApi.model_validate_yaml(
    io.StringIO(api_yaml)
)
References
BASE DESCRIPTION
parent

Database exposed by the API (projects/{project_id}/branches/{branch_id}/databases/{database_id}). Set automatically when declared as the data_api of a database.

TYPE: str | VariableType DEFAULT: None

provider_config

Configure the provider for management through account provider

TYPE: PostgresDataApiProviderConfig | None | VariableType DEFAULT: None

spec

The desired Data API configuration

TYPE: PostgresDataApiSpec | None | VariableType DEFAULT: None

laktory.models.resources.databricks.postgresdataapi.PostgresDataApiProviderConfig ¤

Bases: BaseModel

PARAMETER DESCRIPTION
workspace_id

Workspace ID which the resource belongs to. This workspace must be part of the account which the provider is configured with

TYPE: str | None | VariableType DEFAULT: None

laktory.models.resources.databricks.postgresdataapi.PostgresDataApiSpec ¤

Bases: BaseModel

PARAMETER DESCRIPTION
db_aggregates_enabled

Actual aggregate function setting read from the database

TYPE: bool | None | VariableType DEFAULT: None

db_extra_search_path

Actual extra search path schemas read from the database

TYPE: list[str] | None | VariableType DEFAULT: None

db_max_rows

Actual max rows setting read from the database

TYPE: int | None | VariableType DEFAULT: None

db_schemas

Actual exposed schemas read from the database

TYPE: list[str] | None | VariableType DEFAULT: None

jwt_cache_max_lifetime

Actual JWT cache max lifetime read from the database

TYPE: str | None | VariableType DEFAULT: None

jwt_role_claim_key

Actual JWT role claim key read from the database

TYPE: str | None | VariableType DEFAULT: None

openapi_mode

Actual OpenAPI mode read from the database. Possible values are: OPEN_API_MODE_DISABLED, OPEN_API_MODE_IGNORE_PRIVILEGES

TYPE: str | None | VariableType DEFAULT: None

server_cors_allowed_origins

Actual CORS allowed origins read from the database

TYPE: list[str] | None | VariableType DEFAULT: None

server_timing_enabled

Actual Server-Timing header setting read from the database

TYPE: bool | None | VariableType DEFAULT: None