StarRocks 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: 'starrocks',
  host: 'starrocks-fe.internal',
  database: 'analytics',
  username: 'root',
  password: process.env.DB_PASSWORD,
});

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

export const db = new Prorm({
  dialect: 'starrocks',
  url: 'starrocks://root:secret@starrocks-fe.internal:9030/analytics',
});

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.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 });
  await User.update({ name: 'Grace Hopper' }, { where: { email: 'grace@example.com' }, transaction: t });
});

StarRocks has no 'INVERTED' index type (index 'i'). The available types are
BITMAP (low-cardinality equality) and GIN (full-text inverted, 3.3+). Note that
Doris's INVERTED and NGRAM_BF are Doris-only spellings.

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

const db = new Prorm({
  dialect: 'starrocks',
  host: 'starrocks-fe.internal',
  port: 9030, // the frontend's MySQL-protocol port; the default
  username: 'root',
  password: '...',
  database: 'analytics',
});

await db.dialect.createTable(
  'orders',
  {
    order_id: { type: DataTypes.BIGINT, allowNull: false },
    customer: { type: DataTypes.TEXT },
    total: { type: DataTypes.DECIMAL(12, 2) },
  },
  {
    keyModel: 'PRIMARY',
    keyColumns: ['order_id'],
    orderBy: ['customer'],
    distributedBy: { columns: ['order_id'], buckets: 8 },
    properties: { replication_num: 1, enable_persistent_index: true },
  },
);

{ partition: { expression: "date_trunc('day', ts)" } }
// PARTITION BY date_trunc('day', ts)

await db.dialect.addIndex('orders', 'idx_status', ['status'], { using: 'BITMAP' });
// CREATE INDEX `idx_status` ON `orders` (`status`) USING BITMAP

await db.dialect.createMaterializedView({
  name: 'mv_daily',
  query: 'SELECT day, sum(v) FROM t GROUP BY day',
  partitionBy: 'day',
  distributedBy: { columns: ['day'], buckets: 4 },
  refreshScheme: 'ASYNC',
  refreshStart: '2024-01-01 00:00:00',
  refreshEvery: 'INTERVAL 1 DAY',
  properties: { replication_num: 1 },
});