Class: DuckDBInstance
The DuckDBInstance class manages a DuckDB database instance, providing methods to interact with the database such as executing queries, uploading files, and managing tables.
Param
The DuckDB instance.
Param
The connection to the DuckDB instance.
Accessors
connection
Get Signature
get connection():
AsyncDuckDBConnection
Returns
AsyncDuckDBConnection
db
Get Signature
get db():
AsyncDuckDB
Returns
AsyncDuckDB
Methods
getInstance()
staticgetInstance():Promise<DuckDBInstance>
Returns
Promise<DuckDBInstance>
destroy()
destroy():
Promise<void>
Returns
Promise<void>
dropTable()
dropTable(
tableName):Promise<void>
Parameters
| Parameter | Type |
|---|---|
tableName | string |
Returns
Promise<void>
query()
query(
query):Promise<undefined|Table<any>>
Parameters
| Parameter | Type |
|---|---|
query | string |
Returns
Promise<undefined | Table<any>>
exec()
exec(
query):Promise<void>
Parameters
| Parameter | Type |
|---|---|
query | string |
Returns
Promise<void>
send()
send(
query,callback):Promise<void>
Parameters
| Parameter | Type |
|---|---|
query | string |
callback | (result) => void |
Returns
Promise<void>
uploadData()
uploadData(
data,tableName,insert,csvParseTimeFormat?,csvColumns?):Promise<{error?:unknown; }>
Parameters
| Parameter | Type | Default value |
|---|---|---|
data | string | Table<any> | Record<string, unknown>[] | ArrayBuffer | Uint8Array<ArrayBufferLike> | File | undefined |
tableName | string | undefined |
insert | boolean | false |
csvParseTimeFormat? | string | undefined |
csvColumns? | Record<string, string> | undefined |
Returns
Promise<{ error?: unknown; }>
uploadArrow()
uploadArrow(
table,tableName):Promise<{error?:unknown; }>
Parameters
| Parameter | Type |
|---|---|
table | Table<any> | ArrayBuffer | Uint8Array<ArrayBufferLike> |
tableName | string |
Returns
Promise<{ error?: unknown; }>
exportTableToArrow()
exportTableToArrow(
tableName):Promise<undefined|Table<any>>
Parameters
| Parameter | Type |
|---|---|
tableName | string |
Returns
Promise<undefined | Table<any>>
exportTableToArrowBuffer()
exportTableToArrowBuffer(
tableName):Promise<undefined|Uint8Array<ArrayBufferLike>>
Parameters
| Parameter | Type |
|---|---|
tableName | string |
Returns
Promise<undefined | Uint8Array<ArrayBufferLike>>
exportTableToPq()
exportTableToPq(
tableName):Promise<undefined|Uint8Array<ArrayBufferLike>>
Parameters
| Parameter | Type |
|---|---|
tableName | string |
Returns
Promise<undefined | Uint8Array<ArrayBufferLike>>
exportTableToCSV()
exportTableToCSV(
tableName):Promise<undefined|Uint8Array<ArrayBufferLike>>
Parameters
| Parameter | Type |
|---|---|
tableName | string |
Returns
Promise<undefined | Uint8Array<ArrayBufferLike>>
uploadObject()
uploadObject(
data,tableName,insert):Promise<{error?:unknown; }>
Parameters
| Parameter | Type | Default value |
|---|---|---|
data | Record<string, unknown>[] | undefined |
tableName | string | undefined |
insert | boolean | false |
Returns
Promise<{ error?: unknown; }>
logTable()
logTable(
tableName,full):Promise<void>
Parameters
| Parameter | Type | Default value |
|---|---|---|
tableName | string | undefined |
full | boolean | false |
Returns
Promise<void>