Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 2.19 KB

File metadata and controls

36 lines (27 loc) · 2.19 KB

CreateConnectionRequest

Request body for POST /connections

Properties

Name Type Description Notes
config Dict[str, object] Connection configuration object. Fields vary by source type (host, port, database, etc.).
name str
secret_id str Optional reference to a secret by ID (e.g., "secr_abc123"). If provided, this secret will be used for authentication. Mutually exclusive with `secret_name`. [optional]
secret_name str Optional reference to a secret by name. If provided, this secret will be used for authentication. Mutually exclusive with `secret_id`. [optional]
skip_discovery bool If true, skip automatic schema discovery after registering the connection. The connection will be created but no tables will be discovered. You can run discovery later via the refresh endpoint. [optional]
source_type str
storage_backend str Physical storage backend for tables created under this connection. `"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`; accepted for any source type and requires that pool to be configured. [optional]

Example

from hotdata.models.create_connection_request import CreateConnectionRequest

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

# convert the object into a dict
create_connection_request_dict = create_connection_request_instance.to_dict()
# create an instance of CreateConnectionRequest from a dict
create_connection_request_from_dict = CreateConnectionRequest.from_dict(create_connection_request_dict)

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