vectordb / Exports / LocalConnection

Class: LocalConnection

A connection to a LanceDB database.

Implements

• Connection

Table of contents

Constructors

• constructor

Properties

• _db
• _options

Accessors

• uri

Methods

• createTable
• createTableImpl
• dropTable
• openTable
• tableNames
• withMiddleware

Constructors

constructor

• new LocalConnection(db, options)

Parameters

Name	Type
db	any
options	ConnectionOptions

Defined in

index.ts:716

Properties

_db

• Private Readonly _db: any

Defined in

index.ts:714

---

_options

• Private Readonly _options: () => ConnectionOptions

Type declaration

▸ (): ConnectionOptions

Returns

ConnectionOptions

Defined in

index.ts:713

Accessors

uri

• get uri(): string

Returns

string

Implementation of

Connection.uri

Defined in

index.ts:721

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?	Table\<any> | Record\<string, unknown>[]
optsOrEmbedding?	WriteOptions | EmbeddingFunction\<T>
opt?	WriteOptions

Returns

Promise\<Table\<T>>

Implementation of

Connection.createTable

Defined in

index.ts:765

---

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

index.ts:799

---

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

Connection.dropTable

Defined in

index.ts:853

---

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

Connection.openTable

Defined in

index.ts:737

▸ 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

index.ts:745

▸ 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

index.ts:749

---

tableNames

▸ tableNames(): Promise\<string[]>

Get the names of all tables in the database.

Returns

Promise\<string[]>

Implementation of

Connection.tableNames

Defined in

index.ts:728

---

withMiddleware

▸ withMiddleware(middleware): Connection

Instrument the behavior of this Connection with middleware.

The middleware will be called in the order they are added.

Currently this functionality is only supported for remote Connections.

Parameters

Name	Type
middleware	HttpMiddleware

Returns

Connection

• this Connection instrumented by the passed middleware

Implementation of

Connection.withMiddleware

Defined in

index.ts:857