@lancedb/lancedb / Exports / Connection
Class: Connection
A LanceDB Connection that allows you to open tables and create new ones.
Connection could be local against filesystem or remote against a server.
A Connection is intended to be a long lived object and may hold open resources such as HTTP connection pools. This is generally fine and a single connection should be shared if it is going to be used many times. However, if you are finished with a connection, you may call close to eagerly free these resources. Any call to a Connection method after it has been closed will result in an error.
Closing a connection is optional. Connections will automatically be closed when they are garbage collected.
Any created tables are independent and will continue to work even if the underlying connection has been closed.
Table of contents
Constructors
Properties
Methods
Constructors
constructor
• new Connection(inner): Connection
Parameters
| Name | Type |
|---|---|
inner |
Connection |
Returns
Defined in
Properties
inner
• Readonly inner: Connection
Defined in
Methods
close
▸ close(): void
Close the connection, releasing any underlying resources.
It is safe to call this method multiple times.
Any attempt to use the connection after it is closed will result in an error.
Returns
void
Defined in
createEmptyTable
▸ createEmptyTable(name, schema, options?): Promise\<Table>
Creates a new empty Table
Parameters
| Name | Type | Description |
|---|---|---|
name |
string |
The name of the table. |
schema |
Schema\<any> |
The schema of the table |
options? |
Partial\<CreateTableOptions> |
- |
Returns
Promise\<Table>
Defined in
createTable
▸ createTable(name, data, options?): Promise\<Table>
Creates a new Table and initialize it with new data.
Parameters
| Name | Type | Description |
|---|---|---|
name |
string |
The name of the table. |
data |
Table\<any> | Record\<string, unknown>[] |
Non-empty Array of Records to be inserted into the table |
options? |
Partial\<CreateTableOptions> |
- |
Returns
Promise\<Table>
Defined in
display
▸ display(): string
Return a brief description of the connection
Returns
string
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>
Defined in
isOpen
▸ isOpen(): boolean
Return true if the connection has not been closed
Returns
boolean
Defined in
openTable
▸ openTable(name): Promise\<Table>
Open a table in the database.
Parameters
| Name | Type | Description |
|---|---|---|
name |
string |
The name of the table |
Returns
Promise\<Table>
Defined in
tableNames
▸ tableNames(options?): Promise\<string[]>
List all the table names in this database.
Tables will be returned in lexicographical order.
Parameters
| Name | Type | Description |
|---|---|---|
options? |
Partial\<TableNamesOptions> |
options to control the paging / start point |
Returns
Promise\<string[]>