Interface Database

Common interface for high-level Database implementations (SqliteDb, PostgresDb). Provides methods for querying and transaction management.

interface Database {
    disconnect(): Promise<void>;
    query<T = unknown>(
        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:91

query

query<T = unknown>(
sql: string,
params?: QueryParams,
): Promise<DatabaseResult<QueryResponse<T>>>
Executes an SQL query and returns the results.
Type Parameters
- T = unknown
  The expected type of the rows.
Parameters
- sql: string
  The SQL query string.
- Optionalparams: QueryParams
  Optional query parameters.
Returns Promise<DatabaseResult<QueryResponse<T>>>
A promise resolving to the query result.
- Defined in ts-core/src/database/core/types.ts:72

transaction

transaction<T>(
callback: () => Promise<DatabaseResult<T>>,
): Promise<DatabaseResult<T>>
Executes a callback within a database transaction.
Type Parameters
- T
  The return type of the callback.
Parameters
- callback: () => Promise<DatabaseResult<T>>
  The function to execute within the transaction.
Returns Promise<DatabaseResult<T>>
A promise resolving to the result of the callback.
- Defined in ts-core/src/database/core/types.ts:83