5b2c602fb3
* improve the docstring for NodeJS connect functions and `ConnectOptions` parameters. * Simplify `npm run build` steps.
6.1 KiB
vectordb / Exports / LocalConnection
Class: LocalConnection
A connection to a LanceDB database.
Implements
Table of contents
Constructors
Properties
Accessors
Methods
Constructors
constructor
• new LocalConnection(db, options)
Parameters
| Name | Type |
|---|---|
db |
any |
options |
ConnectionOptions |
Defined in
Properties
_db
• Private Readonly _db: any
Defined in
_options
• Private Readonly _options: () => ConnectionOptions
Type declaration
▸ (): ConnectionOptions
Returns
Defined in
Accessors
uri
• get uri(): string
Returns
string
Implementation of
Defined in
Methods
createTable
▸ createTable<T>(name, data?, optsOrEmbedding?, opt?): Promise<Table<T>>
Creates a new Table, optionally initializing it with new data.
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
name |
string | CreateTableOptions<T> |
data? |
Record<string, unknown>[] |
optsOrEmbedding? |
WriteOptions | EmbeddingFunction<T> |
opt? |
WriteOptions |
Returns
Promise<Table<T>>
Implementation of
Defined in
createTableImpl
▸ Private createTableImpl<T>(«destructured»): Promise<Table<T>>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
«destructured» |
Object |
› data? |
Table<any> | Record<string, unknown>[] |
› embeddingFunction? |
EmbeddingFunction<T> |
› name |
string |
› schema? |
Schema<any> |
› writeOptions? |
WriteOptions |
Returns
Promise<Table<T>>
Defined in
dropTable
▸ dropTable(name): Promise<void>
Drop an existing table.
Parameters
| Name | Type | Description |
|---|---|---|
name |
string |
The name of the table to drop. |
Returns
Promise<void>
Implementation of
Defined in
openTable
▸ openTable(name): Promise<Table<number[]>>
Open a table in the database.
Parameters
| Name | Type | Description |
|---|---|---|
name |
string |
The name of the table. |
Returns
Promise<Table<number[]>>
Implementation of
Defined in
▸ openTable<T>(name, embeddings): Promise<Table<T>>
Open a table in the database.
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
name |
string |
The name of the table. |
embeddings |
EmbeddingFunction<T> |
An embedding function to use on this Table |
Returns
Promise<Table<T>>
Implementation of
Connection.openTable
Defined in
▸ openTable<T>(name, embeddings?): Promise<Table<T>>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
name |
string |
embeddings? |
EmbeddingFunction<T> |
Returns
Promise<Table<T>>
Implementation of
Connection.openTable
Defined in
tableNames
▸ tableNames(): Promise<string[]>
Get the names of all tables in the database.
Returns
Promise<string[]>