Namespace

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.

post/v1/namespace/{id}/create

Path parameters

idstring required

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.

Query parameters

delimiterstring nullable

An opaque token that allows pagination for list APIs (e.g. ListNamespaces). For an initial client request for a list API, if the server cannot return all items in one response, or if there are more items than the pageSize specified in the client request, the server must return a nextPageToken in the response indicating there are more results available. After the initial request, the value of nextPageToken from each response must be used by the client as the pageToken parameter value for the next request. Clients must interpret either null, missing value or empty string value of nextPageToken from a server response as the end of the listing results.

An optional delimiter of the string identifier, following the Lance Namespace spec. When not specified, the . delimiter must be used.

Request body

namestring required

parentstring[]

mode'CREATE' | 'EXIST_OK' | 'OVERWRITE' required

{"stackTrail":"components:schemas:CreateNamespaceRequest:properties:options","oasType":"schema","type":"unknown"}

Example request

{
  "mode": "CREATE",
  "parent": [
    "parent",
    "parent"
  ],
  "name": "name",
  "options": {
    "key": "options"
  }
}

Response

Result of creating a namespace