lance-namespace-urllib3-client 0.4.0

Lance Namespace Specification

lance-namespace-urllib3-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://lance.org/format/namespace/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://lance.org/format/namespace/rest for more details.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 0.4.0
• Generator version: 7.12.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.8+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import lance_namespace_urllib3_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import lance_namespace_urllib3_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import lance_namespace_urllib3_client
from lance_namespace_urllib3_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:2333
# See configuration.py for a list of all supported configuration parameters.
configuration = lance_namespace_urllib3_client.Configuration(
    host = "http://localhost:2333"
)

# 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.

configuration.access_token = os.environ["ACCESS_TOKEN"]

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

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

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


# Enter a context with an instance of the API client
with lance_namespace_urllib3_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = lance_namespace_urllib3_client.DataApi(api_client)
    id = 'id_example' # str | `string identifier` of an object in a namespace, following the Lance Namespace spec. When the value is equal to the delimiter, it represents the root namespace. For example, `v1/namespace/$/list` performs a `ListNamespace` on the root namespace. 
    alter_table_add_columns_request = lance_namespace_urllib3_client.AlterTableAddColumnsRequest() # AlterTableAddColumnsRequest | 
    delimiter = 'delimiter_example' # str | An optional delimiter of the `string identifier`, following the Lance Namespace spec. When not specified, the `$` delimiter must be used.  (optional)

    try:
        # Add new columns to table schema
        api_response = api_instance.alter_table_add_columns(id, alter_table_add_columns_request, delimiter=delimiter)
        print("The response of DataApi->alter_table_add_columns:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DataApi->alter_table_add_columns: %s\n" % e)

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	create_table_scalar_index	POST /v1/table/{id}/create_scalar_index	Create a scalar 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_scalar_index	POST /v1/table/{id}/create_scalar_index	Create a scalar index on a table
MetadataApi	create_table_tag	POST /v1/table/{id}/tags/create	Create a new tag
MetadataApi	declare_table	POST /v1/table/{id}/declare	Declare a table
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	POST /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	rename_table	POST /v1/table/{id}/rename	Rename a table
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_schema_metadata	POST /v1/table/{id}/schema_metadata/update	Update table schema metadata
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_scalar_index	POST /v1/table/{id}/create_scalar_index	Create a scalar index on a table
TableApi	create_table_tag	POST /v1/table/{id}/tags/create	Create a new tag
TableApi	declare_table	POST /v1/table/{id}/declare	Declare a table
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_all_tables	GET /v1/table	List all tables
TableApi	list_table_indices	POST /v1/table/{id}/index/list	List indexes on a table
TableApi	list_table_tags	POST /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	rename_table	POST /v1/table/{id}/rename	Rename a table
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_schema_metadata	POST /v1/table/{id}/schema_metadata/update	Update table schema metadata
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	POST /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

• AddVirtualColumnEntry
• AlterColumnsEntry
• AlterTableAddColumnsRequest
• AlterTableAddColumnsResponse
• AlterTableAlterColumnsRequest
• AlterTableAlterColumnsResponse
• AlterTableDropColumnsRequest
• AlterTableDropColumnsResponse
• AlterTransactionAction
• AlterTransactionRequest
• AlterTransactionResponse
• AlterTransactionSetProperty
• AlterTransactionSetStatus
• AlterTransactionUnsetProperty
• AlterVirtualColumnEntry
• AnalyzeTableQueryPlanRequest
• AnalyzeTableQueryPlanResponse
• BooleanQuery
• BoostQuery
• CountTableRowsRequest
• CreateEmptyTableRequest
• CreateEmptyTableResponse
• CreateNamespaceRequest
• CreateNamespaceResponse
• CreateTableIndexRequest
• CreateTableIndexResponse
• CreateTableRequest
• CreateTableResponse
• CreateTableScalarIndexResponse
• CreateTableTagRequest
• CreateTableTagResponse
• DeclareTableRequest
• DeclareTableResponse
• DeleteFromTableRequest
• DeleteFromTableResponse
• DeleteTableTagRequest
• DeleteTableTagResponse
• DeregisterTableRequest
• DeregisterTableResponse
• DescribeNamespaceRequest
• DescribeNamespaceResponse
• DescribeTableIndexStatsRequest
• DescribeTableIndexStatsResponse
• DescribeTableRequest
• DescribeTableResponse
• DescribeTransactionRequest
• DescribeTransactionResponse
• DropNamespaceRequest
• DropNamespaceResponse
• DropTableIndexRequest
• DropTableIndexResponse
• DropTableRequest
• DropTableResponse
• ErrorResponse
• ExplainTableQueryPlanRequest
• ExplainTableQueryPlanResponse
• FragmentStats
• FragmentSummary
• FtsQuery
• GetTableStatsRequest
• GetTableStatsResponse
• GetTableTagVersionRequest
• GetTableTagVersionResponse
• IndexContent
• InsertIntoTableRequest
• InsertIntoTableResponse
• JsonArrowDataType
• JsonArrowField
• JsonArrowSchema
• ListNamespacesRequest
• ListNamespacesResponse
• ListTableIndicesRequest
• ListTableIndicesResponse
• ListTableTagsRequest
• ListTableTagsResponse
• ListTableVersionsRequest
• ListTableVersionsResponse
• ListTablesRequest
• ListTablesResponse
• MatchQuery
• MergeInsertIntoTableRequest
• MergeInsertIntoTableResponse
• MultiMatchQuery
• NamespaceExistsRequest
• NewColumnTransform
• PhraseQuery
• QueryTableRequest
• QueryTableRequestColumns
• QueryTableRequestFullTextQuery
• QueryTableRequestVector
• RegisterTableRequest
• RegisterTableResponse
• RenameTableRequest
• RenameTableResponse
• RestoreTableRequest
• RestoreTableResponse
• StringFtsQuery
• StructuredFtsQuery
• TableBasicStats
• TableExistsRequest
• TableVersion
• TagContents
• UpdateTableRequest
• UpdateTableResponse
• UpdateTableSchemaMetadataRequest
• UpdateTableSchemaMetadataResponse
• UpdateTableTagRequest
• UpdateTableTagResponse

Documentation For Authorization

Authentication schemes defined for the API:

OAuth2

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes: N/A

BearerAuth

• Type: Bearer authentication

ApiKeyAuth

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header

Author