Aurora RDS Data API Dialect (`rdsdata`)

$ npm install ts-prorm-orm @aws-sdk/client-rds-data

$ pnpm add ts-prorm-orm @aws-sdk/client-rds-data

$ yarn add ts-prorm-orm @aws-sdk/client-rds-data

$ bun add ts-prorm-orm @aws-sdk/client-rds-data

import { Prorm } from 'ts-prorm-orm';

export const db = new Prorm({
  dialect: 'rdsdata',
  database: 'app',
  dialectOptions: {
    engine: 'postgres', // or 'mysql'
    resourceArn: 'arn:aws:rds:us-east-1:123456789012:cluster:app-cluster',
    secretArn: 'arn:aws:secretsmanager:us-east-1:123456789012:secret:app-AbCdEf',
    region: 'us-east-1',
  },
});

import { DataTypes } from 'ts-prorm-orm';

const User = db.define('User', {
  id: { type: DataTypes.INTEGER(), primaryKey: true, autoIncrement: true },
  email: { type: DataTypes.STRING(255), allowNull: false, unique: true },
  name: { type: DataTypes.STRING(100) },
  meta: { type: DataTypes.JSONB() },
});

await db.sync(); // CREATE TABLE — see Generated SQL below

import { Op } from 'ts-prorm-orm';

await User.create({ email: 'ada@example.com', name: 'Ada' });

const page = await User.findAll({
  where: { name: { [Op.like]: 'A%' } },
  order: [['id', 'ASC']],
  limit: 20,
  offset: 40,
});

await User.create({ email: 'ada@example.com', name: 'Ada' });
await User.update({ name: 'Grace' }, { where: { email: 'ada@example.com' } });
await User.destroy({ where: { id: 1 } });

await User.upsert({ id: 1, email: 'ada@example.com', name: 'Ada Lovelace' });

await User.findAll({
  where: { name: { [Op.like]: 'A%' } },
  order: [['id', 'ASC']],
  limit: 20,
  offset: 40,
});

import { Op } from 'ts-prorm-orm';

await User.findAll({ where: { meta: { [Op.contains]: { plan: 'pro' } } } });

await db.transaction(async (t) => {
  await User.create({ email: 'grace@example.com', name: 'Grace' }, { transaction: t });
  await User.update({ name: 'Grace Hopper' }, { where: { email: 'grace@example.com' }, transaction: t });
});

const sample = db.getDialectInstance()!.buildSelectQuery({
  tableName: 'users',
  sample: { method: 'BERNOULLI', percent: 10 },
});
await db.query(sample.sql);

import { Prorm } from 'ts-prorm-orm';

const db = new Prorm({
  dialect: 'rdsdata',
  database: 'app',
  dialectOptions: {
    engine: 'postgres', // or 'mysql'
    resourceArn: 'arn:aws:rds:us-east-1:123456789012:cluster:app-cluster',
    secretArn: 'arn:aws:secretsmanager:us-east-1:123456789012:secret:app-AbCdEf',
    region: 'us-east-1',
    // credentials, endpoint (VPC/FIPS endpoint), resultSetOptions, continueAfterTimeout
  },
});

await db.query('SELECT * FROM orders WHERE id = :id AND total > :min', {
  replacements: { id: RdsDataTypes.uuid(orderId), min: RdsDataTypes.decimal('10.00') },
});

const tx = await db.getDialect().startTransaction(); // BeginTransaction
await tx.query('UPDATE accounts SET balance = balance - $1 WHERE id = $2', {
  replacements: [10, 1],
});
await tx.commit(); // CommitTransaction

const { sql } = dialect.buildInsertQuery('events', { kind: '', at: new Date() });
await dialect.batch(
  sql,
  rows.map((r) => [r.kind, r.at]),
  { transaction: tx },
);