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
7 changes: 0 additions & 7 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -64,10 +64,3 @@ target/

# Ipython Notebook
.ipynb_checkpoints

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: (not blocking) This regeneration dropped the manually-added .gitignore entries (.DS_Store, .claude/settings.local.json, .claude/worktrees/). These aren't spec-driven and look like the OpenAPI generator clobbering hand-maintained ignores. Worth restoring them (and adding them to the generator's .openapi-generator-ignore so they survive future regenerations).


# macOS
.DS_Store

# Claude Code (local-only state)
.claude/settings.local.json
.claude/worktrees/
28 changes: 6 additions & 22 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@ docs/CreateDatasetResponse.md
docs/CreateEmbeddingProviderRequest.md
docs/CreateEmbeddingProviderResponse.md
docs/CreateIndexRequest.md
docs/CreateSandboxRequest.md
docs/CreateSavedQueryRequest.md
docs/CreateSecretRequest.md
docs/CreateSecretResponse.md
Expand All @@ -60,7 +59,6 @@ docs/DatasetSourceOneOf4.md
docs/DatasetSummary.md
docs/DatasetVersionSummary.md
docs/DatasetsApi.md
docs/DeleteSandboxResponse.md
docs/DiscoveryStatus.md
docs/EmbeddingProviderResponse.md
docs/EmbeddingProvidersApi.md
Expand All @@ -71,6 +69,7 @@ docs/GetDatabaseContextResponse.md
docs/GetDatasetResponse.md
docs/GetResultResponse.md
docs/GetSecretResponse.md
docs/IndexEntryResponse.md
docs/IndexInfoResponse.md
docs/IndexStatus.md
docs/IndexesApi.md
Expand All @@ -90,11 +89,11 @@ docs/ListDatabasesResponse.md
docs/ListDatasetVersionsResponse.md
docs/ListDatasetsResponse.md
docs/ListEmbeddingProvidersResponse.md
docs/ListIndexesPageResponse.md
docs/ListIndexesResponse.md
docs/ListJobsResponse.md
docs/ListQueryRunsResponse.md
docs/ListResultsResponse.md
docs/ListSandboxesResponse.md
docs/ListSavedQueriesResponse.md
docs/ListSavedQueryVersionsResponse.md
docs/ListSecretsResponse.md
Expand All @@ -118,9 +117,6 @@ docs/RefreshWarning.md
docs/ResultInfo.md
docs/ResultsApi.md
docs/ResultsFormatQuery.md
docs/Sandbox.md
docs/SandboxResponse.md
docs/SandboxesApi.md
docs/SavedQueriesApi.md
docs/SavedQueryDatasetSource.md
docs/SavedQueryDetail.md
Expand All @@ -141,7 +137,6 @@ docs/UpdateDatasetRequest.md
docs/UpdateDatasetResponse.md
docs/UpdateEmbeddingProviderRequest.md
docs/UpdateEmbeddingProviderResponse.md
docs/UpdateSandboxRequest.md
docs/UpdateSavedQueryRequest.md
docs/UpdateSecretRequest.md
docs/UpdateSecretResponse.md
Expand Down Expand Up @@ -170,7 +165,6 @@ hotdata/api/query_api.py
hotdata/api/query_runs_api.py
hotdata/api/refresh_api.py
hotdata/api/results_api.py
hotdata/api/sandboxes_api.py
hotdata/api/saved_queries_api.py
hotdata/api/secrets_api.py
hotdata/api/uploads_api.py
Expand Down Expand Up @@ -214,7 +208,6 @@ hotdata/models/create_dataset_response.py
hotdata/models/create_embedding_provider_request.py
hotdata/models/create_embedding_provider_response.py
hotdata/models/create_index_request.py
hotdata/models/create_sandbox_request.py
hotdata/models/create_saved_query_request.py
hotdata/models/create_secret_request.py
hotdata/models/create_secret_response.py
Expand All @@ -234,7 +227,6 @@ hotdata/models/dataset_source_one_of3.py
hotdata/models/dataset_source_one_of4.py
hotdata/models/dataset_summary.py
hotdata/models/dataset_version_summary.py
hotdata/models/delete_sandbox_response.py
hotdata/models/discovery_status.py
hotdata/models/embedding_provider_response.py
hotdata/models/error.py
Expand All @@ -244,6 +236,7 @@ hotdata/models/get_database_context_response.py
hotdata/models/get_dataset_response.py
hotdata/models/get_result_response.py
hotdata/models/get_secret_response.py
hotdata/models/index_entry_response.py
hotdata/models/index_info_response.py
hotdata/models/index_status.py
hotdata/models/information_schema_response.py
Expand All @@ -260,11 +253,11 @@ 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
hotdata/models/list_indexes_page_response.py
hotdata/models/list_indexes_response.py
hotdata/models/list_jobs_response.py
hotdata/models/list_query_runs_response.py
hotdata/models/list_results_response.py
hotdata/models/list_sandboxes_response.py
hotdata/models/list_saved_queries_response.py
hotdata/models/list_saved_query_versions_response.py
hotdata/models/list_secrets_response.py
Expand All @@ -284,8 +277,6 @@ hotdata/models/refresh_response.py
hotdata/models/refresh_warning.py
hotdata/models/result_info.py
hotdata/models/results_format_query.py
hotdata/models/sandbox.py
hotdata/models/sandbox_response.py
hotdata/models/saved_query_dataset_source.py
hotdata/models/saved_query_detail.py
hotdata/models/saved_query_summary.py
Expand All @@ -304,7 +295,6 @@ hotdata/models/update_dataset_request.py
hotdata/models/update_dataset_response.py
hotdata/models/update_embedding_provider_request.py
hotdata/models/update_embedding_provider_response.py
hotdata/models/update_sandbox_request.py
hotdata/models/update_saved_query_request.py
hotdata/models/update_secret_request.py
hotdata/models/update_secret_response.py
Expand All @@ -318,14 +308,8 @@ hotdata/models/workspace_detail.py
hotdata/models/workspace_list_item.py
hotdata/py.typed
hotdata/rest.py
pyproject.toml
requirements.txt
setup.cfg
test-requirements.txt
test/__init__.py
test/test_add_managed_schema_request.py
test/test_add_managed_table_decl.py
test/test_add_managed_table_request.py
test/test_managed_schema_response.py
test/test_managed_table_response.py
test/test_index_entry_response.py
test/test_list_indexes_page_response.py
tox.ini
39 changes: 39 additions & 0 deletions docs/IndexEntryResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# IndexEntryResponse

One index in a cross-table listing: the per-table [`IndexInfoResponse`] plus the identity needed to know which table it belongs to.

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**columns** | **List[str]** | |
**created_at** | **datetime** | |
**index_name** | **str** | |
**index_type** | **str** | |
**metric** | **str** | Distance metric this index was built with. Only present for vector indexes. | [optional]
**status** | [**IndexStatus**](IndexStatus.md) | |
**updated_at** | **datetime** | |
**connection_id** | **str** | | [optional]
**schema_name** | **str** | |
**table_name** | **str** | |

## Example

```python
from hotdata.models.index_entry_response import IndexEntryResponse

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

# convert the object into a dict
index_entry_response_dict = index_entry_response_instance.to_dict()
# create an instance of IndexEntryResponse from a dict
index_entry_response_from_dict = IndexEntryResponse.from_dict(index_entry_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)


101 changes: 101 additions & 0 deletions docs/IndexesApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ Method | HTTP request | Description
[**delete_index**](IndexesApi.md#delete_index) | **DELETE** /v1/connections/{connection_id}/tables/{schema}/{table}/indexes/{index_name} | Delete an index
[**list_dataset_indexes**](IndexesApi.md#list_dataset_indexes) | **GET** /v1/datasets/{dataset_id}/indexes | List indexes on a dataset
[**list_indexes**](IndexesApi.md#list_indexes) | **GET** /v1/connections/{connection_id}/tables/{schema}/{table}/indexes | List indexes on a table
[**list_indexes_collection**](IndexesApi.md#list_indexes_collection) | **GET** /v1/indexes | List indexes across tables in a database


# **create_dataset_index**
Expand Down Expand Up @@ -571,3 +572,103 @@ Name | Type | Description | Notes

[[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)

# **list_indexes_collection**
> ListIndexesPageResponse list_indexes_collection(x_database_id, connection_id=connection_id, var_schema=var_schema, table=table, index_type=index_type, limit=limit, cursor=cursor)

List indexes across tables in a database

List all indexes in the database identified by the required X-Database-Id header, paginated. Optional filters narrow by connection, schema, table, or index type.

### Example

* Api Key Authentication (WorkspaceId):
* Bearer Authentication (BearerAuth):

```python
import hotdata
from hotdata.models.list_indexes_page_response import ListIndexesPageResponse
from hotdata.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.hotdata.dev
# See configuration.py for a list of all supported configuration parameters.
configuration = hotdata.Configuration(
host = "https://api.hotdata.dev"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: WorkspaceId
configuration.api_key['WorkspaceId'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['WorkspaceId'] = 'Bearer'

# Configure Bearer authorization: BearerAuth
configuration = hotdata.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with hotdata.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = hotdata.IndexesApi(api_client)
x_database_id = 'x_database_id_example' # str | Database to scope to (required)
connection_id = 'connection_id_example' # str | Filter to one connection (optional)
var_schema = 'var_schema_example' # str | Filter by schema name (optional)
table = 'table_example' # str | Filter by table name (optional)
index_type = 'index_type_example' # str | Filter by index type (optional)
limit = 56 # int | Max indexes per page (optional)
cursor = 'cursor_example' # str | Pagination cursor (optional)

try:
# List indexes across tables in a database
api_response = api_instance.list_indexes_collection(x_database_id, connection_id=connection_id, var_schema=var_schema, table=table, index_type=index_type, limit=limit, cursor=cursor)
print("The response of IndexesApi->list_indexes_collection:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling IndexesApi->list_indexes_collection: %s\n" % e)
```



### Parameters


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**x_database_id** | **str**| Database to scope to (required) |
**connection_id** | **str**| Filter to one connection | [optional]
**var_schema** | **str**| Filter by schema name | [optional]
**table** | **str**| Filter by table name | [optional]
**index_type** | **str**| Filter by index type | [optional]
**limit** | **int**| Max indexes per page | [optional]
**cursor** | **str**| Pagination cursor | [optional]

### Return type

[**ListIndexesPageResponse**](ListIndexesPageResponse.md)

### Authorization

[WorkspaceId](../README.md#WorkspaceId), [BearerAuth](../README.md#BearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

### HTTP response details

| Status code | Description | Response headers |
|-------------|-------------|------------------|
**200** | Indexes listed | - |
**400** | Missing X-Database-Id or bad cursor | - |
**404** | Database not found | - |
**500** | Internal server error | - |

[[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)

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

Response body for `GET /v1/indexes` (paginated, cross-table).

## Properties

Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**count** | **int** | |
**has_more** | **bool** | |
**indexes** | [**List[IndexEntryResponse]**](IndexEntryResponse.md) | |
**limit** | **int** | |
**next_cursor** | **str** | | [optional]

## Example

```python
from hotdata.models.list_indexes_page_response import ListIndexesPageResponse

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

# convert the object into a dict
list_indexes_page_response_dict = list_indexes_page_response_instance.to_dict()
# create an instance of ListIndexesPageResponse from a dict
list_indexes_page_response_from_dict = ListIndexesPageResponse.from_dict(list_indexes_page_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)


1 change: 0 additions & 1 deletion docs/WorkspaceDetail.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ Name | Type | Description | Notes
**public_id** | **str** | |
**name** | **str** | |
**provision_status** | **str** | |
**namespace** | **str** | |

## Example

Expand Down
1 change: 0 additions & 1 deletion docs/WorkspaceListItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ Name | Type | Description | Notes
**active** | **bool** | |
**favorite** | **bool** | |
**provision_status** | **str** | |
**namespace** | **str** | |

## Example

Expand Down
Loading
Loading