Dolt 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: 'dolt',
  host: 'localhost',
  database: 'mydb',
  username: 'root',
});

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

export const db = new Prorm({
  dialect: 'dolt',
  url: 'dolt://root@localhost:3306/mydb',
});

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(() => {});
});

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

const d = new Prorm({
  dialect: 'dolt',
  host: '127.0.0.1',
  // port defaults to 3306
  username: 'root',
  database: 'mydb',          // or 'mydb/feature' — a revision database
});
await d.connect();

d.buildCommitSql({ message: 'Add users', all: true, author: { name: 'Ann', email: 'ann@x.io' } });
// CALL DOLT_COMMIT('-a', '-m', 'Add users', '--author', 'Ann <ann@x.io>')

d.buildAddSql('all');                         // CALL DOLT_ADD('-A')
d.buildAddSql(['t1', 't2']);                  // CALL DOLT_ADD('t1', 't2')

d.buildCreateBranchSql('feature', 'main~2');  // CALL DOLT_BRANCH('feature', 'main~2')
d.buildCopyBranchSql('main', 'feature1');     // CALL DOLT_BRANCH('-c', 'main', 'feature1')
d.buildRenameBranchSql('old', 'new');         // CALL DOLT_BRANCH('-m', 'old', 'new')
d.buildDeleteBranchSql('b', { force: true }); // CALL DOLT_BRANCH('-D', 'b')

d.buildMergeSql('feature', { noFastForward: true, message: 'Merge feature' });
// CALL DOLT_MERGE('feature', '--no-ff', '-m', 'Merge feature')
d.buildAbortMergeSql();                       // CALL DOLT_MERGE('--abort')

d.buildResetSql({ mode: 'hard', target: 'HEAD~1' }); // CALL DOLT_RESET('--hard', 'HEAD~1')
d.buildResetSql({ tables: ['t'] });                  // CALL DOLT_RESET('t')

d.buildTagSql('v1.0', { ref: 'main', message: 'release' });
// CALL DOLT_TAG('-m', 'release', 'v1.0', 'main')
d.buildRevertSql('HEAD~2');                   // CALL DOLT_REVERT('HEAD~2')
d.buildCherryPickSql('feature~1');            // CALL DOLT_CHERRY_PICK('feature~1')
d.buildHashOfSql('main');                     // SELECT HASHOF('main') AS `hash`

d.buildSelectQuery({ tableName: 'users', where: { id: 1 }, asOf: 'main~3' });
// { sql: "SELECT * FROM `users` AS OF 'main~3' WHERE `id` = ?", values: [1] }

d.buildSelectQuery({ tableName: 'users', asOf: new Date('2024-01-01') });
// SELECT * FROM `users` AS OF TIMESTAMP('2024-01-01 ...')

d.buildDiffQuery({ from: 'main', to: 'feature', table: 'inventory', where: { diff_type: 'removed' } });
// { sql: "SELECT * FROM DOLT_DIFF('main', 'feature', 'inventory') WHERE `diff_type` = ?", values: ['removed'] }

d.buildDiffQuery({ from: 'main', to: 'feature', table: 'inventory', threeDot: true });
// SELECT * FROM DOLT_DIFF('main...feature', 'inventory')

d.buildDiffSummaryQuery({ from: 'main', to: 'WORKING' });
d.buildDiffStatQuery({ from: 'main', to: 'WORKING', table: 'inventory' });
d.buildSchemaDiffQuery({ from: 'main', to: 'feature' });
d.buildLogQuery({ revision: { from: 'main', to: 'feature' }, tables: ['users'] });
// SELECT * FROM DOLT_LOG('main..feature', '--tables', 'users')

d.buildHistoryQuery('users', { where: { id: 7 }, limit: 5 });
// SELECT * FROM `dolt_history_users` WHERE `id` = ? LIMIT 5
d.buildStatusQuery(); // SELECT * FROM `dolt_status`