AlloyDB Omni Dialect

$ npm install ts-prorm-orm pg

$ pnpm add ts-prorm-orm pg

$ yarn add ts-prorm-orm pg

$ bun add ts-prorm-orm pg

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

export const db = new Prorm({
  dialect: 'alloydbomni',
  host: 'localhost',
  database: 'postgres',
  username: 'postgres',
  password: process.env.OMNI_PASSWORD,
});

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

export const db = new Prorm({
  dialect: 'alloydbomni',
  url: 'alloydbomni://postgres:secret@localhost:5432/postgres',
});

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 });
  // A nested transaction is a SAVEPOINT; its failure undoes only its own work.
  await db
    .transaction(async (sp) => {
      await User.destroy({ where: { id: 1 }, transaction: sp });
      throw new Error('keep the row');
    }, { transaction: t })
    .catch(() => {});
});

await db.transaction(async (t) => {
  await User.findAll({ where: { name: 'Ada' }, lock: { level: 'UPDATE', skipLocked: true }, transaction: t });
});

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

// docker run -d --name my-omni -e POSTGRES_PASSWORD=… -p 5432:5432 google/alloydbomni
const d = new Prorm({
  dialect: 'alloydbomni',
  host: 'localhost',
  database: 'postgres',
  username: 'postgres',
  password: process.env.OMNI_PASSWORD,
});

new Prorm({
  dialect: 'alloydbomni',
  dialectOptions: {
    iam: true,
  },
});
// Error: AlloyDB Omni does not support Google IAM database authentication …

d.buildEnableColumnarEngineSql({ memorySizeInMb: 2048 });
// [ "ALTER SYSTEM SET google_columnar_engine.enabled = 'on'",
//   'ALTER SYSTEM SET google_columnar_engine.memory_size_in_mb = 2048' ]
d.buildDisableColumnarEngineSql(); // … enabled = 'off'
d.buildColumnStoreMemorySql(1024); // at least 128 (server default 1024)
d.buildColumnarEngineStatusSql(); // SHOW google_columnar_engine.enabled
d.buildRecommendedColumnsQuery();
// SELECT database_name, schema_name, relation_name, column_name, estimated_size_in_bytes
//   FROM g_columnar_recommended_columns

d.columnarEngineAdd('public.orders', ['total', 'region']);
d.columnarEngineRefresh('orders');
d.columnarEngineRecommend(); // run auto-columnarization now
d.columnarEngineRecommend('RECOMMEND_SIZE');
d.columnarEngineAddIndex('docs_emb'); // cache a ScaNN index