All URIs are relative to http://localhost:2333
| Method | HTTP request | Description |
|---|---|---|
| create_namespace | POST /v1/namespace/{id}/create | Create a new namespace |
| describe_namespace | POST /v1/namespace/{id}/describe | Describe information about a namespace |
| drop_namespace | POST /v1/namespace/{id}/drop | Drop a namespace |
| list_namespaces | POST /v1/namespace/{id}/list | List namespaces |
| namespace_exists | POST /v1/namespace/{id}/exists | Check if a namespace exists |
CreateNamespaceResponse create_namespace(id, create_namespace_request, delimiter=delimiter)
Create a new namespace
Create a new namespace. A namespace can manage either a collection of child namespaces, or a collection of tables. There are three modes when trying to create a namespace, to differentiate the behavior when a namespace of the same name already exists:
- CREATE: the operation fails with 400.
- EXIST_OK: 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.
import lance_namespace_urllib3_client
from lance_namespace_urllib3_client.models.create_namespace_request import CreateNamespaceRequest
from lance_namespace_urllib3_client.models.create_namespace_response import CreateNamespaceResponse
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.NamespaceApi(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.
create_namespace_request = lance_namespace_urllib3_client.CreateNamespaceRequest() # CreateNamespaceRequest |
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:
# Create a new namespace
api_response = api_instance.create_namespace(id, create_namespace_request, delimiter=delimiter)
print("The response of NamespaceApi->create_namespace:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NamespaceApi->create_namespace: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | 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. | |
| create_namespace_request | CreateNamespaceRequest | ||
| delimiter | str | An optional delimiter of the `string identifier`, following the Lance Namespace spec. When not specified, the `.` delimiter must be used. | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Result of creating a namespace | - |
| 400 | Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure, such as invalid json. Usually serves application/json content, although in some cases simple text/plain content might be returned by the server's middleware. | - |
| 401 | Unauthorized. The request lacks valid authentication credentials for the operation. | - |
| 403 | Forbidden. Authenticated user does not have the necessary permissions. | - |
| 404 | A server-side problem that means can not find the specified resource. | - |
| 406 | Not Acceptable / Unsupported Operation. The server does not support this operation. | - |
| 409 | The request conflicts with the current state of the target resource. | - |
| 503 | The service is not ready to handle the request. The client should wait and retry. The service may additionally send a Retry-After header to indicate when to retry. | - |
| 5XX | A server-side problem that might not be addressable from the client side. Used for server 5xx errors without more specific documentation in individual routes. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DescribeNamespaceResponse describe_namespace(id, describe_namespace_request, delimiter=delimiter)
Describe information about a namespace
Return the detailed information for a given namespace
import lance_namespace_urllib3_client
from lance_namespace_urllib3_client.models.describe_namespace_request import DescribeNamespaceRequest
from lance_namespace_urllib3_client.models.describe_namespace_response import DescribeNamespaceResponse
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.NamespaceApi(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.
describe_namespace_request = lance_namespace_urllib3_client.DescribeNamespaceRequest() # DescribeNamespaceRequest |
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:
# Describe information about a namespace
api_response = api_instance.describe_namespace(id, describe_namespace_request, delimiter=delimiter)
print("The response of NamespaceApi->describe_namespace:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NamespaceApi->describe_namespace: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | 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. | |
| describe_namespace_request | DescribeNamespaceRequest | ||
| delimiter | str | An optional delimiter of the `string identifier`, following the Lance Namespace spec. When not specified, the `.` delimiter must be used. | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Returns a namespace, as well as any properties stored on the namespace if namespace properties are supported by the server. | - |
| 400 | Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure, such as invalid json. Usually serves application/json content, although in some cases simple text/plain content might be returned by the server's middleware. | - |
| 401 | Unauthorized. The request lacks valid authentication credentials for the operation. | - |
| 403 | Forbidden. Authenticated user does not have the necessary permissions. | - |
| 404 | A server-side problem that means can not find the specified resource. | - |
| 503 | The service is not ready to handle the request. The client should wait and retry. The service may additionally send a Retry-After header to indicate when to retry. | - |
| 5XX | A server-side problem that might not be addressable from the client side. Used for server 5xx errors without more specific documentation in individual routes. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DropNamespaceResponse drop_namespace(id, drop_namespace_request, delimiter=delimiter)
Drop a namespace
Drop a namespace. The namespace must be empty.
import lance_namespace_urllib3_client
from lance_namespace_urllib3_client.models.drop_namespace_request import DropNamespaceRequest
from lance_namespace_urllib3_client.models.drop_namespace_response import DropNamespaceResponse
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.NamespaceApi(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.
drop_namespace_request = lance_namespace_urllib3_client.DropNamespaceRequest() # DropNamespaceRequest |
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:
# Drop a namespace
api_response = api_instance.drop_namespace(id, drop_namespace_request, delimiter=delimiter)
print("The response of NamespaceApi->drop_namespace:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NamespaceApi->drop_namespace: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | 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. | |
| drop_namespace_request | DropNamespaceRequest | ||
| delimiter | str | An optional delimiter of the `string identifier`, following the Lance Namespace spec. When not specified, the `.` delimiter must be used. | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Result of dropping a namespace | - |
| 400 | Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure, such as invalid json. Usually serves application/json content, although in some cases simple text/plain content might be returned by the server's middleware. | - |
| 401 | Unauthorized. The request lacks valid authentication credentials for the operation. | - |
| 403 | Forbidden. Authenticated user does not have the necessary permissions. | - |
| 404 | A server-side problem that means can not find the specified resource. | - |
| 409 | The request conflicts with the current state of the target resource. | - |
| 503 | The service is not ready to handle the request. The client should wait and retry. The service may additionally send a Retry-After header to indicate when to retry. | - |
| 5XX | A server-side problem that might not be addressable from the client side. Used for server 5xx errors without more specific documentation in individual routes. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ListNamespacesResponse list_namespaces(id, list_namespaces_request, delimiter=delimiter)
List namespaces
List all child namespace names of the root namespace or a given parent namespace.
import lance_namespace_urllib3_client
from lance_namespace_urllib3_client.models.list_namespaces_request import ListNamespacesRequest
from lance_namespace_urllib3_client.models.list_namespaces_response import ListNamespacesResponse
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.NamespaceApi(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.
list_namespaces_request = lance_namespace_urllib3_client.ListNamespacesRequest() # ListNamespacesRequest |
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:
# List namespaces
api_response = api_instance.list_namespaces(id, list_namespaces_request, delimiter=delimiter)
print("The response of NamespaceApi->list_namespaces:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NamespaceApi->list_namespaces: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | 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. | |
| list_namespaces_request | ListNamespacesRequest | ||
| delimiter | str | An optional delimiter of the `string identifier`, following the Lance Namespace spec. When not specified, the `.` delimiter must be used. | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | A list of namespaces | - |
| 400 | Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure, such as invalid json. Usually serves application/json content, although in some cases simple text/plain content might be returned by the server's middleware. | - |
| 401 | Unauthorized. The request lacks valid authentication credentials for the operation. | - |
| 403 | Forbidden. Authenticated user does not have the necessary permissions. | - |
| 404 | A server-side problem that means can not find the specified resource. | - |
| 406 | Not Acceptable / Unsupported Operation. The server does not support this operation. | - |
| 503 | The service is not ready to handle the request. The client should wait and retry. The service may additionally send a Retry-After header to indicate when to retry. | - |
| 5XX | A server-side problem that might not be addressable from the client side. Used for server 5xx errors without more specific documentation in individual routes. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]
NamespaceExistsResponse namespace_exists(id, namespace_exists_request, delimiter=delimiter)
Check if a namespace exists
Check if a namespace exists.
import lance_namespace_urllib3_client
from lance_namespace_urllib3_client.models.namespace_exists_request import NamespaceExistsRequest
from lance_namespace_urllib3_client.models.namespace_exists_response import NamespaceExistsResponse
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.NamespaceApi(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.
namespace_exists_request = lance_namespace_urllib3_client.NamespaceExistsRequest() # NamespaceExistsRequest |
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:
# Check if a namespace exists
api_response = api_instance.namespace_exists(id, namespace_exists_request, delimiter=delimiter)
print("The response of NamespaceApi->namespace_exists:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling NamespaceApi->namespace_exists: %s\n" % e)| Name | Type | Description | Notes |
|---|---|---|---|
| id | 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. | |
| namespace_exists_request | NamespaceExistsRequest | ||
| delimiter | str | An optional delimiter of the `string identifier`, following the Lance Namespace spec. When not specified, the `.` delimiter must be used. | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
| Status code | Description | Response headers |
|---|---|---|
| 200 | Result of checking if a namespace exists | - |
| 400 | Indicates a bad request error. It could be caused by an unexpected request body format or other forms of request validation failure, such as invalid json. Usually serves application/json content, although in some cases simple text/plain content might be returned by the server's middleware. | - |
| 401 | Unauthorized. The request lacks valid authentication credentials for the operation. | - |
| 403 | Forbidden. Authenticated user does not have the necessary permissions. | - |
| 404 | A server-side problem that means can not find the specified resource. | - |
| 503 | The service is not ready to handle the request. The client should wait and retry. The service may additionally send a Retry-After header to indicate when to retry. | - |
| 5XX | A server-side problem that might not be addressable from the client side. Used for server 5xx errors without more specific documentation in individual routes. | - |
[Back to top] [Back to API list] [Back to Model list] [Back to README]