lancedb/docs/src/javascript/classes/Query.md

vectordb / Exports / Query

Class: Query<T>

A builder for nearest neighbor queries for LanceDB.

Type parameters

Name	Type
T	number[]

Table of contents

Constructors

• constructor

Properties

• _embeddings
• _filter
• _limit
• _metricType
• _nprobes
• _query
• _queryVector
• _refineFactor
• _select
• _tbl
• where

Methods

• execute
• filter
• limit
• metricType
• nprobes
• refineFactor
• select

Constructors

constructor

• new Query<T>(tbl, query, embeddings?)

Type parameters

Name	Type
T	number[]

Parameters

Name	Type
tbl	any
query	T
embeddings?	EmbeddingFunction<T>

Defined in

index.ts:448

Properties

_embeddings

• Private Optional Readonly _embeddings: EmbeddingFunction<T>

Defined in

index.ts:446

---

_filter

• Private Optional _filter: string

Defined in

index.ts:444

---

_limit

• Private _limit: number

Defined in

index.ts:440

---

_metricType

• Private Optional _metricType: MetricType

Defined in

index.ts:445

---

_nprobes

• Private _nprobes: number

Defined in

index.ts:442

---

_query

• Private Readonly _query: T

Defined in

index.ts:438

---

_queryVector

• Private Optional _queryVector: number[]

Defined in

index.ts:439

---

_refineFactor

• Private Optional _refineFactor: number

Defined in

index.ts:441

---

_select

• Private Optional _select: string[]

Defined in

index.ts:443

---

_tbl

• Private Readonly _tbl: any

Defined in

index.ts:437

---

where

• where: (value: string) => Query<T>

Type declaration

▸ (value): Query<T>

A filter statement to be applied to this query.

Parameters

Name	Type	Description
value	string	A filter in the same format used by a sql WHERE clause.

Returns

Query<T>

Defined in

index.ts:496

Methods

execute

▸ execute<T>(): Promise<T[]>

Execute the query and return the results as an Array of Objects

Type parameters

Name	Type
T	Record<string, unknown>

Returns

Promise<T[]>

Defined in

index.ts:519

---

filter

▸ filter(value): Query<T>

A filter statement to be applied to this query.

Parameters

Name	Type	Description
value	string	A filter in the same format used by a sql WHERE clause.

Returns

Query<T>

Defined in

index.ts:491

---

limit

▸ limit(value): Query<T>

Sets the number of results that will be returned

Parameters

Name	Type	Description
value	number	number of results

Returns

Query<T>

Defined in

index.ts:464

---

metricType

▸ metricType(value): Query<T>

The MetricType used for this Query.

See

MetricType for the different options

Parameters

Name	Type	Description
value	MetricType	The metric to the.

Returns

Query<T>

Defined in

index.ts:511

---

nprobes

▸ nprobes(value): Query<T>

The number of probes used. A higher number makes search more accurate but also slower.

Parameters

Name	Type	Description
value	number	The number of probes used.

Returns

Query<T>

Defined in

index.ts:482

---

refineFactor

▸ refineFactor(value): Query<T>

Refine the results by reading extra elements and re-ranking them in memory.

Parameters

Name	Type	Description
value	number	refine factor to use in this query.

Returns

Query<T>

Defined in

index.ts:473

---

select

▸ select(value): Query<T>

Return only the specified columns.

Parameters

Name	Type	Description
value	string[]	Only select the specified columns. If not specified, all columns will be returned.

Returns

Query<T>

Defined in

index.ts:502