Interface DatabaseEngine

src/types.ts:88–123

}

export interface DatabaseEngine {
	getType(): KnexClient

	getConnection(): knexlib.Knex | CustomSqliteEngine | null

	/**
	 * Returns true if the connection is okay
	 */
	isOkay(): Promise<boolean>

	/**
 * Gets the tables in the database
 */
	getTables(): Promise<string[]>

	getTableCreationSql(table: string): Promise<string>

	getColumns(table: string): Promise<Column[]>

	/**
	 * Returns a list of column type names that are numeric
	 */
	getNumericColumnTypeNamesLowercase(): string[]

	getTotalRows(table: string, columns: Column[], whereClause?: Record<string, any>): Promise<number>

	getRows(table: string, columns: Column[], limit: number, offset: number, whereClause?: Record<string, any>): Promise<QueryResponse | undefined>

	commitChange(serializedMutation: SerializedMutation, transaction: knexlib.Knex.Transaction | SQLiteTransaction): Promise<void>

	getVersion(): Promise<string | undefined>

	disconnect(): Promise<void>

	rawQuery(code: string): Promise<any>
}

export type QueryResponse = {
	rows: any[]