Extensions

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

const prorm = new Prorm({
  dialect: 'postgres',
  url: process.env.DATABASE_URL,
  extensions: ['pgvector', 'postgis', { name: 'pg_trgm', schema: 'ext', version: '1.6' }],
});

await prorm.sync();            // installs the extensions, then creates tables
await prorm.ensureExtensions(); // or just the extensions, without syncing

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

new Prorm({
  dialect: 'postgres',
  url: process.env.DATABASE_URL,
  extensions: ['vector', 'postgis', { name: 'pg_trgm', schema: 'ext', version: '1.6' }],
});

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

new Prorm({ dialect: 'duckdb', storage: './warehouse.duckdb', extensions: ['spatial', 'httpfs'] });

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

// The catalogue maps query_rewrite to the rewriter plugin and its library.
new Prorm({ dialect: 'mysql', url: process.env.DATABASE_URL, extensions: ['query_rewrite'] });

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

// Loaded per connection, through better-sqlite3's loadExtension().
new Prorm({ dialect: 'sqlite', storage: 'app.db', extensions: [{ name: 'vec0', path: './ext/vec0.dylib' }] });

$ prorm db up --dialect postgres --ext pgvector

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

const prorm = new Prorm({
  dialect: 'postgres',
  url: process.env.DATABASE_URL,
  extensions: ['pgvector'], // accepted for "vector"
});
await prorm.connect();

const Doc = prorm.define('Doc', {
  id: { type: DataTypes.INTEGER, primaryKey: true, autoIncrement: true },
  body: { type: DataTypes.TEXT },
  embedding: { type: DataTypes.VECTOR(1536) },
}, { tableName: 'docs' });

await prorm.sync(); // CREATE EXTENSION first, then CREATE TABLE docs

$ prorm extensions list --url $DATABASE_URL

$ prorm extensions export --url $DATABASE_URL --key dev
✓ Wrote 1 extension(s) for dev to prorm.extensions.json. Replay with: prorm extensions import --from prorm.extensions.json

import { planExtensions, readExtensionsManifest } from 'ts-prorm-orm';

const { statements } = await planExtensions(prorm, ['vector'], { dryRun: true });
// ['CREATE EXTENSION IF NOT EXISTS "vector"']

$ prorm extensions import vector postgis --dialect postgres --database app --dry-run
CREATE EXTENSION IF NOT EXISTS "vector";
CREATE EXTENSION IF NOT EXISTS "postgis";
$ prorm extensions import postgis_topology --cascade --dialect postgres --database app --dry-run
CREATE EXTENSION IF NOT EXISTS "postgis_topology" CASCADE;
$ prorm extensions import pg_trgm --schema ext --version 1.6 --dialect postgres --database app --dry-run
CREATE EXTENSION IF NOT EXISTS "pg_trgm" SCHEMA "ext" VERSION '1.6';

$ prorm extensions list --dialect sqlite --database ./app.sqlite
name                status     installed  default  note
dbstat              installed                      virtual-table module
fts3                installed                      virtual-table module
fts4                installed                      virtual-table module
fts5                installed                      virtual-table module
geopoly             installed                      virtual-table module
rtree               installed                      virtual-table module
…

$ prorm extensions import foo --dialect mssql --database app --dry-run
✗ mssql has no extensions prorm can install. Extensions are a PostgreSQL, DuckDB, SQLite (loadable modules) and MySQL/MariaDB (plugins) feature. The closest equivalents on mssql are server features, not installable here: Full-Text Search, In-Memory OLTP, PolyBase, Machine Learning Services, CLR Integration.
$ echo $?
2

$ prorm extensions import vector --dialect rdsmysql --database app --dry-run
✗ rdsmysql has no extensions prorm can install. RDS for MySQL enables plugins through option groups: aws rds add-option-to-option-group --option-group-name <group> --options OptionName=<PLUGIN> --apply-immediately

$ prorm extensions export --url $PROD_URL --key prod
$ prorm extensions import --from prorm.extensions.json --source prod --url $STAGING_URL

{
  "version": 1,
  "generatedAt": "2026-09-25T12:00:00.000Z",
  "databases": {
    "prod": {
      "dialect": "rdspostgres",
      "extensions": [
        { "name": "vector", "version": "0.7.4" },
        { "name": "postgis", "version": "3.4.2", "schema": "gis" }
      ]
    }
  }
}

$ prorm extensions import 'x"; DROP TABLE users; --' --dialect postgres --database app --dry-run
✗ Invalid extension name "x\"; DROP TABLE users; --": use letters, digits, underscores and hyphens, starting with a letter or underscore (max 63).
$ echo $?
2

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

const prorm = new Prorm({ dialect: 'postgres', url: process.env.DATABASE_URL });
await prorm.connect();

await prorm.createExtension('pg_trgm', { ifNotExists: true });
await prorm.hasExtension('pg_trgm');
await prorm.getExtensions();
await prorm.dropExtension('pg_trgm', { cascade: true });

import {
  findExtension, listExtensionsForDialect, listExtensionsByCategory,
  listExtensionsForDialectAndCategory, searchExtensions,
  listCategoriesForDialect, extensionCatalog,
} from 'ts-prorm-orm';

findExtension('pg_trgm');
listExtensionsForDialect('postgres');            // 51 entries
listExtensionsByCategory('vector-search');
listExtensionsForDialectAndCategory('mysql', 'full-text-search');
searchExtensions('vector');                      // name + description search
listCategoriesForDialect('oracle');

{
  name: 'pg_trgm',
  dialects: ['postgres', 'cockroachdb'],
  category: 'full-text-search',
  description: 'Trigram-based similarity matching and indexing for text ' +
    '(similarity(), % operator, GiST/GIN opclasses). On CockroachDB, ' +
    '`CREATE EXTENSION pg_trgm` is accepted as a no-op compatibility shim ' +
    'only — no trigram functions or operators are actually provided.',
  installCommand: 'CREATE EXTENSION IF NOT EXISTS pg_trgm',
  isNativeSqlExtension: true,
  docsUrl: 'https://www.postgresql.org/docs/current/pgtrgm.html',
}

const options = searchExtensions('vector')
  .filter((e) => e.dialects.includes(prorm.getDialect() as any));

for (const e of options) {
  console.log(e.name, '—', e.description);
  if (e.installCommand) console.log('  install:', e.installCommand);
  console.log('  docs:', e.docsUrl);
}

await prorm.createExtension('vector', { ifNotExists: true });