Get query execution plan explanation

Authorizations

Authorization

string

header

required

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

Path Parameters

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

query.k

integer

required

Number of results to return

Required range: x >= 0

query.vector

object

required

Query vector(s) for similarity search. Provide either single_vector or multi_vector, not both.

Show child attributes

query.vector.single_vector

number<float>[]

Single query vector

query.vector.multi_vector

number<float>[][]

Multiple query vectors for batch search

query.id

string[]

query.bypass_vector_index

boolean

Whether to bypass vector index

query.columns

object

Optional columns to return. Provide either column_names or column_aliases, not both.

Show child attributes

query.columns.column_names

string[]

List of column names to return

query.columns.column_aliases

object

Object mapping output aliases to source column names

Show child attributes

query.columns.column_aliases.{key}

string

query.distance_type

string

Distance metric to use

query.ef

integer

Search effort parameter for HNSW index

Required range: x >= 0

query.fast_search

boolean

Whether to use fast search

query.filter

string

Optional SQL filter expression

query.full_text_query

object

Optional full-text search query. Provide either string_query or structured_query, not both.

Show child attributes

query.full_text_query.string_query

object

Show child attributes

query.full_text_query.string_query.query

string

required

query.full_text_query.string_query.columns

string[]

query.full_text_query.structured_query

object

Show child attributes

query.full_text_query.structured_query.query

object

required

Full-text search query. Exactly one query type field must be provided. This structure follows the same pattern as AlterTransactionAction to minimize differences and compatibility issues across codegen in different languages.

Show child attributes

query.full_text_query.structured_query.query.match

object

Show child attributes

query.full_text_query.structured_query.query.match.terms

string

required

query.full_text_query.structured_query.query.match.boost

number<float>

query.full_text_query.structured_query.query.match.column

string

query.full_text_query.structured_query.query.match.fuzziness

integer<int32>

Required range: x >= 0

query.full_text_query.structured_query.query.match.max_expansions

integer

The maximum number of terms to expand for fuzzy matching. Default to 50.

Required range: x >= 0

query.full_text_query.structured_query.query.match.operator

string

The operator to use for combining terms. This can be either And or Or, it's 'Or' by default.

And: All terms must match.
Or: At least one term must match.

query.full_text_query.structured_query.query.match.prefix_length

integer<int32>

The number of beginning characters being unchanged for fuzzy matching. Default to 0.

Required range: x >= 0

query.full_text_query.structured_query.query.phrase

object

Show child attributes

query.full_text_query.structured_query.query.phrase.terms

string

required

query.full_text_query.structured_query.query.phrase.column

string

query.full_text_query.structured_query.query.phrase.slop

integer<int32>

Required range: x >= 0

query.full_text_query.structured_query.query.boost

object

Boost query that scores documents matching positive query higher and negative query lower

Show child attributes

query.full_text_query.structured_query.query.boost.positive

any

required

query.full_text_query.structured_query.query.boost.negative

any

required

query.full_text_query.structured_query.query.boost.negative_boost

number<float>

default:0.5

Boost factor for negative query (default: 0.5)

query.full_text_query.structured_query.query.multi_match

object

Show child attributes

query.full_text_query.structured_query.query.multi_match.match_queries

object[]

required

Show child attributes

query.full_text_query.structured_query.query.multi_match.match_queries.terms

string

required

query.full_text_query.structured_query.query.multi_match.match_queries.boost

number<float>

query.full_text_query.structured_query.query.multi_match.match_queries.column

string

query.full_text_query.structured_query.query.multi_match.match_queries.fuzziness

integer<int32>

Required range: x >= 0

query.full_text_query.structured_query.query.multi_match.match_queries.max_expansions

integer

The maximum number of terms to expand for fuzzy matching. Default to 50.

Required range: x >= 0

query.full_text_query.structured_query.query.multi_match.match_queries.operator

string

The operator to use for combining terms. This can be either And or Or, it's 'Or' by default.

And: All terms must match.
Or: At least one term must match.

query.full_text_query.structured_query.query.multi_match.match_queries.prefix_length

integer<int32>

The number of beginning characters being unchanged for fuzzy matching. Default to 0.

Required range: x >= 0

query.full_text_query.structured_query.query.boolean

object

Boolean query with must, should, and must_not clauses

Show child attributes

query.full_text_query.structured_query.query.boolean.must

array

required

Queries that must match (AND)

query.full_text_query.structured_query.query.boolean.must_not

array

required

Queries that must not match (NOT)

query.full_text_query.structured_query.query.boolean.should

array

required

Queries that should match (OR)

query.lower_bound

number<float>

Lower bound for search

query.nprobes

integer

Number of probes for IVF index

Required range: x >= 0

query.offset

integer

Number of results to skip

Required range: x >= 0

query.prefilter

boolean

Whether to apply filtering before vector search

query.refine_factor

integer<int32>

Refine factor for search

Required range: x >= 0

query.upper_bound

number<float>

Upper bound for search

query.vector_column

string

Name of the vector column to search

query.version

integer<int64>

Table version to query

Required range: x >= 0

query.with_row_id

boolean

If true, return the row id as a column called _rowid

string[]

verbose

boolean

default:false

Whether to return verbose explanation

Response

Query execution plan explanation

Human-readable query execution plan

API Reference

Authorizations

Path Parameters

Query Parameters

Body

Response