Class Database

Hierarchy

Database

Index

Constructors

constructor

Properties

db

Accessors

inTransaction

Methods

Constructors

constructor

new Database(path_or_sqlite3: string | Sqlite3.Database, options?: DatabaseOptions): Database

- Defined in sqlite3-storage.ts:75
Parameters
- path_or_sqlite3: string | Sqlite3.Database
  
  path or better-sqlite3 Database instance
- Optional options: DatabaseOptions
  
  better-sqlite3 Database option and table name used by sqlite3-storage
Returns Database

Properties

db

db: Sqlite3.Database

Accessors

inTransaction

get inTransaction(): boolean

- Defined in sqlite3-storage.ts:104
Return whether database is in transaction.

Returns boolean

Methods

close

close(): void

- Defined in sqlite3-storage.ts:111
Close database.

Returns void

getStorage

getStorage(name: string): Storage

- Defined in sqlite3-storage.ts:119
Get storage.

Parameters
- name: string
  
  Storage name
Returns Storage

transaction

transaction(options: TransactionOptions | null | undefined, func: function): void

- Defined in sqlite3-storage.ts:132
Execute function in transaction.

Parameters
- options: TransactionOptions | null | undefined
  
  Transaction options about rollback and lock.
- func: function
  
  Function to be executed in a transaction.
  - - (): void
    - Returns void
Returns void

Generated using TypeDoc