Oven logo

Oven

lance-namespace-urllib3-client0.0.14

Published

Lance Namespace Specification

pip install lance-namespace-urllib3-client

Package Downloads

Weekly DownloadsMonthly Downloads

Project URLs

Requires Python

>=3.8

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://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.

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

  • API version: 1.0.0
  • Package version: 0.0.14
  • 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"
)



# 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

ClassMethodHTTP requestDescription
DataApialter_table_add_columnsPOST /v1/table/{id}/add_columnsAdd new columns to table schema
DataApianalyze_table_query_planPOST /v1/table/{id}/analyze_planAnalyze query execution plan
DataApicount_table_rowsPOST /v1/table/{id}/count_rowsCount rows in a table
DataApicreate_tablePOST /v1/table/{id}/createCreate a table with the given name
DataApidelete_from_tablePOST /v1/table/{id}/deleteDelete rows from a table
DataApiexplain_table_query_planPOST /v1/table/{id}/explain_planGet query execution plan explanation
DataApiinsert_into_tablePOST /v1/table/{id}/insertInsert records into a table
DataApimerge_insert_into_tablePOST /v1/table/{id}/merge_insertMerge insert (upsert) records into a table
DataApiquery_tablePOST /v1/table/{id}/queryQuery a table
DataApiupdate_tablePOST /v1/table/{id}/updateUpdate rows in a table
IndexApicreate_table_indexPOST /v1/table/{id}/create_indexCreate an index on a table
IndexApidescribe_table_index_statsPOST /v1/table/{id}/index/{index_name}/statsGet table index statistics
IndexApidrop_table_indexPOST /v1/table/{id}/index/{index_name}/dropDrop a specific index
IndexApilist_table_indicesPOST /v1/table/{id}/index/listList indexes on a table
MetadataApialter_table_alter_columnsPOST /v1/table/{id}/alter_columnsModify existing columns
MetadataApialter_table_drop_columnsPOST /v1/table/{id}/drop_columnsRemove columns from table
MetadataApialter_transactionPOST /v1/transaction/{id}/alterAlter information of a transaction.
MetadataApicreate_empty_tablePOST /v1/table/{id}/create-emptyCreate an empty table
MetadataApicreate_namespacePOST /v1/namespace/{id}/createCreate a new namespace
MetadataApicreate_table_indexPOST /v1/table/{id}/create_indexCreate an index on a table
MetadataApicreate_table_tagPOST /v1/table/{id}/tags/createCreate a new tag
MetadataApidelete_table_tagPOST /v1/table/{id}/tags/deleteDelete a tag
MetadataApideregister_tablePOST /v1/table/{id}/deregisterDeregister a table
MetadataApidescribe_namespacePOST /v1/namespace/{id}/describeDescribe a namespace
MetadataApidescribe_tablePOST /v1/table/{id}/describeDescribe information of a table
MetadataApidescribe_table_index_statsPOST /v1/table/{id}/index/{index_name}/statsGet table index statistics
MetadataApidescribe_transactionPOST /v1/transaction/{id}/describeDescribe information about a transaction
MetadataApidrop_namespacePOST /v1/namespace/{id}/dropDrop a namespace
MetadataApidrop_tablePOST /v1/table/{id}/dropDrop a table
MetadataApidrop_table_indexPOST /v1/table/{id}/index/{index_name}/dropDrop a specific index
MetadataApiget_table_statsPOST /v1/table/{id}/statsGet table statistics
MetadataApiget_table_tag_versionPOST /v1/table/{id}/tags/versionGet version for a specific tag
MetadataApilist_namespacesGET /v1/namespace/{id}/listList namespaces
MetadataApilist_table_indicesPOST /v1/table/{id}/index/listList indexes on a table
MetadataApilist_table_tagsGET /v1/table/{id}/tags/listList all tags for a table
MetadataApilist_table_versionsPOST /v1/table/{id}/version/listList all versions of a table
MetadataApilist_tablesGET /v1/namespace/{id}/table/listList tables in a namespace
MetadataApinamespace_existsPOST /v1/namespace/{id}/existsCheck if a namespace exists
MetadataApiregister_tablePOST /v1/table/{id}/registerRegister a table to a namespace
MetadataApirestore_tablePOST /v1/table/{id}/restoreRestore table to a specific version
MetadataApitable_existsPOST /v1/table/{id}/existsCheck if a table exists
MetadataApiupdate_table_tagPOST /v1/table/{id}/tags/updateUpdate a tag to point to a different version
NamespaceApicreate_namespacePOST /v1/namespace/{id}/createCreate a new namespace
NamespaceApidescribe_namespacePOST /v1/namespace/{id}/describeDescribe a namespace
NamespaceApidrop_namespacePOST /v1/namespace/{id}/dropDrop a namespace
NamespaceApilist_namespacesGET /v1/namespace/{id}/listList namespaces
NamespaceApilist_tablesGET /v1/namespace/{id}/table/listList tables in a namespace
NamespaceApinamespace_existsPOST /v1/namespace/{id}/existsCheck if a namespace exists
TableApialter_table_add_columnsPOST /v1/table/{id}/add_columnsAdd new columns to table schema
TableApialter_table_alter_columnsPOST /v1/table/{id}/alter_columnsModify existing columns
TableApialter_table_drop_columnsPOST /v1/table/{id}/drop_columnsRemove columns from table
TableApianalyze_table_query_planPOST /v1/table/{id}/analyze_planAnalyze query execution plan
TableApicount_table_rowsPOST /v1/table/{id}/count_rowsCount rows in a table
TableApicreate_empty_tablePOST /v1/table/{id}/create-emptyCreate an empty table
TableApicreate_tablePOST /v1/table/{id}/createCreate a table with the given name
TableApicreate_table_indexPOST /v1/table/{id}/create_indexCreate an index on a table
TableApicreate_table_tagPOST /v1/table/{id}/tags/createCreate a new tag
TableApidelete_from_tablePOST /v1/table/{id}/deleteDelete rows from a table
TableApidelete_table_tagPOST /v1/table/{id}/tags/deleteDelete a tag
TableApideregister_tablePOST /v1/table/{id}/deregisterDeregister a table
TableApidescribe_tablePOST /v1/table/{id}/describeDescribe information of a table
TableApidescribe_table_index_statsPOST /v1/table/{id}/index/{index_name}/statsGet table index statistics
TableApidrop_tablePOST /v1/table/{id}/dropDrop a table
TableApidrop_table_indexPOST /v1/table/{id}/index/{index_name}/dropDrop a specific index
TableApiexplain_table_query_planPOST /v1/table/{id}/explain_planGet query execution plan explanation
TableApiget_table_statsPOST /v1/table/{id}/statsGet table statistics
TableApiget_table_tag_versionPOST /v1/table/{id}/tags/versionGet version for a specific tag
TableApiinsert_into_tablePOST /v1/table/{id}/insertInsert records into a table
TableApilist_table_indicesPOST /v1/table/{id}/index/listList indexes on a table
TableApilist_table_tagsGET /v1/table/{id}/tags/listList all tags for a table
TableApilist_table_versionsPOST /v1/table/{id}/version/listList all versions of a table
TableApilist_tablesGET /v1/namespace/{id}/table/listList tables in a namespace
TableApimerge_insert_into_tablePOST /v1/table/{id}/merge_insertMerge insert (upsert) records into a table
TableApiquery_tablePOST /v1/table/{id}/queryQuery a table
TableApiregister_tablePOST /v1/table/{id}/registerRegister a table to a namespace
TableApirestore_tablePOST /v1/table/{id}/restoreRestore table to a specific version
TableApitable_existsPOST /v1/table/{id}/existsCheck if a table exists
TableApiupdate_tablePOST /v1/table/{id}/updateUpdate rows in a table
TableApiupdate_table_tagPOST /v1/table/{id}/tags/updateUpdate a tag to point to a different version
TagApicreate_table_tagPOST /v1/table/{id}/tags/createCreate a new tag
TagApidelete_table_tagPOST /v1/table/{id}/tags/deleteDelete a tag
TagApiget_table_tag_versionPOST /v1/table/{id}/tags/versionGet version for a specific tag
TagApilist_table_tagsGET /v1/table/{id}/tags/listList all tags for a table
TagApiupdate_table_tagPOST /v1/table/{id}/tags/updateUpdate a tag to point to a different version
TransactionApialter_transactionPOST /v1/transaction/{id}/alterAlter information of a transaction.
TransactionApidescribe_transactionPOST /v1/transaction/{id}/describeDescribe information about a transaction

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author