Get query execution plan explanation

Get the query execution plan for a query against table id. Returns a human-readable explanation of how the query will be executed.

REST NAMESPACE ONLY REST namespace returns the response as a plain string instead of the ExplainTableQueryPlanResponse JSON object.

POST /v1/table/{id}/explain_plan

Get query execution plan explanation

cURL

curl --request POST \
  --url {scheme}://{host}:{port}/{basePath}/v1/table/{id}/explain_plan \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": {
    "k": 1,
    "vector": {
      "single_vector": [
        123
      ],
      "multi_vector": [
        [
          123
        ]
      ]
    },
    "identity": {
      "api_key": "<string>",
      "auth_token": "<string>"
    },
    "context": {},
    "id": [
      "<string>"
    ],
    "bypass_vector_index": true,
    "columns": {
      "column_names": [
        "<string>"
      ],
      "column_aliases": {}
    },
    "distance_type": "<string>",
    "ef": 1,
    "fast_search": true,
    "filter": "<string>",
    "full_text_query": {
      "string_query": {
        "query": "<string>",
        "columns": [
          "<string>"
        ]
      },
      "structured_query": {
        "query": {
          "match": {
            "terms": "<string>",
            "boost": 123,
            "column": "<string>",
            "fuzziness": 1,
            "max_expansions": 1,
            "operator": "<string>",
            "prefix_length": 1
          },
          "phrase": {
            "terms": "<string>",
            "column": "<string>",
            "slop": 1
          },
          "boost": {
            "positive": "<unknown>",
            "negative": "<unknown>",
            "negative_boost": 0.5
          },
          "multi_match": {
            "match_queries": [
              {
                "terms": "<string>",
                "boost": 123,
                "column": "<string>",
                "fuzziness": 1,
                "max_expansions": 1,
                "operator": "<string>",
                "prefix_length": 1
              }
            ]
          },
          "boolean": {
            "must": "<array>",
            "must_not": "<array>",
            "should": "<array>"
          }
        }
      }
    },
    "lower_bound": 123,
    "nprobes": 1,
    "offset": 1,
    "prefilter": true,
    "refine_factor": 1,
    "upper_bound": 123,
    "vector_column": "<string>",
    "version": 1,
    "with_row_id": true
  },
  "identity": {
    "api_key": "<string>",
    "auth_token": "<string>"
  },
  "context": {},
  "id": [
    "<string>"
  ],
  "verbose": false
}
'

200

"<string>"

Authorizations

OAuth2BearerAuthApiKeyAuth

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

id · string · 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

delimiter · string

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

Body

application/json

query · object · required

Show child attributes

identity · object

Identity information of a request.

Show child attributes

context · object

Arbitrary context for a request as key-value pairs. How to use the context is custom to the specific implementation.

REST NAMESPACE ONLY Context entries are passed via HTTP headers using the naming convention x-lance-ctx-<key>: <value>. For example, a context entry {"trace_id": "abc123"} would be sent as the header x-lance-ctx-trace_id: abc123.

Show child attributes

id · string[]

verbose · boolean · default: false

Whether to return verbose explanation

Response

200

application/json

Query execution plan explanation

Human-readable query execution plan