Interface IKeyValueDatabaseConnector

The key-value database connector interface.

interface IKeyValueDatabaseConnector {
    close(): void;
    createTable(tableName): void;
    getTableConnector<T>(tableName): IKeyValueDatabaseTableConnector<T>;
    hasTable(tableName): boolean;
    open(): Promise<void>;
}

Index

Methods

close createTable getTableConnector hasTable open

Methods

close

close(): void
Close the database.

Returns void

createTable

createTable(tableName): void
Create a table in the database.
Parameters
- tableName: string
  The name of the table to create.
Returns void

getTableConnector

getTableConnector<T>(tableName): IKeyValueDatabaseTableConnector<T>
Get the table connector for a table in the database.
Type Parameters
- T extends IValueType
Parameters
- tableName: string
  The name of the table to get the connector for.
Returns IKeyValueDatabaseTableConnector<T>

hasTable

hasTable(tableName): boolean
Check if a table exists in the database.
Parameters
- tableName: string
Returns boolean
True if the table exists, false otherwise.

open

open(): Promise<void>
Open the database and run a migration on it if necessary.

Returns Promise<void>

Generated using TypeDoc