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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**newColumns** | [**List<NewColumnTransform>**](NewColumnTransform.md) | List of new columns to add | |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**alterations** | [**List<AlterColumnsEntry>**](AlterColumnsEntry.md) | List of column alterations to perform | |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**columns** | **List<String>** | Names of columns to drop | |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Alter a transaction with a list of actions. The server should either succeed and

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**actions** | [**List<AlterTransactionAction>**](AlterTransactionAction.md) | | |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**bypassVectorIndex** | **Boolean** | Whether to bypass vector index | [optional] |
|**columns** | [**QueryTableRequestColumns**](QueryTableRequestColumns.md) | | [optional] |
Expand Down
1 change: 1 addition & 0 deletions docs/src/client/operations/models/CountTableRowsRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**version** | **Long** | Version of the table to describe. If not specified, server should resolve it to the latest version. | [optional] |
|**predicate** | **String** | Optional SQL predicate to filter rows for counting | [optional] |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Request for creating an empty table. **Deprecated**: Use `DeclareTableRequest`

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**location** | **String** | Optional storage location for the table. If not provided, the namespace implementation should determine the table location. | [optional] |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**mode** | **String** | There are three modes when trying to create a namespace, to differentiate the behavior when a namespace of the same name already exists. Case insensitive, supports both PascalCase and snake_case. Valid values are: * Create: the operation fails with 409. * ExistOk: the operation succeeds and the existing namespace is kept. * Overwrite: the existing namespace is dropped and a new empty namespace with this name is created. | [optional] |
|**properties** | **Map<String, String>** | | [optional] |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**column** | **String** | Name of the column to create index on | |
|**indexType** | **String** | Type of index to create (e.g., BTREE, BITMAP, LABEL_LIST, IVF_FLAT, IVF_PQ, IVF_HNSW_SQ, FTS) | |
Expand Down
1 change: 1 addition & 0 deletions docs/src/client/operations/models/CreateTableRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Request for creating a table, excluding the Arrow IPC stream.

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**mode** | **String** | There are three modes when trying to create a table, to differentiate the behavior when a table of the same name already exists. Case insensitive, supports both PascalCase and snake_case. Valid values are: * Create: the operation fails with 409. * ExistOk: the operation succeeds and the existing table is kept. * Overwrite: the existing table is dropped and a new table with this name is created. | [optional] |

Expand Down
1 change: 1 addition & 0 deletions docs/src/client/operations/models/CreateTableTagRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**tag** | **String** | Name of the tag to create | |
|**version** | **Long** | Version number for the tag to point to | |
Expand Down
1 change: 1 addition & 0 deletions docs/src/client/operations/models/DeclareTableRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Request for declaring a table.

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**location** | **String** | Optional storage location for the table. If not provided, the namespace implementation should determine the table location. | [optional] |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Delete data from table based on a SQL predicate. Returns the number of rows that

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | The namespace identifier | [optional] |
|**predicate** | **String** | SQL predicate to filter rows for deletion | |

Expand Down
1 change: 1 addition & 0 deletions docs/src/client/operations/models/DeleteTableTagRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**tag** | **String** | Name of the tag to delete | |

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ The table content remains available in the storage.

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**version** | **Long** | Optional table version to get stats for | [optional] |
|**indexName** | **String** | Name of the index | [optional] |
Expand Down
1 change: 1 addition & 0 deletions docs/src/client/operations/models/DescribeTableRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**version** | **Long** | Version of the table to describe. If not specified, server should resolve it to the latest version. | [optional] |
|**withTableUri** | **Boolean** | Whether to include the table URI in the response. Default is false. | [optional] |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |


Expand Down
1 change: 1 addition & 0 deletions docs/src/client/operations/models/DropNamespaceRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**mode** | **String** | The mode for dropping a namespace, deciding the server behavior when the namespace to drop is not found. Case insensitive, supports both PascalCase and snake_case. Valid values are: - Fail (default): the server must return 400 indicating the namespace to drop does not exist. - Skip: the server must return 204 indicating the drop operation has succeeded. | [optional] |
|**behavior** | **String** | The behavior for dropping a namespace. Case insensitive, supports both PascalCase and snake_case. Valid values are: - Restrict (default): the namespace should not contain any table or child namespace when drop is initiated. If tables are found, the server should return error and not drop the namespace. - Cascade: all tables and child namespaces in the namespace are dropped before the namespace is dropped. | [optional] |
Expand Down
1 change: 1 addition & 0 deletions docs/src/client/operations/models/DropTableIndexRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**indexName** | **String** | Name of the index to drop | [optional] |

Expand Down
1 change: 1 addition & 0 deletions docs/src/client/operations/models/DropTableRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ If the table and its data can be immediately deleted, return information of the

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**query** | [**QueryTableRequest**](QueryTableRequest.md) | | |
|**verbose** | **Boolean** | Whether to return verbose explanation | [optional] |
Expand Down
1 change: 1 addition & 0 deletions docs/src/client/operations/models/GetTableStatsRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**tag** | **String** | Name of the tag to get version for | |

Expand Down
15 changes: 15 additions & 0 deletions docs/src/client/operations/models/Identity.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@


# Identity

Identity information of a request.

## Properties

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**apiKey** | **String** | API key for authentication. REST NAMESPACE ONLY This is passed via the `x-api-key` header. | [optional] |
|**authToken** | **String** | Bearer token for authentication. REST NAMESPACE ONLY This is passed via the `Authorization` header with the Bearer scheme (e.g., `Bearer <token>`). | [optional] |



Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Request for inserting records into a table, excluding the Arrow IPC stream.

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**mode** | **String** | How the insert should behave. Case insensitive, supports both PascalCase and snake_case. Valid values are: - Append (default): insert data to the existing table - Overwrite: remove all data in the table and then insert data to it | [optional] |

Expand Down
1 change: 1 addition & 0 deletions docs/src/client/operations/models/ListNamespacesRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**pageToken** | **String** | An opaque token that allows pagination for list operations (e.g. ListNamespaces). For an initial request of a list operation, if the implementation cannot return all items in one response, or if there are more items than the page limit specified in the request, the implementation must return a page token in the response, indicating there are more results available. After the initial request, the value of the page token from each response must be used as the page token value for the next request. Caller must interpret either `null`, missing value or empty string value of the page token from the implementation's response as the end of the listing results. | [optional] |
|**limit** | **Integer** | An inclusive upper bound of the number of results that a caller will receive. | [optional] |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | The namespace identifier | [optional] |
|**version** | **Long** | Optional table version to list indexes from | [optional] |
|**pageToken** | **String** | An opaque token that allows pagination for list operations (e.g. ListNamespaces). For an initial request of a list operation, if the implementation cannot return all items in one response, or if there are more items than the page limit specified in the request, the implementation must return a page token in the response, indicating there are more results available. After the initial request, the value of the page token from each response must be used as the page token value for the next request. Caller must interpret either `null`, missing value or empty string value of the page token from the implementation's response as the end of the listing results. | [optional] |
Expand Down
1 change: 1 addition & 0 deletions docs/src/client/operations/models/ListTableTagsRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | The table identifier | [optional] |
|**pageToken** | **String** | An opaque token that allows pagination for list operations (e.g. ListNamespaces). For an initial request of a list operation, if the implementation cannot return all items in one response, or if there are more items than the page limit specified in the request, the implementation must return a page token in the response, indicating there are more results available. After the initial request, the value of the page token from each response must be used as the page token value for the next request. Caller must interpret either `null`, missing value or empty string value of the page token from the implementation's response as the end of the listing results. | [optional] |
|**limit** | **Integer** | An inclusive upper bound of the number of results that a caller will receive. | [optional] |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**pageToken** | **String** | An opaque token that allows pagination for list operations (e.g. ListNamespaces). For an initial request of a list operation, if the implementation cannot return all items in one response, or if there are more items than the page limit specified in the request, the implementation must return a page token in the response, indicating there are more results available. After the initial request, the value of the page token from each response must be used as the page token value for the next request. Caller must interpret either `null`, missing value or empty string value of the page token from the implementation's response as the end of the listing results. | [optional] |
|**limit** | **Integer** | An inclusive upper bound of the number of results that a caller will receive. | [optional] |
Expand Down
1 change: 1 addition & 0 deletions docs/src/client/operations/models/ListTablesRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**pageToken** | **String** | An opaque token that allows pagination for list operations (e.g. ListNamespaces). For an initial request of a list operation, if the implementation cannot return all items in one response, or if there are more items than the page limit specified in the request, the implementation must return a page token in the response, indicating there are more results available. After the initial request, the value of the page token from each response must be used as the page token value for the next request. Caller must interpret either `null`, missing value or empty string value of the page token from the implementation's response as the end of the listing results. | [optional] |
|**limit** | **Integer** | An inclusive upper bound of the number of results that a caller will receive. | [optional] |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Request for merging or inserting records into a table, excluding the Arrow IPC s

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**on** | **String** | Column name to use for matching rows (required) | [optional] |
|**whenMatchedUpdateAll** | **Boolean** | Update all columns when rows match | [optional] |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |


Expand Down
1 change: 1 addition & 0 deletions docs/src/client/operations/models/QueryTableRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**bypassVectorIndex** | **Boolean** | Whether to bypass vector index | [optional] |
|**columns** | [**QueryTableRequestColumns**](QueryTableRequestColumns.md) | | [optional] |
Expand Down
1 change: 1 addition & 0 deletions docs/src/client/operations/models/RegisterTableRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**location** | **String** | | |
|**mode** | **String** | There are two modes when trying to register a table, to differentiate the behavior when a table of the same name already exists. Case insensitive, supports both PascalCase and snake_case. Valid values are: * Create (default): the operation fails with 409. * Overwrite: the existing table registration is replaced with the new registration. | [optional] |
Expand Down
1 change: 1 addition & 0 deletions docs/src/client/operations/models/RenameTableRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | The table identifier | [optional] |
|**newTableName** | **String** | New name for the table | |
|**newNamespaceId** | **List<String>** | New namespace identifier to move the table to (optional, if not specified the table stays in the same namespace) | [optional] |
Expand Down
1 change: 1 addition & 0 deletions docs/src/client/operations/models/RestoreTableRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**version** | **Long** | Version to restore to | |

Expand Down
1 change: 1 addition & 0 deletions docs/src/client/operations/models/TableExistsRequest.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@

| Name | Type | Description | Notes |
|------------ | ------------- | ------------- | -------------|
|**identity** | [**Identity**](Identity.md) | | [optional] |
|**id** | **List<String>** | | [optional] |
|**version** | **Long** | Version of the table to check existence. If not specified, server should resolve it to the latest version. | [optional] |

Expand Down
Loading