Skip to content
VentureKit

@venturekit/data

Installation

Section titled “Installation”
Terminal window
npm install @venturekit/data@dev

What It Provides

Section titled “What It Provides”

RDS Configuration

Section titled “RDS Configuration”
import { createRdsConfig, DEFAULT_RDS_CONFIG, buildRdsConfig } from '@venturekit/data';


const config = createRdsConfig({ engine: 'postgres', instanceSize: 'small', databaseName: 'mydb' });

Query Utilities

Section titled “Query Utilities”
import { query, getPool, mapResults, mapRow } from '@venturekit/data';


const result = await query('SELECT * FROM tasks WHERE id = $1', [taskId]);
const tasks = mapResults(result, row => ({ id: row.id, title: row.title }));

Transactions

Section titled “Transactions”
import { beginTransaction, withTransaction, buildTransaction } from '@venturekit/data';


// Automatic commit/rollback
const result = await withTransaction(async (tx) => {
  await tx.query('INSERT INTO tasks (title) VALUES ($1)', ['New']);
  return { created: true };
});

Migration Utilities

Section titled “Migration Utilities”
import { createMigrationConfig, DEFAULT_MIGRATION_CONFIG, getFlywayEnv } from '@venturekit/data';

Types

Section titled “Types”
  • RdsOutputs, RdsInfraConfig — RDS infrastructure types
  • Transaction, ResultsMapper — query and transaction types

Dependencies

Section titled “Dependencies”
  • @venturekit/core — required
  • pg — PostgreSQL client
Section titled “Related”