Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
docs/ApiErrorDetail.md
docs/ApiErrorResponse.md
docs/AsyncQueryResponse.md
docs/AttachDatabaseCatalogRequest.md
docs/BooleanProfileDetail.md
docs/CategoricalProfileDetail.md
docs/CategoryValueInfo.md
Expand All @@ -26,6 +27,8 @@ docs/ConnectionTypesApi.md
docs/ConnectionsApi.md
docs/CreateConnectionRequest.md
docs/CreateConnectionResponse.md
docs/CreateDatabaseRequest.md
docs/CreateDatabaseResponse.md
docs/CreateDatasetRequest.md
docs/CreateDatasetResponse.md
docs/CreateEmbeddingProviderRequest.md
Expand All @@ -37,6 +40,12 @@ docs/CreateSecretRequest.md
docs/CreateSecretResponse.md
docs/CreateWorkspaceRequest.md
docs/CreateWorkspaceResponse.md
docs/DatabaseAttachmentInfo.md
docs/DatabaseDefaultSchemaDecl.md
docs/DatabaseDefaultTableDecl.md
docs/DatabaseDetailResponse.md
docs/DatabaseSummary.md
docs/DatabasesApi.md
docs/DatasetSource.md
docs/DatasetSourceOneOf.md
docs/DatasetSourceOneOf1.md
Expand Down Expand Up @@ -71,6 +80,7 @@ docs/JobType.md
docs/JobsApi.md
docs/ListConnectionTypesResponse.md
docs/ListConnectionsResponse.md
docs/ListDatabasesResponse.md
docs/ListDatasetVersionsResponse.md
docs/ListDatasetsResponse.md
docs/ListEmbeddingProvidersResponse.md
Expand Down Expand Up @@ -144,6 +154,7 @@ hotdata/__init__.py
hotdata/api/__init__.py
hotdata/api/connection_types_api.py
hotdata/api/connections_api.py
hotdata/api/databases_api.py
hotdata/api/datasets_api.py
hotdata/api/embedding_providers_api.py
hotdata/api/indexes_api.py
Expand All @@ -167,6 +178,7 @@ hotdata/models/__init__.py
hotdata/models/api_error_detail.py
hotdata/models/api_error_response.py
hotdata/models/async_query_response.py
hotdata/models/attach_database_catalog_request.py
hotdata/models/boolean_profile_detail.py
hotdata/models/categorical_profile_detail.py
hotdata/models/category_value_info.py
Expand All @@ -187,6 +199,8 @@ hotdata/models/connection_type_detail.py
hotdata/models/connection_type_summary.py
hotdata/models/create_connection_request.py
hotdata/models/create_connection_response.py
hotdata/models/create_database_request.py
hotdata/models/create_database_response.py
hotdata/models/create_dataset_request.py
hotdata/models/create_dataset_response.py
hotdata/models/create_embedding_provider_request.py
Expand All @@ -198,6 +212,11 @@ hotdata/models/create_secret_request.py
hotdata/models/create_secret_response.py
hotdata/models/create_workspace_request.py
hotdata/models/create_workspace_response.py
hotdata/models/database_attachment_info.py
hotdata/models/database_default_schema_decl.py
hotdata/models/database_default_table_decl.py
hotdata/models/database_detail_response.py
hotdata/models/database_summary.py
hotdata/models/dataset_source.py
hotdata/models/dataset_source_one_of.py
hotdata/models/dataset_source_one_of1.py
Expand Down Expand Up @@ -227,6 +246,7 @@ hotdata/models/job_status_response.py
hotdata/models/job_type.py
hotdata/models/list_connection_types_response.py
hotdata/models/list_connections_response.py
hotdata/models/list_databases_response.py
hotdata/models/list_dataset_versions_response.py
hotdata/models/list_datasets_response.py
hotdata/models/list_embedding_providers_response.py
Expand Down Expand Up @@ -293,4 +313,14 @@ requirements.txt
setup.cfg
test-requirements.txt
test/__init__.py
test/test_attach_database_catalog_request.py
test/test_create_database_request.py
test/test_create_database_response.py
test/test_database_attachment_info.py
test/test_database_default_schema_decl.py
test/test_database_default_table_decl.py
test/test_database_detail_response.py
test/test_database_summary.py
test/test_databases_api.py
test/test_list_databases_response.py
tox.ini
31 changes: 31 additions & 0 deletions docs/AttachDatabaseCatalogRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# AttachDatabaseCatalogRequest

Request body for POST /databases/{database_id}/catalogs

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**alias** | **str** | Optional alias under which this catalog is reachable inside the database. When omitted, it is reachable by the connection's name. | [optional]
**connection_id** | **str** | |

## Example

```python
from hotdata.models.attach_database_catalog_request import AttachDatabaseCatalogRequest

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

# convert the object into a dict
attach_database_catalog_request_dict = attach_database_catalog_request_instance.to_dict()
# create an instance of AttachDatabaseCatalogRequest from a dict
attach_database_catalog_request_from_dict = AttachDatabaseCatalogRequest.from_dict(attach_database_catalog_request_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


1 change: 1 addition & 0 deletions docs/ConnectionTypeDetail.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# ConnectionTypeDetail

Detailed configuration and authentication schema for a single connection type.

## Properties

Expand Down
1 change: 1 addition & 0 deletions docs/ConnectionTypeSummary.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# ConnectionTypeSummary

Summary entry for the connection-type list endpoint.

## Properties

Expand Down
3 changes: 3 additions & 0 deletions docs/ConnectionsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,7 @@ void (empty response body)
|-------------|-------------|------------------|
**204** | Connection deleted | - |
**404** | Connection not found | - |
**409** | Connection backs a database's default catalog and cannot be deleted directly | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Expand Down Expand Up @@ -792,7 +793,9 @@ void (empty response body)
| Status code | Description | Response headers |
|-------------|-------------|------------------|
**204** | Cache purged | - |
**400** | Managed catalogs own their parquet generations and cannot be purged | - |
**404** | Connection not found | - |
**409** | Connection backs a database's default catalog and cannot be purged directly | - |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

Expand Down
31 changes: 31 additions & 0 deletions docs/CreateDatabaseRequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# CreateDatabaseRequest

Request body for POST /databases

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **str** | Optional free-form display label (for UIs/CLIs). Not unique. Not an identifier — databases are always addressed by `id`. | [optional]
**schemas** | [**List[DatabaseDefaultSchemaDecl]**](DatabaseDefaultSchemaDecl.md) | 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]

## Example

```python
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]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


32 changes: 32 additions & 0 deletions docs/CreateDatabaseResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# CreateDatabaseResponse

Response body for POST /databases

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**default_connection_id** | **str** | Internal id of the connection that backs this database's `default` catalog. Workspace-level connection endpoints (list, get, health, delete, cache purge) refuse to act on this id — it is exposed only for the managed-tables load endpoint (`POST /v1/connections/{id}/schemas/{s}/tables/{t}/loads`) so callers can publish parquet into tables declared at database-create time. Addressing it directly in SQL is not the recommended path — use `default` inside an `X-Database-Id` scope instead. |
**description** | **str** | | [optional]
**id** | **str** | |

## Example

```python
from hotdata.models.create_database_response import CreateDatabaseResponse

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

# convert the object into a dict
create_database_response_dict = create_database_response_instance.to_dict()
# create an instance of CreateDatabaseResponse from a dict
create_database_response_from_dict = CreateDatabaseResponse.from_dict(create_database_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


31 changes: 31 additions & 0 deletions docs/DatabaseAttachmentInfo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# DatabaseAttachmentInfo

One attached catalog inside a database.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**alias** | **str** | Alias under which this catalog is reachable inside the database. When `None`, the catalog is reachable by its original connection name. | [optional]
**connection_id** | **str** | |

## Example

```python
from hotdata.models.database_attachment_info import DatabaseAttachmentInfo

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

# convert the object into a dict
database_attachment_info_dict = database_attachment_info_instance.to_dict()
# create an instance of DatabaseAttachmentInfo from a dict
database_attachment_info_from_dict = DatabaseAttachmentInfo.from_dict(database_attachment_info_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


31 changes: 31 additions & 0 deletions docs/DatabaseDefaultSchemaDecl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# DatabaseDefaultSchemaDecl

One schema declaration inside the database's default catalog at create time. Mirrors `crate::source::ManagedSchemaDecl`. Tables default to empty so callers can declare just a schema name and add tables later via the managed-tables API on the default connection.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | |
**tables** | [**List[DatabaseDefaultTableDecl]**](DatabaseDefaultTableDecl.md) | | [optional]

## Example

```python
from hotdata.models.database_default_schema_decl import DatabaseDefaultSchemaDecl

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

# convert the object into a dict
database_default_schema_decl_dict = database_default_schema_decl_instance.to_dict()
# create an instance of DatabaseDefaultSchemaDecl from a dict
database_default_schema_decl_from_dict = DatabaseDefaultSchemaDecl.from_dict(database_default_schema_decl_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


30 changes: 30 additions & 0 deletions docs/DatabaseDefaultTableDecl.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# DatabaseDefaultTableDecl

One table declaration inside a default-catalog schema at database-create time. Mirrors `crate::source::ManagedTableDecl` shape so the controller can convert with a simple `.map`.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | |

## Example

```python
from hotdata.models.database_default_table_decl import DatabaseDefaultTableDecl

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

# convert the object into a dict
database_default_table_decl_dict = database_default_table_decl_instance.to_dict()
# create an instance of DatabaseDefaultTableDecl from a dict
database_default_table_decl_from_dict = DatabaseDefaultTableDecl.from_dict(database_default_table_decl_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


33 changes: 33 additions & 0 deletions docs/DatabaseDetailResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# DatabaseDetailResponse

Response body for GET /databases/{database_id}

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attachments** | [**List[DatabaseAttachmentInfo]**](DatabaseAttachmentInfo.md) | |
**default_connection_id** | **str** | |
**description** | **str** | | [optional]
**id** | **str** | |

## Example

```python
from hotdata.models.database_detail_response import DatabaseDetailResponse

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

# convert the object into a dict
database_detail_response_dict = database_detail_response_instance.to_dict()
# create an instance of DatabaseDetailResponse from a dict
database_detail_response_from_dict = DatabaseDetailResponse.from_dict(database_detail_response_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


31 changes: 31 additions & 0 deletions docs/DatabaseSummary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# DatabaseSummary

Summary item in GET /databases

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **str** | | [optional]
**id** | **str** | |

## Example

```python
from hotdata.models.database_summary import DatabaseSummary

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

# convert the object into a dict
database_summary_dict = database_summary_instance.to_dict()
# create an instance of DatabaseSummary from a dict
database_summary_from_dict = DatabaseSummary.from_dict(database_summary_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)


Loading