Interface Database

Common interface for high-level Database implementations (SqliteDb, PostgresDb).

interface Database {
    disconnect(): Promise<void>;
    query<T = any>(
        sql: string,
        params?: QueryParams,
    ): Promise<DatabaseResult<QueryResponse<T>>>;
    transaction<T>(
        callback: () => Promise<DatabaseResult<T>>,
    ): Promise<DatabaseResult<T>>;
}

Index

Methods

disconnect query transaction

Methods

disconnect

disconnect(): Promise<void>
Disconnects from the database (only useful in 'stateful' mode).

Returns Promise<void>
- Defined in ts-core/src/database/core/types.ts:58

query

query<T = any>(
sql: string,
params?: QueryParams,
): Promise<DatabaseResult<QueryResponse<T>>>
Type Parameters
- T = any
Parameters
- sql: string
- Optionalparams: QueryParams
Returns Promise<DatabaseResult<QueryResponse<T>>>
- Defined in ts-core/src/database/core/types.ts:46

transaction

transaction<T>(
callback: () => Promise<DatabaseResult<T>>,
): Promise<DatabaseResult<T>>
Type Parameters
- T
Parameters
- callback: () => Promise<DatabaseResult<T>>
Returns Promise<DatabaseResult<T>>
- Defined in ts-core/src/database/core/types.ts:51