1. dialects
prorm
  • prorm documentation
  • Known test gaps
  • Architecture
  • Core concepts
  • Database types & coverage
  • Getting started
  • Going further
  • compliance
    • Compliance
    • The security toolkit: `prorm audit`
    • Checklists by regulation
    • Declaring personal data
    • Evidence bundles
    • Evidence
    • Frameworks: `@Security`
    • Jurisdictions
    • Platform policies
    • Protecting data
    • The regulation dataset
    • Residency and cross-border transfers
    • Retention & integrity
    • Status
    • Subject rights
  • decorators
    • prorm with decorators
    • Models with decorators
    • Querying a decorated model
    • Relations with decorators
  • diagrams
    • Diagram generators
    • Chen diagram
    • Class diagram
    • Dependency diagram
    • ER diagram
    • Flow diagram
    • From your models to a diagram
    • Gantt diagram
    • Index diagram
    • Migration diagram
    • Model diagram
    • Package diagram
    • Crow’s-foot diagram
    • Schema documentation
    • Sequence diagram
    • State diagram
    • Tree diagram
  • dialects
    • SQL dialects
    • AlloyDB Dialect
    • AlloyDB Omni Dialect
    • Amazon Athena Dialect
    • Aurora DSQL Dialect
    • Amazon Aurora MySQL Dialect
    • Amazon Aurora PostgreSQL Dialect
    • Azure Database for MySQL Dialect
    • Azure Database for PostgreSQL Dialect
    • Azure SQL Database Dialect
    • Azure SQL Managed Instance Dialect
    • Google BigQuery Dialect
    • Citus Dialect
    • ClickHouse dialect
    • Cloud Authentication (`cloud-auth`)
    • Cloud SQL for SQL Server Dialect
    • Cloud SQL for MySQL Dialect
    • Cloud SQL for PostgreSQL Dialect
    • CockroachDB Dialect
    • Azure Cosmos DB for PostgreSQL Dialect
    • CrateDB Dialect
    • Cloudflare D1 Dialect
    • Databricks dialect
    • IBM Db2 Dialect
    • Dolt Dialect
    • Apache Doris Dialect
    • Druid Dialect
    • DuckDB Dialect
    • Exasol dialect
    • Microsoft Fabric Data Warehouse Dialect
    • Firebird Dialect
    • Greenplum Dialect
    • SAP HANA Dialect
    • MySQL HeatWave Dialect
    • Azure Data Explorer (Kusto) Dialect — T-SQL
    • MariaDB Dialect
    • Materialize Dialect
    • MonetDB Dialect
    • MotherDuck Dialect
    • Microsoft SQL Server Dialect
    • MySQL Dialect
    • Neon Dialect
    • OceanBase Dialect
    • openGauss Dialect
    • Oracle Dialect
    • Oracle Autonomous Database Dialect
    • ParadeDB Dialect
    • PolarDB Dialect
    • PostgreSQL Dialect
    • Presto Dialect
    • QuestDB Dialect
    • Aurora RDS Data API Dialect (`rdsdata`)
    • Amazon RDS for Db2 Dialect
    • Amazon RDS for MariaDB Dialect
    • Amazon RDS for SQL Server Dialect
    • Amazon RDS for MySQL Dialect
    • Amazon RDS for Oracle Dialect
    • Amazon RDS for PostgreSQL Dialect
    • Amazon Redshift
    • Amazon Redshift Data API Dialect
    • RisingWave Dialect
    • rqlite Dialect
    • SingleStore Dialect
    • Snowflake Dialect
    • Google Cloud Spanner Dialect
    • Spanner (PostgreSQL interface) Dialect
    • SQLite Dialect
    • StarRocks Dialect
    • Supabase Dialect
    • Azure Synapse Analytics (dedicated SQL pool)
    • Teradata Dialect
    • TiDB Dialect
    • TimescaleDB Dialect
    • Trino Dialect
    • Turso / libSQL Dialect
    • Vertica dialect
    • Vitess Dialect
    • Yellowbrick Dialect
    • YugabyteDB Dialect
  • guides
    • Access rules and behaviour profiles
    • ArangoDB (AQL)
    • Associations
    • Audit levels and escalation
    • Audit logging
    • In the browser
    • Bulk operations
    • Caching
    • Capabilities, tiers and team roles
    • CLI
    • Cloudflare
    • Compliance & data protection
    • Connection Pooling & Performance
    • Security in the console
    • Couchbase: structured N1QL queries
    • Data types
    • Decorators
    • Eager loading
    • Enums and constants
    • Error handling & error types
    • Extensions
    • External fields
    • Foreign data wrappers
    • Graph databases
    • Hooks & lifecycle events
    • Indexes & constraints
    • InfluxDB: structured Flux pipelines
    • klock-errors
    • klock — the `.klock` file
    • Local databases (`prorm db up`)
    • Structured log search — Splunk, Graylog, Papertrail, Sumo Logic
    • Logging
    • Grafana Loki: structured LogQL queries
    • MCP server
    • Migrate — the data transfer subsystem
    • Migrations & Schema Sync
    • Models from an existing database
    • Defining models
    • Multiple databases
    • OrientDB, Neptune and TigerGraph
    • Passwords
    • Importing a Prisma schema
    • Structured PromQL and MetricsQL
    • Query firewall
    • QueryInterface
    • Query operators reference
    • Query optimization
    • Composing find options with `pipe()` and `Q`
    • Query safety: the fail-closed WHERE guard
    • Querying
    • Raw Queries & Query Building
    • Read replicas
    • Schema diffing & migration generation
    • Views, triggers & other schema objects
    • Scopes & default scopes
    • Seeders
    • SPARQL / RDF triplestores
    • SQL constants
    • SQL features
    • SQL function builders
    • SQLite advanced features
    • StoreKey — a prod-orm database as the storage
    • Streaming results
    • Terraform
    • Transactions & Isolation Levels
    • Type mapping: legacy and modern
    • TypeScript types
    • Database users, roles & privileges
    • Validation & constraints
    • Virtual & Computed Fields
    • Writing docs
  • javascript
    • prorm in JavaScript
    • Models in JavaScript
    • Querying in JavaScript
    • Relations in JavaScript
  • runbooks
    • Operational runbooks
    • Connection failures
    • Credential rotation
    • Failover
    • Incident checklist
    • Deploying klock v2
    • Migration rollback
  • running-databases
    • Running databases in Docker
    • Running prorm under Bun in Docker
    • Running Cassandra in Docker with prorm
    • Running ClickHouse in Docker with prorm
    • Running CockroachDB in Docker with prorm
    • Running prorm under Deno in Docker
    • Running Elasticsearch in Docker with prorm
    • Running MariaDB in Docker with prorm
    • Running MongoDB in Docker with prorm
  • prorm control plane
    • Introduction
    • Authentication
    • Errors
    • Getting started
      • Service
        • Is it up
        • This description
    • Account
      • Sign-up and verification
        • Create an account
        • Exchange credentials for a token
        • Verify with the emailed code
        • Verify by clicking the emailed link
        • Name the parent or guardian
        • What a consent link is about
        • Give consent for a child's account
        • Ask the parent or guardian again
        • Send a new code and link
      • Family
        • Everyone this account is responsible for
        • One child, in detail
        • Turn a limit on or off
      • Profile
        • Who am I
        • Change the account
        • Every address on the account
        • Add an address
        • Confirm an address with the code mailed to it
        • Mail a fresh code to an unconfirmed address
        • Make an address primary
        • Remove an address
        • What this caller may do
    • Security
      • Sessions
        • Everywhere this account is signed in
        • Sign out everywhere else
        • Sign one out
        • A token for the CLI on a named machine
        • A token for the customer console, from the staff one
        • Park a sign-in for the CLI to collect
        • The CLI collecting its sign-in
        • The team's members' live sessions
        • Sign a member's session out
        • Sign an account out everywhere
        • Everywhere the account is signed in
        • Sign an account's session out
      • Single sign-on
        • Begin a single sign-on
        • The provider's return
        • Link the signed-in account to a team's provider
        • Which team an address signs in to
        • The team's single sign-on, as a member sees it
        • Set the team's OpenID Connect provider up, or change it
        • Remove the provider
        • The team's domain claims and the DNS record each needs
        • Prove a claimed domain
      • MFA and passwords
        • Start enrolling a second factor
        • Prove the app has it
        • Remove the second factor
        • Ask for a reset link
        • Set a new password with the emailed token
      • Klock
        • Open a device-bound klock session
        • Check in, for the next grant
        • Step up the session asking
        • Rotate the device key
        • Freeze a session
        • Unfreeze a session
        • A guest grant
        • The revocation feed
        • The published keyset
        • What this control plane supports
      • Devices
        • Your devices, or a team's
        • Approve a new device's pairing code
        • One device
        • Rename a device
        • Revoke a device
        • Suspend a device
        • Reinstate a suspended device
        • Wipe a device
        • Ask a device to rotate its key
        • The team's members' devices
        • Revoke a member's device
        • An account's devices
        • Revoke an account's device
        • Wipe an account's device
        • The device fleet
      • Access rules and behaviour
        • The access rules that bear on you
        • Add an access rule
        • This request, as the rules see it
        • One access rule
        • Remove an access rule
        • The behaviour profiles that bear on you
        • Add or change a behaviour profile
        • The profile presets
        • Your behaviour findings
        • Acknowledge a finding
        • One behaviour profile
        • Remove a behaviour profile
        • The team's access rules
        • Add a team access rule
        • Remove a team access rule
        • The team's behaviour profiles
        • Add or change a team behaviour profile
        • Remove a team behaviour profile
        • What the team's profiles caught
        • Acknowledge a team finding
      • Recovery and lockdown
        • Ask for a recovery link
        • Recover access with the emailed code
        • Is the account locked down
        • Lock the account down
        • Release a lockdown
        • Lock a member down
        • Release a member's lockdown
      • MCP tokens
        • Make a delegated token for one MCP client
        • The account's delegated tokens
        • Revoke a delegated token
        • What a delegated token may do now
        • Run one MCP tool with a delegated token
        • Run a device-signed MCP tool call relayed by the MCP Worker
      • Kerberos
        • Give the team its own Kerberos realm
        • The team's realm
        • Remove the team's realm
    • Logging and monitoring
      • Audit log
        • What has been done to the account
        • What has happened to this account
        • The account's audit trail
      • Operations
        • Everything that has been asked of this database
        • One, with its steps
        • Stop it
        • Put a failed one back in the queue
        • Every operation, across all accounts
      • Metrics and events
        • Every measurement, for a graph
        • Who did what to it
    • Billing
      • Plans and pricing
        • What the plans allow
        • The rate card
        • What one database would cost
        • What this account is paying for, itemised
      • Subscriptions and invoices
        • What this month's invoice will say
        • What this account is on
        • What it has been charged
        • Start a Stripe Checkout session
        • Open the customer portal
        • Stripe's events
        • Buy more connection pools
      • Team billing
        • The team's billing account
        • What the team has been charged
        • What this month's invoice will say
        • The team's cards
        • Add a card, through a Stripe-hosted setup session
        • Make a card the team's default
        • Remove a card
        • Start the team paying
        • Open the Stripe portal on the team's customer
        • Change the team's plan
        • Who receives the team's bills
        • How the team pays for transfers
    • Support
      • Support chat
        • My conversations
        • Start a conversation
        • Every support conversation, open first
        • A ticket for the socket
        • One conversation, with who is in it and who is connected
        • Rename a group; open or close a support conversation
        • The lines, oldest first
        • Say something
        • Add somebody
        • Mark read
    • Administration
      • Users
        • Every account
        • One account, with everything hanging off it
        • Grant or revoke admin
        • Verify an account by hand
        • Lock or unlock sign-in
        • Allow or hold provisioning
        • Send the verification mail again
        • Set the plan by hand
      • Platform
        • Every database and store, across all accounts
        • The counts worth putting on a dashboard
      • Staff and permissions
        • What kind of admin the caller is, and which scopes they hold
        • The admin presets
        • Every admin, and the scopes each resolves to
        • Make an account an admin of a kind
        • Change an admin's kind, or a custom admin's scopes
        • Revoke admin
      • Team administration
        • Every team, with its owner and size
        • One team in full — members with their accounts, and projects
        • Hand the team to another member
        • Put an account in the team, active at once
        • Change a member's role
        • Remove a member
      • Assumed identities
        • Assume an identity — act as a customer account
        • The identities the caller holds open
        • End an assumed identity
      • Support inbox
        • The platform's addresses
        • Add a platform address
        • One address, with its counts
        • Change an address's label, routing, or whether it accepts mail
        • Remove an address that holds no mail
        • Make, adopt or repair the address's routing rule
        • Every admin's personal address, made where missing
        • File a raw message, as if it had arrived
        • The inbox
        • One message, whole
        • Mark a message
        • Hand a message to an admin, or take it back
        • Leave an internal note
        • Reply, from the address the message came to
        • What is waiting
    • Databases
      • Databases
        • Data stores
          • Every data store on the account
          • Provision a data store
          • Change a data store that is already running
          • One data store
          • Deprovision it
          • Report what it is using
          • How to reach a data store
        • Connections and credentials
          • The api keys on a database
          • Issue a key
          • Revoke a key
          • The engine users we created
          • Create a user inside the database
          • Give a user a new password
          • Drop a user
          • How the database is reached
          • Set how it is reached
          • Revoke every api key on it
          • How to connect to it
          • The ssh keys that open its bastion
          • Add a key, or have one made
          • The private half of a generated key, once
          • Revoke an ssh key
        • Schema and objects
          • The SQL objects we put in it
          • Create one, and apply it
          • What is in the database, as the engine reports it
          • One table
          • What it would run, without running it
          • Redefine an object in place
          • Drop it
          • The extensions installed in it
        • Migrations
          • A plan compiled to statements, recording nothing
          • The migrations recorded for it
          • Record one
          • Apply everything recorded and not yet run
          • Apply everything pending, oldest version first
        • Lifecycle
          • Grow or shrink it
          • Stop it accepting connections
          • Start it again
          • Move it to another region
        • Backups and replicas
          • Take a backup
          • The backups it has
          • Restore one into it
          • What has been restored into it, and from where
          • Its read copies
          • Add one
        • Policies
          • The catalog
          • One policy
          • What this database is held to
          • Switch a policy on, or change its knobs
          • Switch it off
          • Mark the policies reviewed
          • Evaluate the periodic policies now
          • Who is behind a credential
        • Passwordless
          • The database's passwordless sessions
          • Issue a passwordless session (v1)
          • Revoke a passwordless session
          • Bind a session to a device key
          • Issue a v2 session for a host to bind
          • Redeem an enrolment ticket on the host
          • Check a passwordless credential
          • Run one described query under a passwordless credential
        • Database roles
          • The database's roles
          • Define a role
          • One role
          • Change what a role permits
          • Delete a role, and revoke every key granted it
          • Grant a role, which mints a key
          • Who holds a role
          • The api keys bound to a role
        • Pools
          • A database's connection pools, and how busy each is
          • Open another pool
          • Rename a pool or change its size
          • Close a pool
        • Data plane
          • Run a query against a database
          • Several statements, in order, over one connection
          • Is this database answering
          • What the proxy itself is holding
        • Transfers
          • The strategies this account's tier may use
          • Price a transfer without creating it
          • The account's transfer jobs, newest first
          • Create a transfer job
          • One job, and whether its certificate holds
          • Cancel an unfinished job
          • Start a created job, confirming its price
          • Report a job's status (the runner, or the owner's side of a local run)
        • Every database on the account
        • Provision a database
        • Change a database that is already running
        • One database
        • Deprovision it
        • Read or write it
        • Report what it is using
        • The engines this API will provision
        • Where a managed database can be put
    • Teams
      • Teams
        • Members
          • Who is on it
          • Invite somebody
          • Accept an invitation
          • Change somebody's role
          • Remove somebody
        • Projects
          • The projects a team runs
          • Start one
          • Rename a project, or move its environment
          • Delete a project
          • One project, and what is in it
          • Put a database or store in it
          • What is in a project
          • Take one out
        • The teams this account is on
        • Start one
        • The twelve roles, and what each may do
        • Rename a team
        • Close a team
        • One team
        • Hand the team to somebody else
        • Leave a team
    • Schemas
      • Error
      • ValidationErrors
      • Token
      • PolicyCategory
      • PolicySeverity
      • PolicyAction
      • PolicyTrigger
      • PolicyParam
      • Policy
      • PolicyCatalog
      • PolicyAssignment
      • PolicyOutcome
      • PolicyFiring
      • CredentialTrace
      • Relation
      • Restrictions
      • ChildSummary
      • SignupRequest
      • SigninRequest
      • UpdateMeRequest
      • User
      • Address
      • GeoPoint
      • D1Region
      • Usage
      • UsageReport
      • Resource
      • Database
      • DataStore
      • NewDatabase
      • NewDataStore
      • QueryRequest
      • DatabasePrivilege
      • ApiKey
      • DbUser
      • Access
      • AccessRequest
      • DatabaseObject
      • NewDatabaseObject
      • NewMigration
      • SchemaOperation
      • Migration
      • Operation
      • Session
      • AdminPowers
      • Admin
      • AuditEntry
      • TeamRole
      • Conversation
      • ChatMessage
      • TeamSso
      • Team
      • TeamMember
      • SshKey
      • ConnectionInfo
      • InboxAddress
      • InboxMailbox
      • InboxMessageSummary
      • InboxMessage
      • InboxNote
      • Page
      • Quote
      • Plan
      • ApiError
      • CapabilityRefusal
      • KlockErrorCode
      • PageWindow
      • SessionView
      • KlockStepUpRequest
      • KlockOpenRequest
      • KlockOpenedSession
      • UpdateMeResult
      • CapabilitiesView
      • SessionLimits
      • Device
      • DeviceListed
      • DeviceTeamRef
      • DeviceCommand
      • DeviceAuditLine
      • DeviceActionRequest
      • StaffActionRequest
      • ManagedSession
      • SessionRevoked
      • AccessRule
      • AccessRuleRequest
      • BehaviourProfile
      • BehaviourProfileRequest
      • BehaviourProfileSaved
      • BehaviourFinding
      • BehaviourFindingAck
      • StepUpProof
      • Removed
      • MemberLockdownRequest
      • McpClient
      • McpDelegatedView
      • McpToolCall
      • McpForwardRequest
      • PasswordlessScope
      • RoleScope
      • PasswordlessSession
      • PasswordlessTlsMaterial
      • PasswordlessKerberosMaterial
      • ServiceDeviceKeys
      • ServiceSession
      • DatabaseRole
      • TransferEndpoint
      • TransferJobRequest
      • TransferQuote
      • TransferStrategy
      • TransferJob
      • TransferJobAccess
      • Pool
      • PoolAllowance
      • BillingSubscription
      • Invoice
      • BillingContact
      • PaymentMethod
      • UpcomingCharges
      • TeamBilling
      • TeamKerberosRealm
      • TeamSsoDomain
      • TeamSsoResponse
      • StoreConnection
      • BatchFailure
      • ProxyStatus
  1. dialects

Trino Dialect

Overview#

PropertyValue
Dialect nametrino
ExtendsPostgresDialect (postgres)
Driverpg
Cloud SDKnone
Default port8080
Local runtimeself-hosted; no image in this repo
Source: trino
Tests: trino, trino-crud
Trino (formerly PrestoSQL) is a distributed, federated ANSI-SQL query engine. It is not a storage engine of its own — it runs SQL over pluggable connectors (Hive, Iceberg, MySQL, PostgreSQL, Kafka, …).
Because its SQL surface is ANSI-flavored and it quotes identifiers with double quotes (like PostgreSQL), TrinoDialect extends PostgresDialect and overrides only where Trino differs:
export class TrinoDialect extends PostgresDialect {
  readonly name = 'trino';
  // ...
}
Key defaults and differences (all implemented in the source):
Default port 8080 — Trino's HTTP/query port, not PostgreSQL's 5432. Injected by the constructor via super({ port: 8080, ...config }).
Three-part catalog.schema.table naming when a catalog is configured.
Connector table properties via CREATE TABLE ... WITH (...).
CREATE TABLE AS SELECT (CTAS) as the primary way to materialize a table.
No key constraints (PRIMARY KEY / FOREIGN KEY / UNIQUE / DEFAULT), no identity/SERIAL, no upsert, no indexes.

Quick start#

Install#

$ npm install ts-prorm-orm pg
$ pnpm add ts-prorm-orm pg
$ yarn add ts-prorm-orm pg
$ bun add ts-prorm-orm pg
pg is the same driver the postgres dialect uses. pg-copy-streams is optional: only the features that need it load it.
[!CAUTION] A SQL-generation layer
The driver the catalog lists, pg, is the one the parent dialect loads; it does not speak Trino's own wire protocol, so connecting to a live server is unverified. The builders — everything under Generated SQL — are what this dialect is for. See Not-yet-verified.

Connect#

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

export const db = new Prorm({
  dialect: 'trino',
  host: 'trino.internal',
  username: 'analyst',
  dialectOptions: {
    catalog: 'hive',
    schema: 'analytics',
  },
});
import { Prorm } from 'ts-prorm-orm';

export const db = new Prorm({
  dialect: 'trino',
  url: 'trino://analyst@trino.internal:8080/hive',
  dialectOptions: {
    catalog: 'hive',
    schema: 'analytics',
  },
});
A URL is folded into host, port, database, username and password before the dialect is built; any of those passed alongside it wins.

Define a model#

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

Query#

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

Generated SQL#

Each block is the statement the model call above it hands the dialect's query(), captured with the driver stubbed out. The model layer inlines the values.

Create table#

db.sync() for the model in the Quick start:
CREATE TABLE

Insert, update and delete#

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

Upsert#

await User.upsert({ id: 1, email: 'ada@example.com', name: 'Ada Lovelace' });
MERGE statement
upsert() also reads the row by primary key before and after the write, to return the instance.

Pagination#

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

JSON#

[!NOTE] No JSON operator in the WHERE builder
DataTypes.JSON() maps to JSON, but this dialect's WHERE builder refuses Op.contains on it: Cannot render WHERE condition at meta.contains' is not implemented by its WHERE builder. The statement was not sent, because running it without the condition would match rows it should not.

Transaction#

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 });
});
[!WARNING] No savepoints
Nested transactions need savepoints, and trino has none. Run the work in a single transaction, or restructure it so nothing nests.

Table sampling#

sample on the select builder reads a random fraction of the table, for estimates over large tables:
const sample = db.getDialectInstance()!.buildSelectQuery({
  tableName: 'users',
  sample: { method: 'BERNOULLI', percent: 10 },
});
await db.query(sample.sql);
Type mapping for the portable descriptors: STRING → VARCHAR, auto-increment INTEGER → INTEGER, BOOLEAN → BOOLEAN, DATE → TIMESTAMP, UUID → UUID, JSON → JSON. The type comparison lines the major engines up side by side.

Connection#

Trino-specific options extend the PostgreSQL options with a connector catalog and a default schema:
export interface TrinoDialectOptions extends PostgresDialectOptions {
  /** Connector catalog (e.g. 'hive', 'iceberg'). Enables catalog.schema.table naming. */
  catalog?: string;
  /** Default schema used when a query/table doesn't specify one. */
  schema?: string;
}
When constructing through Prorm, dialect-specific extras (like catalog and schema) pass through dialectOptions:
import { Prorm } from 'ts-prorm-orm';

const prorm = new Prorm({
  dialect: 'trino',
  host: 'trino.internal',
  port: 8080,            // optional; the dialect defaults to 8080
  username: 'analyst',
  database: 'hive',      // PostgreSQL-style connection field
  dialectOptions: {
    catalog: 'hive',     // enables "catalog"."schema"."table" naming
    schema: 'analytics', // default schema when a query omits one
  },
});

The catalog option#

A Trino table lives in a connector catalog and a schema. catalog is what turns on Trino's fully-qualified three-part naming:
With a catalog configured, quoteTable emits "catalog"."schema"."table" (schema included only when known).
Without a catalog, it falls back to PostgreSQL's schema.table behavior (a bare "table" when no schema is given).
quoteTable(tableName: string, schema?: string): string {
  if (this.trinoCatalog) {
    const effectiveSchema = schema ?? this.trinoSchema;
    const parts = [this.escapeId(this.trinoCatalog)];
    if (effectiveSchema) {
      parts.push(this.escapeId(effectiveSchema));
    }
    parts.push(this.escapeId(tableName));
    return parts.join('.');
  }
  return super.quoteTable(tableName, schema);
}
Examples (from the tests):
new TrinoDialect({ catalog: 'iceberg', schema: 'default' })
  .quoteTable('t', 'staging');            // => "iceberg"."staging"."t"

new TrinoDialect({}).quoteTable('events'); // => "events"  (no catalog -> bare name)
A per-call schema argument overrides the configured default schema.

3. Trino-specific behavior#

catalog.schema.table naming#

Every DDL/CRUD builder qualifies the target table through quoteTable, so once a catalog is set, statements target "catalog"."schema"."table":

Connector table properties — WITH (...)#

buildCreateTableSQL appends a connector-properties clause built by buildTablePropertiesClause, which handles format, partitioning, and arbitrary tableProperties:
export interface TrinoTableOptions extends TableOptions {
  format?: string;                 // -> format = '...'
  partitioning?: string[];         // -> partitioning = ARRAY['...']
  tableProperties?: Record<string, string | number | boolean>;
  schema?: string;
}
Building a table with a file format and partitioning:
d.buildCreateTableSQL(
  't',
  { id: { type: 'BIGINT' }, day: { type: 'VARCHAR' } },
  { format: 'ORC', partitioning: ['day'] },
);
produces SQL containing:

Arbitrary tableProperties — string/number/boolean rendering#

buildTablePropertiesClause renders each tableProperties entry as key = value, single-quoting strings (escaping embedded quotes) and emitting numbers and booleans raw:
if (typeof value === 'string') {
  props.push(`${key} = '${value.replace(/'/g, "''")}'`);
} else {
  props.push(`${key} = ${value}`);
}
d.buildCreateTableSQL(
  't',
  { id: { type: 'BIGINT' } },
  { tableProperties: { bucket_count: 8, transactional: true, sorted_by: 'id' } },
);
renders the properties as:
(format and partitioning, when present, are emitted first; tableProperties follow in object order.)

CREATE TABLE AS SELECT (CTAS)#

buildCreateTableAsSelectSQL materializes a table from a raw SELECT. It supports ifNotExists, comment, the same WITH (...) connector properties, and a trailing WITH NO DATA (create structure only, copy no rows):
export interface TrinoCTASOptions extends TrinoTableOptions {
  withNoData?: boolean; // emit WITH NO DATA
}

d.buildCreateTableAsSelectSQL('summary', 'SELECT 1 AS n', {
  format: 'PARQUET',
  withNoData: true,
});
produces:
createTableAsSelect(tableName, selectQuery, options) is the async wrapper that executes the built statement.

Pagination — OFFSET before LIMIT#

Trino orders OFFSET before LIMIT (unlike PostgreSQL's LIMIT n OFFSET m) and allows a standalone OFFSET:
d.buildLimitOffset(10, 20);        // ' OFFSET 20 LIMIT 10'
d.buildLimitOffset(undefined, 5);  // ' OFFSET 5'
d.buildLimitOffset(10);            // ' LIMIT 10'
d.buildLimitOffset();              // ''

4. Type mapping#

getDataTypeSql maps ORM types to Trino spellings. The cross-dialect DATETIME pseudo-type (emitted by the model-sync layer for timestamp columns) is rewritten to TIMESTAMP, preserving any precision.
ORM type / keyTrino SQLNotes
STRINGVARCHARUnbounded — no length emitted
TEXTVARCHARUnbounded
CHARCHAR(n) / CHARLength used when present
INTEGERINTEGERNo SERIAL; autoIncrement ignored
BIGINTBIGINT
FLOATREAL
DOUBLEDOUBLENot DOUBLE PRECISION
DECIMALDECIMAL(precision, scale)Defaults DECIMAL(10, 0)
BOOLEANBOOLEAN
DATETIMESTAMPMapped to timestamp
DATEONLYDATE
TIMETIME
BLOBVARBINARY
JSONJSON
JSONBJSON
UUIDUUID
ARRAYARRAY(elementType)Falls back to ARRAY(VARCHAR) when the element type is unknown
'DATETIME' / 'DATETIME(n)' (string pseudo-type)TIMESTAMP / TIMESTAMP(n)Precision preserved
unknown object / non-objectVARCHARDefault fallback
A raw string data type that is not DATETIME is passed through unchanged.
Verified assertions from the tests:
d.getDataTypeSql({ key: 'STRING' });                       // 'VARCHAR'
d.getDataTypeSql({ key: 'TEXT' });                         // 'VARCHAR'
d.getDataTypeSql({ key: 'FLOAT' });                        // 'REAL'
d.getDataTypeSql({ key: 'DOUBLE' });                       // 'DOUBLE'
d.getDataTypeSql({ key: 'BOOLEAN' });                      // 'BOOLEAN'
d.getDataTypeSql({ key: 'BIGINT' });                       // 'BIGINT'
d.getDataTypeSql({ key: 'DATE' });                         // 'TIMESTAMP'
d.getDataTypeSql({ key: 'DATEONLY' });                     // 'DATE'
d.getDataTypeSql({ key: 'JSON' });                         // 'JSON'
d.getDataTypeSql({ key: 'JSONB' });                        // 'JSON'
d.getDataTypeSql({ key: 'BLOB' });                         // 'VARBINARY'
d.getDataTypeSql({ key: 'ARRAY', type: { key: 'BIGINT' }});// 'ARRAY(BIGINT)'
d.getDataTypeSql({ key: 'ARRAY' });                        // 'ARRAY(VARCHAR)'
d.getDataTypeSql('DATETIME');                              // 'TIMESTAMP'
d.getDataTypeSql('DATETIME(6)');                           // 'TIMESTAMP(6)'

5. Unsupported operations#

Trino neither supports nor enforces key constraints, identity columns, upserts, or indexes. The dialect handles each explicitly.

Key constraints — omitted (not thrown)#

Column definitions are built by getTrinoColumnDefinitionSql, which emits only the name, type, an optional NOT NULL, and an optional COMMENT. It silently ignores primaryKey, unique, references (FOREIGN KEY), defaultValue, and autoIncrement:
protected getTrinoColumnDefinitionSql(columnName, definition): string {
  let sql = `${this.escapeId(columnName)} ${this.getDataTypeSql(definition.type)}`;
  if (definition.allowNull === false) sql += ' NOT NULL';
  if (definition.comment) sql += ` COMMENT '...'`;
  return sql;
}
So a table declared with PK/FK/UNIQUE/DEFAULT metadata still produces constraint-free DDL:
d.buildCreateTableSQL('t', {
  id:    { type: 'BIGINT', primaryKey: true, autoIncrement: true },
  orgId: { type: 'BIGINT', references: { table: 'orgs', field: 'id' } },
  name:  { type: 'VARCHAR', unique: true, defaultValue: 'x' },
});
// Output contains NONE of: PRIMARY KEY, FOREIGN KEY, REFERENCES, UNIQUE, SERIAL, DEFAULT
NOT NULL and IF NOT EXISTS are honored. ADD COLUMN uses the same builder, so added columns also carry no constraints:

No identity / SERIAL#

INTEGER maps to INTEGER and the autoIncrement flag is ignored — Trino has no SERIAL/BIGSERIAL/IDENTITY. Surrogate key values must be supplied by the application or source connector.

No upsert / ON CONFLICT — throws#

Both buildInsertQuery (with options.upsert) and buildUpsertQuery throw rather than emitting invalid INSERT ... ON CONFLICT:
plain.buildInsertQuery('users', { id: 1 }, { upsert: true, conflictFields: ['id'] });
// throws: "Trino does not support upsert / ON CONFLICT. ..."

plain.buildUpsertQuery('users', { id: 1 }, { conflictFields: ['id'] });
// throws: "Trino does not support upsert / ON CONFLICT. ..."
The error message suggests using INSERT, or MERGE (on connectors that support it) via raw SQL.

No RETURNING, no LIMIT on write statements#

INSERT, UPDATE, and DELETE never emit RETURNING or LIMIT, even when those options are passed:
plain.buildInsertQuery('users', { id: 1, name: 'ann' });
// INSERT INTO "users" ("id", "name") VALUES ($1, $2)   (no RETURNING)

cataloged.buildUpdateQuery('users', { name: 'bob' }, { id: 5 }, { returning: true, limit: 10 });
// UPDATE "hive"."sales"."users" SET "name" = $1 WHERE ...   (no RETURNING, no LIMIT)

cataloged.buildDeleteQuery('users', { id: 5 }, { returning: true, limit: 3 });
// DELETE FROM "hive"."sales"."users" WHERE ...             (no RETURNING, no LIMIT)

No TRUNCATE — degrades to DELETE#

Trino has no TRUNCATE; a truncate request becomes an unqualified DELETE FROM:
plain.buildDeleteQuery('users', {}, { truncate: true });
// DELETE FROM "users"

No CASCADE on DROP TABLE#

dropTable supports IF EXISTS but never emits CASCADE (there are no dependent constraints):
plain.dropTable('users', { ifExists: true, cascade: true });
// DROP TABLE IF EXISTS "users"

No indexes — throws#

Trino has no CREATE INDEX; data layout is controlled by connector table properties (partitioning, bucketed_by, …). Every index entry point throws via noIndexes(...):
addIndex
createIndex
removeIndex
dropIndex
createPartialIndex
createExpressionIndex
await plain.addIndex('t', 'i', ['c']);
// throws: "Trino does not support indexes (addIndex is unavailable). ..."

6. Not-yet-verified#

The Trino test suites run without a database connection — they assert only on generated SQL strings and thrown errors. The following are covered by the source and tests:
SQL-generation verified (no live Trino):
catalog.schema.table naming and per-call schema override (quoteTable).
CREATE TABLE with WITH (...) (format, partitioning, arbitrary tableProperties — string/number/boolean rendering).
Omission of PRIMARY KEY / FOREIGN KEY / UNIQUE / DEFAULT / SERIAL; honoring of NOT NULL and IF NOT EXISTS.
CREATE TABLE AS SELECT including WITH NO DATA.
The full type-mapping table above.
INSERT / UPDATE / DELETE SQL (catalog-qualified, no RETURNING/LIMIT), truncate → DELETE FROM, DROP TABLE without CASCADE, ADD/DROP COLUMN.
Pagination ordering (OFFSET before LIMIT, standalone OFFSET).
Upsert and all index operations throwing.
Needs a live Trino cluster (not exercised here):
Actual connection/handshake over port 8080 (the dialect inherits PostgreSQL's pg-based connection machinery, which is not the Trino wire protocol — real connectivity is unverified by these tests).
Runtime execution of any statement (createTable, createTableAsSelect, addColumn, removeColumn, dropTable, and CRUD): UPDATE/DELETE support in particular is connector-dependent at execution time.
Whether specific WITH (...) properties, file formats, and partitioning schemes are accepted by a given connector (Hive, Iceberg, …).
MERGE-based upsert on connectors that support it (suggested by the error message but not implemented by the dialect).

Row locks and PostgreSQL-only operators#

The dialect extends PostgresDialect, but the PostgreSQL-only parts of its
SELECT are not Trino SQL, so they are rendered natively or refused.
Trino has no row-level locking, so any lock option is refused:
Trino has no row-level locking, so `lock` cannot be honoured. Remove the `lock` option; a lock the caller believes it holds but does not is worse than an error.
The PostgreSQL JSON, array, range and full-text operators (Op.contains as
@>, Op.overlap as &&, ?, range operators, @@) are refused with an
UnsupportedWhereError, and the statement is not sent:
Cannot render WHERE condition at tags.$contains for trino: the operator '$contains' is not implemented by its WHERE builder. The statement was not sent, because running it without the condition would match rows it should not.
[!NOTE]
Before 4.9.2 this dialect sent PostgreSQL's FOR SHARE / SKIP LOCKED
clauses and the @> / && operators unchanged, and the server rejected
them.

What differs from Postgres#

TrinoDialect extends PostgresDialect (postgres) and
overrides 45 of its methods (Object.getOwnPropertyNames(TrinoDialect.prototype),
computed by the scratch test); everything else is inherited unchanged.
AreaOverridden
DML buildersbuildDeleteQuery, buildInsertQuery, buildLimitOffset, buildUpdateQuery, buildUpsertMergeQuery, buildUpsertQuery, quoteTable
TypesbinaryTypeSql, canonicalTypeSql, characterTypeSql, collectionTypeSql, documentTypeSql, enumTypeSql, extensionTypeSql, getTrinoColumnDefinitionSql, integerTypeSql, legacyDataTypeSql, legacyInvalidTypeNames, legacyTypeReplaced, namedEnumTypes, networkTypeSql, numericTypeSql, rangeTypeSql, spatialTypeSql, temporalTypeSql, unknownTypeSql, vectorTypeSql
DDL and schemaaddColumn, addIndex, buildCreateTableAsSelectSQL, buildCreateTableSQL, buildTablePropertiesClause, createExpressionIndex, createIndex, createPartialIndex, createTable, createTableAsSelect, dropIndex, dropTable, removeColumn, removeIndex
IntrospectionresolveCtasQuery
OtherlockClauseSpec, noIndexes, unsupportedWhereOperators

Capabilities#

Computed from the code — capabilitiesOf() (src/transaction-support.ts),
whereSupportOf() (src/query-builders/expression-render.ts),
sqlObjectCapabilitiesOf() (src/sql-objects/capabilities.ts) and the
builders — by the scratch test described in the
capability matrix.
Capabilitytrino
Transactions atomicyes
Savepointsno — a nested transaction() throws
Isolationup to SERIALIZABLE
Transaction modesread-only yes; deferrable yes; constraint deferral yes
RETURNINGnot emitted; returning is accepted and ignored
UpsertMERGE INTO … WHEN MATCHED / WHEN NOT MATCHED
JSON columnJSON (JSONB → JSON)
Vector columnARRAY(REAL)
Array columnARRAY(INTEGER)
WHERE builder46 operator keys; $and/$or/$not; $exists: yes; $in subquery: yes; expression operands: yes
SQL objectsfamily unknown: triggers no; procedures no; functions no; materialized views no; sequences no; enums check; RLS no
StreamingqueryStream() present; LISTEN present; createExtension() present

Testing#

tests/dialects/trino.test.ts exercises the dialect with a mocked driver, so nothing touches a server.

Related reading#

All dialects — what each engine supports
Data types — how each type maps to this engine
Querying — how a FindOptions becomes SQL
Modified at 2026-10-04 00:40:16
Previous
TimescaleDB Dialect
Next
Turso / libSQL Dialect
Built with