9600a38ff0
Solves #244 :  Problem was function overloading in the interface caused some weird `typedoc` formatting, so breaking it apart into methods fixed the issue. Also regenerated and updated javascript docs --------- Co-authored-by: Tevin Wang <tevin@cmu.edu>
3.6 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.
Parameters
| Name | Type | Description |
|---|---|---|
filter |
string |
A filter in the same format used by a sql WHERE clause. |
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>