PolarDB Dialect

$ npm install ts-prorm-orm mysql2

$ pnpm add ts-prorm-orm mysql2

$ yarn add ts-prorm-orm mysql2

$ bun add ts-prorm-orm mysql2

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

export const db = new Prorm({
  dialect: 'polardb',
  host: 'pc-xxxx.mysql.polardb.rds.aliyuncs.com',
  database: 'app',
  username: 'app',
  password: process.env.DB_PASSWORD,
});

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

export const db = new Prorm({
  dialect: 'polardb',
  url: 'polardb://app:secret@pc-xxxx.mysql.polardb.rds.aliyuncs.com:3306/app',
});

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) },
});

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,
});

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';

const db = new Prorm({
  dialect: 'polardb',
  host: 'pc-xxxx.mysql.polardb.rds.aliyuncs.com',
  port: 3306, // the cluster endpoint's default; no override needed
  username: 'app',
  password: '...',
  database: 'test',
});

PolarDB for MySQL does not support the SERIALIZABLE isolation level.
Supported levels are READ UNCOMMITTED, READ COMMITTED, REPEATABLE READ.

db.dialect.buildUpsertQuery('kv', { k: 'a', v: 1 });

PolarDB for MySQL supports only the InnoDB engine for partitioned tables (got
'MyISAM'). Non-InnoDB engines are converted to InnoDB on ordinary tables but
rejected on partitioned ones.

db.dialect.withRouteHint('SELECT * FROM t', 'master');
// "/*FORCE_MASTER*/SELECT * FROM t"

db.dialect.buildSelectQuery({ tableName: 'users', route: 'master' });

db.dialect.buildSelectQuery({ tableName: 'users', parallel: 8 });