4.3 KiB
Interface: Table<T>
A LanceDB Table is the collection of Records. Each Record has one or more vector fields.
Type parameters
| Name | Type |
|---|---|
T |
number[] |
Implemented by
Table of contents
Properties
Properties
add
• add: (data: Record<string, unknown>[]) => Promise<number>
Type declaration
▸ (data): Promise<number>
Insert records into this Table.
Parameters
| Name | Type | Description |
|---|---|---|
data |
Record<string, unknown>[] |
Records to be inserted into the Table |
Returns
Promise<number>
The number of rows added to the table
Defined in
countRows
• countRows: () => Promise<number>
Type declaration
▸ (): Promise<number>
Returns the number of rows in this table.
Returns
Promise<number>
Defined in
createIndex
• createIndex: (indexParams: IvfPQIndexConfig) => Promise<any>
Type declaration
▸ (indexParams): Promise<any>
Create an ANN index on this Table vector index.
See
VectorIndexParams.
Parameters
| Name | Type | Description |
|---|---|---|
indexParams |
IvfPQIndexConfig |
The parameters of this Index, |
Returns
Promise<any>
Defined in
delete
• delete: (filter: string) => Promise<void>
Type declaration
▸ (filter): Promise<void>
Delete rows from this table.
This can be used to delete a single row, many rows, all rows, or sometimes no rows (if your predicate matches nothing).
Examples
const con = await lancedb.connect("./.lancedb")
const data = [
{id: 1, vector: [1, 2]},
{id: 2, vector: [3, 4]},
{id: 3, vector: [5, 6]},
];
const tbl = await con.createTable("my_table", data)
await tbl.delete("id = 2")
await tbl.countRows() // Returns 2
If you have a list of values to delete, you can combine them into a
stringified list and use the IN operator:
const to_remove = [1, 5];
await tbl.delete(`id IN (${to_remove.join(",")})`)
await tbl.countRows() // Returns 1
Parameters
| Name | Type | Description |
|---|---|---|
filter |
string |
A filter in the same format used by a sql WHERE clause. The filter must not be empty. |
Returns
Promise<void>
Defined in
name
• name: string
Defined in
overwrite
• overwrite: (data: Record<string, unknown>[]) => Promise<number>
Type declaration
▸ (data): Promise<number>
Insert records into this Table, replacing its contents.
Parameters
| Name | Type | Description |
|---|---|---|
data |
Record<string, unknown>[] |
Records to be inserted into the Table |
Returns
Promise<number>
The number of rows added to the table
Defined in
search
• search: (query: T) => Query<T>
Type declaration
▸ (query): Query<T>
Creates a search query to find the nearest neighbors of the given search term
Parameters
| Name | Type | Description |
|---|---|---|
query |
T |
The query search term |
Returns
Query<T>