Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 2.71 KB

File metadata and controls

33 lines (24 loc) · 2.71 KB

CreateDatabaseRequest

Request body for POST /databases

Properties

Name Type Description Notes
expires_at str When this database expires. Accepts either an RFC 3339 timestamp (e.g. `"2026-06-01T00:00:00Z"`) or a relative duration suffixed with `h` (hours), `m` (minutes), or `d` (days) — for example `"24h"`, `"48h"`, or `"7d"`. Omitted (or empty) means the database never expires. Expiry is best-effort: the database will not be deleted before `expires_at`, but cleanup may run later than the exact timestamp. [optional]
name str Optional free-form display label (for UIs/CLIs). Not unique. Not an identifier — databases are always addressed by `id`. Accepts the legacy `description` key as an alias so clients that predate the rename keep populating this field. [optional]
schemas List[DatabaseDefaultSchemaDecl] Optional schemas/tables to declare on the database's auto-created `default` catalog. Mirrors the `config.schemas` field of a managed `POST /v1/connections`. Tables declared here can be loaded via the standard managed-table load endpoint targeting `default_connection_id`. Omitted or empty means the default catalog starts empty. [optional]
storage_backend str Physical storage backend for the database's auto-created `default` catalog. `"parquet"` (default) uses the versioned parquet cache. `"ducklake"` stores data in a DuckLake catalog in the shared metadata DB configured via `ducklake.metadata_pg_url`, which must be configured for that value to be accepted. Omitted means `"parquet"`. [optional]

Example

from hotdata.models.create_database_request import CreateDatabaseRequest

# TODO update the JSON string below
json = "{}"
# create an instance of CreateDatabaseRequest from a JSON string
create_database_request_instance = CreateDatabaseRequest.from_json(json)
# print the JSON string representation of the object
print(CreateDatabaseRequest.to_json())

# convert the object into a dict
create_database_request_dict = create_database_request_instance.to_dict()
# create an instance of CreateDatabaseRequest from a dict
create_database_request_from_dict = CreateDatabaseRequest.from_dict(create_database_request_dict)

[Back to Model list] [Back to API list] [Back to README]