Sign in
Namespace
Metadata

Drop a namespace

Drop namespace id from its parent namespace.

post/v1/namespace/{id}/drop

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'SKIP' | 'FAIL'

The mode for dropping a namespace, deciding the server behavior when the namespace to drop is not found.

  • FAIL (default): the server must return 400 indicating the namespace to drop does not exist.
  • SKIP: the server must return 204 indicating the drop operation has succeeded.
behavior'RESTRICT' | 'CASCADE'

The behavior for dropping a namespace.

  • RESTRICT (default): the namespace should not contain any table or child namespace when drop is initiated. If tables are found, the server should return error and not drop the namespace.
  • CASCADE: all tables and child namespaces in the namespace are dropped before the namespace is dropped.

Example request

{
  "mode": "SKIP",
  "id": [
    "id",
    "id"
  ],
  "behavior": "RESTRICT"
}

Response

Result of dropping a namespace

{"stackTrail":"components:schemas:DropNamespaceResponse:properties:properties","oasType":"schema","type":"unknown"}
transactionIdstring[]

If present, indicating the operation is long running and should be tracked using GetTransaction

Example response

{
  "properties": {
    "key": "properties"
  },
  "transactionId": [
    "transactionId",
    "transactionId"
  ]
}

Changes