@venturekit/data API
Functions
Section titled “Functions”RDS Configuration
Section titled “RDS Configuration”| Function | Description |
|---|---|
createRdsConfig(options) | Create RDS configuration |
buildRdsConfig(config) | Build RDS infrastructure config |
Query Utilities
Section titled “Query Utilities”| Function | Signature | Description |
|---|---|---|
query | (sql: string, params?: unknown[]) => Promise<QueryResult> | Execute a SQL query |
getPool | () => Pool | Get the PostgreSQL connection pool |
mapResults | (result: QueryResult, mapper: (row) => T) => T[] | Map query results |
mapRow | (row: any, mapper: (row) => T) => T | Map a single row |
Transactions
Section titled “Transactions”| Function | Signature | Description |
|---|---|---|
beginTransaction | () => Promise<Transaction> | Start a new transaction |
withTransaction | (fn: (tx: Transaction) => Promise<T>) => Promise<T> | Execute within auto-commit/rollback transaction |
buildTransaction | (options?) => Transaction | Build a transaction with custom options |
Migration Utilities
Section titled “Migration Utilities”| Function | Description |
|---|---|
createMigrationConfig(options) | Create migration configuration |
getFlywayEnv(config) | Get Flyway-compatible environment variables |
| Type | Description |
|---|---|
RdsOutputs | RDS deployment outputs (endpoint, port, secret ARN) |
RdsInfraConfig | RDS infrastructure configuration |
Transaction | Transaction object with query(), commit(), rollback() |
ResultsMapper | Function type for mapping query results |
Constants
Section titled “Constants”| Constant | Description |
|---|---|
DEFAULT_RDS_CONFIG | Default RDS configuration |
DEFAULT_MIGRATION_CONFIG | Default migration configuration |