Rust API client for lance-namespace-reqwest-client
This OpenAPI specification is a part of the Lance namespace specification. It contains 2 parts:
The components/schemas
, components/responses
, components/examples
, tags
sections define
the request and response shape for each operation in a Lance Namespace across all implementations.
See https://lancedb.github.io/lance-namespace/spec/operations for more details.
The servers
, security
, paths
, components/parameters
sections are for the
Lance REST Namespace implementation, which defines a complete REST server that can work with Lance datasets.
See https://lancedb.github.io/lance-namespace/spec/impls/rest for more details.
Overview
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
- API version: 1.0.0
- Package version: 0.0.15
- Generator version: 7.12.0
- Build package:
org.openapitools.codegen.languages.RustClientCodegen
Installation
Put the package under your project folder in a directory named lance-namespace-reqwest-client
and add the following to Cargo.toml
under [dependencies]
:
lance-namespace-reqwest-client = { path = "./lance-namespace-reqwest-client" }
Documentation for API Endpoints
All URIs are relative to http://localhost:2333
Class | Method | HTTP request | Description |
---|---|---|---|
DataApi | alter_table_add_columns | POST /v1/table/{id}/add_columns | Add new columns to table schema |
DataApi | analyze_table_query_plan | POST /v1/table/{id}/analyze_plan | Analyze query execution plan |
DataApi | count_table_rows | POST /v1/table/{id}/count_rows | Count rows in a table |
DataApi | create_table | POST /v1/table/{id}/create | Create a table with the given name |
DataApi | delete_from_table | POST /v1/table/{id}/delete | Delete rows from a table |
DataApi | explain_table_query_plan | POST /v1/table/{id}/explain_plan | Get query execution plan explanation |
DataApi | insert_into_table | POST /v1/table/{id}/insert | Insert records into a table |
DataApi | merge_insert_into_table | POST /v1/table/{id}/merge_insert | Merge insert (upsert) records into a table |
DataApi | query_table | POST /v1/table/{id}/query | Query a table |
DataApi | update_table | POST /v1/table/{id}/update | Update rows in a table |
IndexApi | create_table_index | POST /v1/table/{id}/create_index | Create an index on a table |
IndexApi | describe_table_index_stats | POST /v1/table/{id}/index/{index_name}/stats | Get table index statistics |
IndexApi | drop_table_index | POST /v1/table/{id}/index/{index_name}/drop | Drop a specific index |
IndexApi | list_table_indices | POST /v1/table/{id}/index/list | List indexes on a table |
MetadataApi | alter_table_alter_columns | POST /v1/table/{id}/alter_columns | Modify existing columns |
MetadataApi | alter_table_drop_columns | POST /v1/table/{id}/drop_columns | Remove columns from table |
MetadataApi | alter_transaction | POST /v1/transaction/{id}/alter | Alter information of a transaction. |
MetadataApi | create_empty_table | POST /v1/table/{id}/create-empty | Create an empty table |
MetadataApi | create_namespace | POST /v1/namespace/{id}/create | Create a new namespace |
MetadataApi | create_table_index | POST /v1/table/{id}/create_index | Create an index on a table |
MetadataApi | create_table_tag | POST /v1/table/{id}/tags/create | Create a new tag |
MetadataApi | delete_table_tag | POST /v1/table/{id}/tags/delete | Delete a tag |
MetadataApi | deregister_table | POST /v1/table/{id}/deregister | Deregister a table |
MetadataApi | describe_namespace | POST /v1/namespace/{id}/describe | Describe a namespace |
MetadataApi | describe_table | POST /v1/table/{id}/describe | Describe information of a table |
MetadataApi | describe_table_index_stats | POST /v1/table/{id}/index/{index_name}/stats | Get table index statistics |
MetadataApi | describe_transaction | POST /v1/transaction/{id}/describe | Describe information about a transaction |
MetadataApi | drop_namespace | POST /v1/namespace/{id}/drop | Drop a namespace |
MetadataApi | drop_table | POST /v1/table/{id}/drop | Drop a table |
MetadataApi | drop_table_index | POST /v1/table/{id}/index/{index_name}/drop | Drop a specific index |
MetadataApi | get_table_stats | POST /v1/table/{id}/stats | Get table statistics |
MetadataApi | get_table_tag_version | POST /v1/table/{id}/tags/version | Get version for a specific tag |
MetadataApi | list_namespaces | GET /v1/namespace/{id}/list | List namespaces |
MetadataApi | list_table_indices | POST /v1/table/{id}/index/list | List indexes on a table |
MetadataApi | list_table_tags | GET /v1/table/{id}/tags/list | List all tags for a table |
MetadataApi | list_table_versions | POST /v1/table/{id}/version/list | List all versions of a table |
MetadataApi | list_tables | GET /v1/namespace/{id}/table/list | List tables in a namespace |
MetadataApi | namespace_exists | POST /v1/namespace/{id}/exists | Check if a namespace exists |
MetadataApi | register_table | POST /v1/table/{id}/register | Register a table to a namespace |
MetadataApi | restore_table | POST /v1/table/{id}/restore | Restore table to a specific version |
MetadataApi | table_exists | POST /v1/table/{id}/exists | Check if a table exists |
MetadataApi | update_table_tag | POST /v1/table/{id}/tags/update | Update a tag to point to a different version |
NamespaceApi | create_namespace | POST /v1/namespace/{id}/create | Create a new namespace |
NamespaceApi | describe_namespace | POST /v1/namespace/{id}/describe | Describe a namespace |
NamespaceApi | drop_namespace | POST /v1/namespace/{id}/drop | Drop a namespace |
NamespaceApi | list_namespaces | GET /v1/namespace/{id}/list | List namespaces |
NamespaceApi | list_tables | GET /v1/namespace/{id}/table/list | List tables in a namespace |
NamespaceApi | namespace_exists | POST /v1/namespace/{id}/exists | Check if a namespace exists |
TableApi | alter_table_add_columns | POST /v1/table/{id}/add_columns | Add new columns to table schema |
TableApi | alter_table_alter_columns | POST /v1/table/{id}/alter_columns | Modify existing columns |
TableApi | alter_table_drop_columns | POST /v1/table/{id}/drop_columns | Remove columns from table |
TableApi | analyze_table_query_plan | POST /v1/table/{id}/analyze_plan | Analyze query execution plan |
TableApi | count_table_rows | POST /v1/table/{id}/count_rows | Count rows in a table |
TableApi | create_empty_table | POST /v1/table/{id}/create-empty | Create an empty table |
TableApi | create_table | POST /v1/table/{id}/create | Create a table with the given name |
TableApi | create_table_index | POST /v1/table/{id}/create_index | Create an index on a table |
TableApi | create_table_tag | POST /v1/table/{id}/tags/create | Create a new tag |
TableApi | delete_from_table | POST /v1/table/{id}/delete | Delete rows from a table |
TableApi | delete_table_tag | POST /v1/table/{id}/tags/delete | Delete a tag |
TableApi | deregister_table | POST /v1/table/{id}/deregister | Deregister a table |
TableApi | describe_table | POST /v1/table/{id}/describe | Describe information of a table |
TableApi | describe_table_index_stats | POST /v1/table/{id}/index/{index_name}/stats | Get table index statistics |
TableApi | drop_table | POST /v1/table/{id}/drop | Drop a table |
TableApi | drop_table_index | POST /v1/table/{id}/index/{index_name}/drop | Drop a specific index |
TableApi | explain_table_query_plan | POST /v1/table/{id}/explain_plan | Get query execution plan explanation |
TableApi | get_table_stats | POST /v1/table/{id}/stats | Get table statistics |
TableApi | get_table_tag_version | POST /v1/table/{id}/tags/version | Get version for a specific tag |
TableApi | insert_into_table | POST /v1/table/{id}/insert | Insert records into a table |
TableApi | list_table_indices | POST /v1/table/{id}/index/list | List indexes on a table |
TableApi | list_table_tags | GET /v1/table/{id}/tags/list | List all tags for a table |
TableApi | list_table_versions | POST /v1/table/{id}/version/list | List all versions of a table |
TableApi | list_tables | GET /v1/namespace/{id}/table/list | List tables in a namespace |
TableApi | merge_insert_into_table | POST /v1/table/{id}/merge_insert | Merge insert (upsert) records into a table |
TableApi | query_table | POST /v1/table/{id}/query | Query a table |
TableApi | register_table | POST /v1/table/{id}/register | Register a table to a namespace |
TableApi | restore_table | POST /v1/table/{id}/restore | Restore table to a specific version |
TableApi | table_exists | POST /v1/table/{id}/exists | Check if a table exists |
TableApi | update_table | POST /v1/table/{id}/update | Update rows in a table |
TableApi | update_table_tag | POST /v1/table/{id}/tags/update | Update a tag to point to a different version |
TagApi | create_table_tag | POST /v1/table/{id}/tags/create | Create a new tag |
TagApi | delete_table_tag | POST /v1/table/{id}/tags/delete | Delete a tag |
TagApi | get_table_tag_version | POST /v1/table/{id}/tags/version | Get version for a specific tag |
TagApi | list_table_tags | GET /v1/table/{id}/tags/list | List all tags for a table |
TagApi | update_table_tag | POST /v1/table/{id}/tags/update | Update a tag to point to a different version |
TransactionApi | alter_transaction | POST /v1/transaction/{id}/alter | Alter information of a transaction. |
TransactionApi | describe_transaction | POST /v1/transaction/{id}/describe | Describe information about a transaction |
Documentation For Models
- AlterTableAddColumnsRequest
- AlterTableAddColumnsResponse
- AlterTableAlterColumnsRequest
- AlterTableAlterColumnsResponse
- AlterTableDropColumnsRequest
- AlterTableDropColumnsResponse
- AlterTransactionAction
- AlterTransactionRequest
- AlterTransactionResponse
- AlterTransactionSetProperty
- AlterTransactionSetStatus
- AlterTransactionUnsetProperty
- AnalyzeTableQueryPlanRequest
- AnalyzeTableQueryPlanResponse
- BooleanQuery
- BoostQuery
- ColumnAlteration
- CountTableRowsRequest
- CreateEmptyTableRequest
- CreateEmptyTableResponse
- CreateNamespaceRequest
- CreateNamespaceResponse
- CreateTableIndexRequest
- CreateTableIndexResponse
- CreateTableRequest
- CreateTableResponse
- CreateTableTagRequest
- DeleteFromTableRequest
- DeleteFromTableResponse
- DeleteTableTagRequest
- DeregisterTableRequest
- DeregisterTableResponse
- DescribeNamespaceRequest
- DescribeNamespaceResponse
- DescribeTableIndexStatsRequest
- DescribeTableIndexStatsResponse
- DescribeTableRequest
- DescribeTableResponse
- DescribeTransactionRequest
- DescribeTransactionResponse
- DropNamespaceRequest
- DropNamespaceResponse
- DropTableIndexRequest
- DropTableIndexResponse
- DropTableRequest
- DropTableResponse
- ErrorResponse
- ExplainTableQueryPlanRequest
- ExplainTableQueryPlanResponse
- FtsQuery
- GetTableStatsRequest
- GetTableStatsResponse
- GetTableTagVersionRequest
- GetTableTagVersionResponse
- IndexContent
- InsertIntoTableRequest
- InsertIntoTableResponse
- JsonArrowDataType
- JsonArrowField
- JsonArrowSchema
- ListNamespacesRequest
- ListNamespacesResponse
- ListTableIndicesRequest
- ListTableIndicesResponse
- ListTableTagsResponse
- ListTableVersionsRequest
- ListTableVersionsResponse
- ListTablesRequest
- ListTablesResponse
- MatchQuery
- MergeInsertIntoTableRequest
- MergeInsertIntoTableResponse
- MultiMatchQuery
- NamespaceExistsRequest
- NewColumnTransform
- Operator
- PhraseQuery
- QueryTableRequest
- QueryTableRequestFullTextQuery
- QueryTableRequestVector
- RegisterTableRequest
- RegisterTableResponse
- RestoreTableRequest
- RestoreTableResponse
- SetPropertyMode
- StringFtsQuery
- StructuredFtsQuery
- TableExistsRequest
- TableVersion
- TagContents
- TransactionStatus
- UnsetPropertyMode
- UpdateTableRequest
- UpdateTableResponse
- UpdateTableTagRequest
To get access to the crate's generated documentation, use:
cargo doc --open