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

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

Request body

idstring[]

modestring

There are three modes when trying to create a namespace, to differentiate the behavior when a namespace of the same name already exists. Case insensitive, supports both PascalCase and snake_case. Valid values are:

Create: the operation fails with 409.
ExistOk: 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": "mode",
  "id": [
    "id",
    "id"
  ],
  "properties": {
    "key": "properties"
  }
}

Response

Result of creating a namespace

transaction_idstring

Optional transaction identifier

{"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

{
  "transaction_id": "transaction_id",
  "properties": {
    "key": "properties"
  }
}