LAlance-format
Namespace
Metadata

Drop a namespace

Changed on

Drop namespace id from its parent namespace.

post/v1/namespace/{id}/drop

Request

  • Base URL
    http://localhost:2333
  • Auth
    • OAuth 2
      Client credentials
      Token URL: /oauth/token
    • or HTTP bearer
    • or API key in header x-api-key

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

contextunknown
idstring[]
modestring

The mode for dropping a namespace, deciding the server behavior when the namespace to drop is not found. Case insensitive, supports both PascalCase and snake_case. Valid values are:

  • 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.
behaviorstring

The behavior for dropping a namespace. Case insensitive, supports both PascalCase and snake_case. Valid values are:

  • 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": "mode",
  "identity": {
    "api_key": "api_key",
    "auth_token": "auth_token"
  },
  "context": {
    "key": "context"
  },
  "id": [
    "id",
    "id"
  ],
  "behavior": "behavior"
}

Response

Result of dropping a namespace

contextunknown
propertiesunknown
transaction_idstring[]

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

Example response

{
  "transaction_id": [
    "transaction_id",
    "transaction_id"
  ],
  "context": {
    "key": "context"
  },
  "properties": {
    "key": "properties"
  }
}

Changes

  • 591cd95574b0Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 83f8516f0507Revision changes
    • info

      added the new optional request property