Sign in
Namespace
Metadata

Create a new namespace

Create new namespace id.

During the creation process, the implementation may modify user-provided properties, such as adding additional properties like created_at to user-provided properties, omitting any specific property, or performing actions based on any property value.

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 operations (e.g. ListNamespaces).

For an initial request of a list operation, if the implementation cannot return all items in one response, or if there are more items than the page limit specified in the request, the implementation must return a page token in the response, indicating there are more results available.

After the initial request, the value of the page token from each response must be used as the page token value for the next request.

Caller must interpret either null, missing value or empty string value of the page token from the implementation's 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

idstring[]
mode'CREATE' | 'EXIST_OK' | 'OVERWRITE'

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.
{"stackTrail":"components:schemas:CreateNamespaceRequest:properties:properties","oasType":"schema","type":"unknown"}

Example request

{
  "mode": "CREATE",
  "id": [
    "id",
    "id"
  ],
  "properties": {
    "key": "properties"
  }
}

Response

Result of creating a namespace

{"stackTrail":"components:schemas:CreateNamespaceResponse:properties:properties","oasType":"schema","type":"unknown","description":"Properties after the namespace is created.\n\nIf the server does not support namespace properties, it should return null for this field.\nIf namespace properties are supported, but none are set, it should return an empty object.\n"}

Example response

{
  "properties": {
    "key": "properties"
  }
}

Changes