mirror of
https://github.com/lancedb/lancedb.git
synced 2025-12-25 22:29:58 +00:00
303 lines
5.9 KiB
Markdown
303 lines
5.9 KiB
Markdown
[vectordb](../README.md) / [Exports](../modules.md) / LocalTable
|
|
|
|
# Class: LocalTable<T\>
|
|
|
|
A LanceDB Table is the collection of Records. Each Record has one or more vector fields.
|
|
|
|
## Type parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `T` | `number`[] |
|
|
|
|
## Implements
|
|
|
|
- [`Table`](../interfaces/Table.md)<`T`\>
|
|
|
|
## Table of contents
|
|
|
|
### Constructors
|
|
|
|
- [constructor](LocalTable.md#constructor)
|
|
|
|
### Properties
|
|
|
|
- [\_embeddings](LocalTable.md#_embeddings)
|
|
- [\_name](LocalTable.md#_name)
|
|
- [\_options](LocalTable.md#_options)
|
|
- [\_tbl](LocalTable.md#_tbl)
|
|
|
|
### Accessors
|
|
|
|
- [name](LocalTable.md#name)
|
|
|
|
### Methods
|
|
|
|
- [add](LocalTable.md#add)
|
|
- [countRows](LocalTable.md#countrows)
|
|
- [createIndex](LocalTable.md#createindex)
|
|
- [delete](LocalTable.md#delete)
|
|
- [overwrite](LocalTable.md#overwrite)
|
|
- [search](LocalTable.md#search)
|
|
|
|
## Constructors
|
|
|
|
### constructor
|
|
|
|
• **new LocalTable**<`T`\>(`tbl`, `name`, `options`)
|
|
|
|
#### Type parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `T` | `number`[] |
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `tbl` | `any` |
|
|
| `name` | `string` |
|
|
| `options` | [`ConnectionOptions`](../interfaces/ConnectionOptions.md) |
|
|
|
|
#### Defined in
|
|
|
|
[index.ts:287](https://github.com/lancedb/lancedb/blob/b1eeb90/node/src/index.ts#L287)
|
|
|
|
• **new LocalTable**<`T`\>(`tbl`, `name`, `options`, `embeddings`)
|
|
|
|
#### Type parameters
|
|
|
|
| Name | Type |
|
|
| :------ | :------ |
|
|
| `T` | `number`[] |
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type | Description |
|
|
| :------ | :------ | :------ |
|
|
| `tbl` | `any` | |
|
|
| `name` | `string` | |
|
|
| `options` | [`ConnectionOptions`](../interfaces/ConnectionOptions.md) | |
|
|
| `embeddings` | [`EmbeddingFunction`](../interfaces/EmbeddingFunction.md)<`T`\> | An embedding function to use when interacting with this table |
|
|
|
|
#### Defined in
|
|
|
|
[index.ts:294](https://github.com/lancedb/lancedb/blob/b1eeb90/node/src/index.ts#L294)
|
|
|
|
## Properties
|
|
|
|
### \_embeddings
|
|
|
|
• `Private` `Optional` `Readonly` **\_embeddings**: [`EmbeddingFunction`](../interfaces/EmbeddingFunction.md)<`T`\>
|
|
|
|
#### Defined in
|
|
|
|
[index.ts:284](https://github.com/lancedb/lancedb/blob/b1eeb90/node/src/index.ts#L284)
|
|
|
|
___
|
|
|
|
### \_name
|
|
|
|
• `Private` `Readonly` **\_name**: `string`
|
|
|
|
#### Defined in
|
|
|
|
[index.ts:283](https://github.com/lancedb/lancedb/blob/b1eeb90/node/src/index.ts#L283)
|
|
|
|
___
|
|
|
|
### \_options
|
|
|
|
• `Private` `Readonly` **\_options**: [`ConnectionOptions`](../interfaces/ConnectionOptions.md)
|
|
|
|
#### Defined in
|
|
|
|
[index.ts:285](https://github.com/lancedb/lancedb/blob/b1eeb90/node/src/index.ts#L285)
|
|
|
|
___
|
|
|
|
### \_tbl
|
|
|
|
• `Private` `Readonly` **\_tbl**: `any`
|
|
|
|
#### Defined in
|
|
|
|
[index.ts:282](https://github.com/lancedb/lancedb/blob/b1eeb90/node/src/index.ts#L282)
|
|
|
|
## Accessors
|
|
|
|
### name
|
|
|
|
• `get` **name**(): `string`
|
|
|
|
#### Returns
|
|
|
|
`string`
|
|
|
|
#### Implementation of
|
|
|
|
[Table](../interfaces/Table.md).[name](../interfaces/Table.md#name)
|
|
|
|
#### Defined in
|
|
|
|
[index.ts:302](https://github.com/lancedb/lancedb/blob/b1eeb90/node/src/index.ts#L302)
|
|
|
|
## Methods
|
|
|
|
### add
|
|
|
|
▸ **add**(`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
|
|
|
|
#### Implementation of
|
|
|
|
[Table](../interfaces/Table.md).[add](../interfaces/Table.md#add)
|
|
|
|
#### Defined in
|
|
|
|
[index.ts:320](https://github.com/lancedb/lancedb/blob/b1eeb90/node/src/index.ts#L320)
|
|
|
|
___
|
|
|
|
### countRows
|
|
|
|
▸ **countRows**(): `Promise`<`number`\>
|
|
|
|
Returns the number of rows in this table.
|
|
|
|
#### Returns
|
|
|
|
`Promise`<`number`\>
|
|
|
|
#### Implementation of
|
|
|
|
[Table](../interfaces/Table.md).[countRows](../interfaces/Table.md#countrows)
|
|
|
|
#### Defined in
|
|
|
|
[index.ts:362](https://github.com/lancedb/lancedb/blob/b1eeb90/node/src/index.ts#L362)
|
|
|
|
___
|
|
|
|
### createIndex
|
|
|
|
▸ **createIndex**(`indexParams`): `Promise`<`any`\>
|
|
|
|
Create an ANN index on this Table vector index.
|
|
|
|
**`See`**
|
|
|
|
VectorIndexParams.
|
|
|
|
#### Parameters
|
|
|
|
| Name | Type | Description |
|
|
| :------ | :------ | :------ |
|
|
| `indexParams` | [`IvfPQIndexConfig`](../interfaces/IvfPQIndexConfig.md) | The parameters of this Index, |
|
|
|
|
#### Returns
|
|
|
|
`Promise`<`any`\>
|
|
|
|
#### Implementation of
|
|
|
|
[Table](../interfaces/Table.md).[createIndex](../interfaces/Table.md#createindex)
|
|
|
|
#### Defined in
|
|
|
|
[index.ts:355](https://github.com/lancedb/lancedb/blob/b1eeb90/node/src/index.ts#L355)
|
|
|
|
___
|
|
|
|
### delete
|
|
|
|
▸ **delete**(`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`\>
|
|
|
|
#### Implementation of
|
|
|
|
[Table](../interfaces/Table.md).[delete](../interfaces/Table.md#delete)
|
|
|
|
#### Defined in
|
|
|
|
[index.ts:371](https://github.com/lancedb/lancedb/blob/b1eeb90/node/src/index.ts#L371)
|
|
|
|
___
|
|
|
|
### overwrite
|
|
|
|
▸ **overwrite**(`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
|
|
|
|
#### Implementation of
|
|
|
|
[Table](../interfaces/Table.md).[overwrite](../interfaces/Table.md#overwrite)
|
|
|
|
#### Defined in
|
|
|
|
[index.ts:338](https://github.com/lancedb/lancedb/blob/b1eeb90/node/src/index.ts#L338)
|
|
|
|
___
|
|
|
|
### search
|
|
|
|
▸ **search**(`query`): [`Query`](Query.md)<`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`](Query.md)<`T`\>
|
|
|
|
#### Implementation of
|
|
|
|
[Table](../interfaces/Table.md).[search](../interfaces/Table.md#search)
|
|
|
|
#### Defined in
|
|
|
|
[index.ts:310](https://github.com/lancedb/lancedb/blob/b1eeb90/node/src/index.ts#L310)
|