Skip to content

@venturekit/data API

FunctionDescription
createRdsConfig(options)Create RDS configuration
buildRdsConfig(config)Build RDS infrastructure config
FunctionSignatureDescription
query(sql: string, params?: unknown[]) => Promise<QueryResult>Execute a SQL query
getPool() => PoolGet the PostgreSQL connection pool
mapResults(result: QueryResult, mapper: (row) => T) => T[]Map query results
mapRow(row: any, mapper: (row) => T) => TMap a single row
FunctionSignatureDescription
beginTransaction() => Promise<Transaction>Start a new transaction
withTransaction(fn: (tx: Transaction) => Promise<T>) => Promise<T>Execute within auto-commit/rollback transaction
buildTransaction(options?) => TransactionBuild a transaction with custom options
FunctionDescription
createMigrationConfig(options)Create migration configuration
getFlywayEnv(config)Get Flyway-compatible environment variables
TypeDescription
RdsOutputsRDS deployment outputs (endpoint, port, secret ARN)
RdsInfraConfigRDS infrastructure configuration
TransactionTransaction object with query(), commit(), rollback()
ResultsMapperFunction type for mapping query results
ConstantDescription
DEFAULT_RDS_CONFIGDefault RDS configuration
DEFAULT_MIGRATION_CONFIGDefault migration configuration