Lance Namespace urllib3 Client

Warnings

• gotcha The default client host is `http://localhost:8080`. Users *must* configure the `host` parameter in `lance_namespace_urllib3_client.Configuration` to point to their actual Lance Namespace server endpoint, otherwise, all API calls will fail.
  Fix: Set `configuration.host = 'https://your-lance-namespace-server.com'` or use an environment variable (e.g., `LANCE_NAMESPACE_HOST`) to override the default during initialization.
• gotcha This client interacts with a Lance Namespace server. It does not provide the server itself. You need a running instance of a Lance Namespace server to use this client effectively.
  Fix: Ensure a Lance Namespace server is deployed and accessible at the configured host before making API calls.
• gotcha Authentication mechanisms (e.g., API keys, OAuth) are server-dependent. While the client supports common patterns like `api_key['X-Api-Key']`, it might not be enabled or required by default on your server setup. Consult your server's documentation for required authentication.
  Fix: If your Lance Namespace server requires authentication, uncomment and configure `configuration.api_key` or other auth methods as per your server's security policy.
• deprecated The Lance Namespace specification and its clients are under active development. While explicit breaking changes are usually noted, the API can evolve. Features like `managed_versioning` (introduced in v0.5.0) reflect ongoing enhancements.
  Fix: Always review release notes for new versions to understand API changes and new capabilities, especially around features like table versioning and batch operations (e.g., `BatchCommitTables` in v0.6.0).

Install

• pip install lance-namespace-urllib3-client Install with pip

Imports

• Configuration

  from lance_namespace_urllib3_client import Configuration

• ApiClient

  from lance_namespace_urllib3_client import ApiClient

• ApiException

  from lance_namespace_urllib3_client import ApiException

• TableApi

  from lance_namespace_urllib3_client.api.table_api import TableApi

  API classes are nested within `api.<api_name>_api` modules.
• TableCreation

  from lance_namespace_urllib3_client.model.table_creation import TableCreation

• Location

  from lance_namespace_urllib3_client.model.location import Location

• Name

  from lance_namespace_urllib3_client.model.name import Name

Quickstart

This quickstart demonstrates how to initialize the client, configure its host, and declare a new table with `declare_table`. It also includes an example of retrieving the declared table using `get_table`. Remember to set the `LANCE_NAMESPACE_HOST` environment variable or modify the configuration directly to point to your Lance Namespace server.

import os
from pprint import pprint

from lance_namespace_urllib3_client import Configuration, ApiClient, ApiException
from lance_namespace_urllib3_client.api.table_api import TableApi
from lance_namespace_urllib3_client.model.table_creation import TableCreation
from lance_namespace_urllib3_client.model.location import Location
from lance_namespace_urllib3_client.model.name import Name

# Configure API client. Replace with your Lance Namespace server host.
# You can also pass API keys for authentication if required by your server.
configuration = Configuration(
    host = os.environ.get('LANCE_NAMESPACE_HOST', 'http://localhost:8080')
)
# if os.environ.get('LANCE_API_KEY'):
#     configuration.api_key['X-Api-Key'] = os.environ.get('LANCE_API_KEY')

# Enter a context with an instance of the API client
with ApiClient(configuration) as api_client:
    # Create an instance of the TableApi class
    api_instance = TableApi(api_client)

    # Define table details
    table_name = Name('my_first_table')
    table_creation_body = TableCreation(
        location = Location(
            uri="s3://my-test-bucket/data/my_first_table", # Required: URI where table data is stored
        ),
        managed_versioning=True, # Enable or disable managed versioning for the table
        properties={
            "owner": "data_team",
            "environment": "dev"
        }
    )

    try:
        # Call the declare_table API to register a new table
        api_response = api_instance.declare_table(table_name, table_creation_body)
        print("Successfully declared table:")
        pprint(api_response)
    except ApiException as e:
        print(f"Exception when calling TableApi->declare_table: {e}")

# Example of retrieving a table
with ApiClient(configuration) as api_client:
    api_instance = TableApi(api_client)
    try:
        get_table_response = api_instance.get_table(table_name)
        print("\nSuccessfully retrieved table:")
        pprint(get_table_response)
    except ApiException as e:
        print(f"Exception when calling TableApi->get_table: {e}")