metal-orm 1.1.11 → 1.1.16

package/src/core/ddl/introspect/catalogs/postgres.ts

@@ -1,146 +1,146 @@
-import { defineTable } from '../../../../schema/table.js';
-import { col } from '../../../../schema/column-types.js';
-
-/** Table definition for information_schema.columns, providing metadata about table columns. */
-export const PgInformationSchemaColumns = defineTable(
-  'columns',
-  {
-    table_schema: col.varchar(255),
-    table_name: col.varchar(255),
-    column_name: col.varchar(255),
-    data_type: col.varchar(255),
-    is_nullable: col.varchar(3),
-    column_default: col.varchar(1024),
-    ordinal_position: col.int()
-  },
-  {},
-  undefined,
-  { schema: 'information_schema' }
-);
-
-export const PgClass = defineTable(
-  'pg_class',
-  {
-    oid: col.int(),
-    relname: col.varchar(255),
-    relnamespace: col.int(),
-    relkind: col.varchar(1)
-  },
-  {},
-  undefined,
-  { schema: 'pg_catalog' }
-);
-
-export const PgNamespace = defineTable(
-  'pg_namespace',
-  {
-    oid: col.int(),
-    nspname: col.varchar(255)
-  },
-  {},
-  undefined,
-  { schema: 'pg_catalog' }
-);
-
-export const PgIndex = defineTable(
-  'pg_index',
-  {
-    indrelid: col.int(),
-    indexrelid: col.int(),
-    indisprimary: col.boolean(),
-    indkey: col.varchar(255),
-    indpred: col.varchar(1024)
-  },
-  {},
-  undefined,
-  { schema: 'pg_catalog' }
-);
-
-export const PgAttribute = defineTable(
-  'pg_attribute',
-  {
-    attrelid: col.int(),
-    attname: col.varchar(255),
-    attnum: col.int()
-  },
-  {},
-  undefined,
-  { schema: 'pg_catalog' }
-);
-
-export const PgTableConstraints = defineTable(
-  'table_constraints',
-  {
-    constraint_catalog: col.varchar(255),
-    constraint_schema: col.varchar(255),
-    constraint_name: col.varchar(255),
-    table_catalog: col.varchar(255),
-    table_schema: col.varchar(255),
-    table_name: col.varchar(255),
-    constraint_type: col.varchar(255)
-  },
-  {},
-  undefined,
-  { schema: 'information_schema' }
-);
-
-export const PgKeyColumnUsage = defineTable(
-  'key_column_usage',
-  {
-    constraint_catalog: col.varchar(255),
-    constraint_schema: col.varchar(255),
-    constraint_name: col.varchar(255),
-    table_catalog: col.varchar(255),
-    table_schema: col.varchar(255),
-    table_name: col.varchar(255),
-    column_name: col.varchar(255),
-    ordinal_position: col.int()
-  },
-  {},
-  undefined,
-  { schema: 'information_schema' }
-);
-
-export const PgConstraintColumnUsage = defineTable(
-  'constraint_column_usage',
-  {
-    constraint_catalog: col.varchar(255),
-    constraint_schema: col.varchar(255),
-    constraint_name: col.varchar(255),
-    table_catalog: col.varchar(255),
-    table_schema: col.varchar(255),
-    table_name: col.varchar(255),
-    column_name: col.varchar(255)
-  },
-  {},
-  undefined,
-  { schema: 'information_schema' }
-);
-
-export const PgReferentialConstraints = defineTable(
-  'referential_constraints',
-  {
-    constraint_catalog: col.varchar(255),
-    constraint_schema: col.varchar(255),
-    constraint_name: col.varchar(255),
-    unique_constraint_catalog: col.varchar(255),
-    unique_constraint_schema: col.varchar(255),
-    unique_constraint_name: col.varchar(255),
-    match_option: col.varchar(64),
-    update_rule: col.varchar(64),
-    delete_rule: col.varchar(64)
-  },
-  {},
-  undefined,
-  { schema: 'information_schema' }
-);
-
-/** Default export containing commonly used PostgreSQL catalog table definitions. */
-export default {
-  PgInformationSchemaColumns,
-  PgClass,
-  PgNamespace,
-  PgIndex,
-  PgAttribute
-};
-
+import { defineTable } from '../../../../schema/table.js';
+import { col } from '../../../../schema/column-types.js';
+
+/** Table definition for information_schema.columns, providing metadata about table columns. */
+export const PgInformationSchemaColumns = defineTable(
+  'columns',
+  {
+    table_schema: col.varchar(255),
+    table_name: col.varchar(255),
+    column_name: col.varchar(255),
+    data_type: col.varchar(255),
+    is_nullable: col.varchar(3),
+    column_default: col.varchar(1024),
+    ordinal_position: col.int()
+  },
+  {},
+  undefined,
+  { schema: 'information_schema' }
+);
+
+export const PgClass = defineTable(
+  'pg_class',
+  {
+    oid: col.int(),
+    relname: col.varchar(255),
+    relnamespace: col.int(),
+    relkind: col.varchar(1)
+  },
+  {},
+  undefined,
+  { schema: 'pg_catalog' }
+);
+
+export const PgNamespace = defineTable(
+  'pg_namespace',
+  {
+    oid: col.int(),
+    nspname: col.varchar(255)
+  },
+  {},
+  undefined,
+  { schema: 'pg_catalog' }
+);
+
+export const PgIndex = defineTable(
+  'pg_index',
+  {
+    indrelid: col.int(),
+    indexrelid: col.int(),
+    indisprimary: col.boolean(),
+    indkey: col.varchar(255),
+    indpred: col.varchar(1024)
+  },
+  {},
+  undefined,
+  { schema: 'pg_catalog' }
+);
+
+export const PgAttribute = defineTable(
+  'pg_attribute',
+  {
+    attrelid: col.int(),
+    attname: col.varchar(255),
+    attnum: col.int()
+  },
+  {},
+  undefined,
+  { schema: 'pg_catalog' }
+);
+
+export const PgTableConstraints = defineTable(
+  'table_constraints',
+  {
+    constraint_catalog: col.varchar(255),
+    constraint_schema: col.varchar(255),
+    constraint_name: col.varchar(255),
+    table_catalog: col.varchar(255),
+    table_schema: col.varchar(255),
+    table_name: col.varchar(255),
+    constraint_type: col.varchar(255)
+  },
+  {},
+  undefined,
+  { schema: 'information_schema' }
+);
+
+export const PgKeyColumnUsage = defineTable(
+  'key_column_usage',
+  {
+    constraint_catalog: col.varchar(255),
+    constraint_schema: col.varchar(255),
+    constraint_name: col.varchar(255),
+    table_catalog: col.varchar(255),
+    table_schema: col.varchar(255),
+    table_name: col.varchar(255),
+    column_name: col.varchar(255),
+    ordinal_position: col.int()
+  },
+  {},
+  undefined,
+  { schema: 'information_schema' }
+);
+
+export const PgConstraintColumnUsage = defineTable(
+  'constraint_column_usage',
+  {
+    constraint_catalog: col.varchar(255),
+    constraint_schema: col.varchar(255),
+    constraint_name: col.varchar(255),
+    table_catalog: col.varchar(255),
+    table_schema: col.varchar(255),
+    table_name: col.varchar(255),
+    column_name: col.varchar(255)
+  },
+  {},
+  undefined,
+  { schema: 'information_schema' }
+);
+
+export const PgReferentialConstraints = defineTable(
+  'referential_constraints',
+  {
+    constraint_catalog: col.varchar(255),
+    constraint_schema: col.varchar(255),
+    constraint_name: col.varchar(255),
+    unique_constraint_catalog: col.varchar(255),
+    unique_constraint_schema: col.varchar(255),
+    unique_constraint_name: col.varchar(255),
+    match_option: col.varchar(64),
+    update_rule: col.varchar(64),
+    delete_rule: col.varchar(64)
+  },
+  {},
+  undefined,
+  { schema: 'information_schema' }
+);
+
+/** Default export containing commonly used PostgreSQL catalog table definitions. */
+export default {
+  PgInformationSchemaColumns,
+  PgClass,
+  PgNamespace,
+  PgIndex,
+  PgAttribute
+};
+

package/src/core/ddl/introspect/context.ts

@@ -1,15 +1,15 @@
-import type { Dialect } from '../../dialect/abstract.js';
-import type { DbExecutor } from '../../execution/db-executor.js';
-
-/**
- * Context for schema introspection operations.
- * Provides the necessary components to perform database schema introspection.
- */
-export interface IntrospectContext {
-  /** The database dialect used for introspection. */
-  dialect: Dialect;
-  /** The database executor for running introspection queries. */
-  executor: DbExecutor;
-}
-
-export default IntrospectContext;
+import type { Dialect } from '../../dialect/abstract.js';
+import type { DbExecutor } from '../../execution/db-executor.js';
+
+/**
+ * Context for schema introspection operations.
+ * Provides the necessary components to perform database schema introspection.
+ */
+export interface IntrospectContext {
+  /** The database dialect used for introspection. */
+  dialect: Dialect;
+  /** The database executor for running introspection queries. */
+  executor: DbExecutor;
+}
+
+export default IntrospectContext;

package/src/core/ddl/introspect/functions/postgres.ts

@@ -1,35 +1,35 @@
-// Small helpers to build Postgres-specific function calls as AST FunctionNodes
-import { valueToOperand } from '../../../ast/expression-builders.js';
-import type { OperandNode, FunctionNode } from '../../../ast/expression.js';
-
-type OperandInput = OperandNode | string | number | boolean | null;
-
-const toOperand = (v: OperandInput): OperandNode => valueToOperand(v);
-
-const fn = (name: string, args: OperandInput[]): FunctionNode => ({
-  type: 'Function',
-  name,
-  fn: name,
-  args: args.map(toOperand)
-});
-
-/**
- * Creates a pg_get_expr function call AST node.
- * @param expr - The expression.
- * @param relid - The relation ID.
- * @returns The function node.
- */
-export const pgGetExpr = (expr: OperandInput, relid: OperandInput): FunctionNode =>
-  fn('pg_get_expr', [expr, relid]);
-
-/**
- * Creates a format_type function call AST node.
- * @param typeOid - The type OID.
- * @param typmod - The type modifier.
- * @returns The function node.
- */
-export const formatType = (typeOid: OperandInput, typmod: OperandInput): FunctionNode =>
-  fn('format_type', [typeOid, typmod]);
-
-/** Default export with PostgreSQL-specific function helpers. */
-export default { pgGetExpr, formatType };
+// Small helpers to build Postgres-specific function calls as AST FunctionNodes
+import { valueToOperand } from '../../../ast/expression-builders.js';
+import type { OperandNode, FunctionNode } from '../../../ast/expression.js';
+
+type OperandInput = OperandNode | string | number | boolean | null;
+
+const toOperand = (v: OperandInput): OperandNode => valueToOperand(v);
+
+const fn = (name: string, args: OperandInput[]): FunctionNode => ({
+  type: 'Function',
+  name,
+  fn: name,
+  args: args.map(toOperand)
+});
+
+/**
+ * Creates a pg_get_expr function call AST node.
+ * @param expr - The expression.
+ * @param relid - The relation ID.
+ * @returns The function node.
+ */
+export const pgGetExpr = (expr: OperandInput, relid: OperandInput): FunctionNode =>
+  fn('pg_get_expr', [expr, relid]);
+
+/**
+ * Creates a format_type function call AST node.
+ * @param typeOid - The type OID.
+ * @param typmod - The type modifier.
+ * @returns The function node.
+ */
+export const formatType = (typeOid: OperandInput, typmod: OperandInput): FunctionNode =>
+  fn('format_type', [typeOid, typmod]);
+
+/** Default export with PostgreSQL-specific function helpers. */
+export default { pgGetExpr, formatType };

package/src/core/ddl/introspect/registry.ts

@@ -1,40 +1,40 @@
-import type { DialectName } from '../schema-generator.js';
-import type { SchemaIntrospector } from './types.js';
-import { postgresIntrospector } from './postgres.js';
-import { mysqlIntrospector } from './mysql.js';
-import { sqliteIntrospector } from './sqlite.js';
-import { mssqlIntrospector } from './mssql.js';
-
-/** Registry mapping dialect names to their corresponding schema introspectors. */
-const registry = new Map<DialectName, SchemaIntrospector>();
-
-/**
- * Registers the built-in schema introspectors for all supported database dialects.
- */
-const registerBuiltInIntrospectors = () => {
-  registry.set('postgres', postgresIntrospector);
-  registry.set('mysql', mysqlIntrospector);
-  registry.set('sqlite', sqliteIntrospector);
-  registry.set('mssql', mssqlIntrospector);
-};
-
-registerBuiltInIntrospectors();
-
-/**
- * Registers a schema introspector for a dialect.
- * @param dialect - The dialect name.
- * @param introspector - The schema introspector.
- */
-export const registerSchemaIntrospector = (dialect: DialectName, introspector: SchemaIntrospector): void => {
-  registry.set(dialect, introspector);
-};
-
-/**
- * Gets the schema introspector for a dialect.
- * @param dialect - The dialect name.
- * @returns The schema introspector or undefined if not found.
- */
-export const getSchemaIntrospector = (dialect: DialectName): SchemaIntrospector | undefined => {
-  return registry.get(dialect);
-};
-
+import type { DialectName } from '../schema-generator.js';
+import type { SchemaIntrospector } from './types.js';
+import { postgresIntrospector } from './postgres.js';
+import { mysqlIntrospector } from './mysql.js';
+import { sqliteIntrospector } from './sqlite.js';
+import { mssqlIntrospector } from './mssql.js';
+
+/** Registry mapping dialect names to their corresponding schema introspectors. */
+const registry = new Map<DialectName, SchemaIntrospector>();
+
+/**
+ * Registers the built-in schema introspectors for all supported database dialects.
+ */
+const registerBuiltInIntrospectors = () => {
+  registry.set('postgres', postgresIntrospector);
+  registry.set('mysql', mysqlIntrospector);
+  registry.set('sqlite', sqliteIntrospector);
+  registry.set('mssql', mssqlIntrospector);
+};
+
+registerBuiltInIntrospectors();
+
+/**
+ * Registers a schema introspector for a dialect.
+ * @param dialect - The dialect name.
+ * @param introspector - The schema introspector.
+ */
+export const registerSchemaIntrospector = (dialect: DialectName, introspector: SchemaIntrospector): void => {
+  registry.set(dialect, introspector);
+};
+
+/**
+ * Gets the schema introspector for a dialect.
+ * @param dialect - The dialect name.
+ * @returns The schema introspector or undefined if not found.
+ */
+export const getSchemaIntrospector = (dialect: DialectName): SchemaIntrospector | undefined => {
+  return registry.get(dialect);
+};
+

package/src/core/ddl/introspect/run-select.ts

@@ -1,35 +1,35 @@
-import type { IntrospectContext } from './context.js';
-import type { SelectQueryNode } from '../../ast/query.js';
-
-import { queryRows } from './utils.js';
-
-/** A source that can provide a select query AST. */
-type SelectQuerySource = { getAST(): SelectQueryNode };
-
-/**
- * Runs a select query from a query builder and returns the results.
- * @param qb - The query builder.
- * @param ctx - The introspection context.
- * @returns The query results.
- */
-export async function runSelect<T = Record<string, unknown>>(
-  qb: SelectQuerySource,
-  ctx: IntrospectContext
-): Promise<T[]> {
-  const ast = qb.getAST();
-  const compiled = ctx.dialect.compileSelect(ast);
-  return (await queryRows(ctx.executor, compiled.sql, compiled.params)) as T[];
-}
-
-export default runSelect;
-
-/**
- * Runs a select query from an AST node and returns the results.
- * @param ast - The select query AST.
- * @param ctx - The introspection context.
- * @returns The query results.
- */
-export async function runSelectNode<T = Record<string, unknown>>(ast: SelectQueryNode, ctx: IntrospectContext): Promise<T[]> {
-  const compiled = ctx.dialect.compileSelect(ast);
-  return (await queryRows(ctx.executor, compiled.sql, compiled.params)) as T[];
-}
+import type { IntrospectContext } from './context.js';
+import type { SelectQueryNode } from '../../ast/query.js';
+
+import { queryRows } from './utils.js';
+
+/** A source that can provide a select query AST. */
+type SelectQuerySource = { getAST(): SelectQueryNode };
+
+/**
+ * Runs a select query from a query builder and returns the results.
+ * @param qb - The query builder.
+ * @param ctx - The introspection context.
+ * @returns The query results.
+ */
+export async function runSelect<T = Record<string, unknown>>(
+  qb: SelectQuerySource,
+  ctx: IntrospectContext
+): Promise<T[]> {
+  const ast = qb.getAST();
+  const compiled = ctx.dialect.compileSelect(ast);
+  return (await queryRows(ctx.executor, compiled.sql, compiled.params)) as T[];
+}
+
+export default runSelect;
+
+/**
+ * Runs a select query from an AST node and returns the results.
+ * @param ast - The select query AST.
+ * @param ctx - The introspection context.
+ * @returns The query results.
+ */
+export async function runSelectNode<T = Record<string, unknown>>(ast: SelectQueryNode, ctx: IntrospectContext): Promise<T[]> {
+  const compiled = ctx.dialect.compileSelect(ast);
+  return (await queryRows(ctx.executor, compiled.sql, compiled.params)) as T[];
+}

package/src/core/ddl/introspect/utils.ts

@@ -1,56 +1,56 @@
-import { DbExecutor, QueryResult } from '../../execution/db-executor.js';
-import { IntrospectOptions } from './types.js';
-
-/**
- * Converts a query result to an array of row objects.
- * @param result - The query result.
- * @returns The array of rows.
- */
-export const toRows = (result: QueryResult | undefined): Record<string, unknown>[] => {
-  if (!result) return [];
-  return result.values.map(row =>
-    result.columns.reduce<Record<string, unknown>>((acc, col, idx) => {
-      acc[col] = row[idx];
-      return acc;
-    }, {})
-  );
-};
-
-/**
- * Executes a SQL query and returns the rows.
- * @param executor - The database executor.
- * @param sql - The SQL query.
- * @param params - The query parameters.
- * @returns The array of rows.
- */
-export const queryRows = async (
-  executor: DbExecutor,
-  sql: string,
-  params: unknown[] = []
-): Promise<Record<string, unknown>[]> => {
-  const [first] = await executor.executeSql(sql, params);
-  return toRows(first);
-};
-
-/**
- * Checks if a table should be included in introspection based on options.
- * @param name - The table name.
- * @param options - The introspection options.
- * @returns True if the table should be included.
- */
-export const shouldIncludeTable = (name: string, options: IntrospectOptions): boolean => {
-  if (options.includeTables && !options.includeTables.includes(name)) return false;
-  if (options.excludeTables && options.excludeTables.includes(name)) return false;
-  return true;
-};
-
-/**
- * Checks if a view should be included in introspection based on options.
- * @param name - The view name.
- * @param options - The introspection options.
- * @returns True if the view should be included.
- */
-export const shouldIncludeView = (name: string, options: IntrospectOptions): boolean => {
-  if (options.excludeViews && options.excludeViews.includes(name)) return false;
-  return true;
-};
+import { DbExecutor, QueryResult } from '../../execution/db-executor.js';
+import { IntrospectOptions } from './types.js';
+
+/**
+ * Converts a query result to an array of row objects.
+ * @param result - The query result.
+ * @returns The array of rows.
+ */
+export const toRows = (result: QueryResult | undefined): Record<string, unknown>[] => {
+  if (!result) return [];
+  return result.values.map(row =>
+    result.columns.reduce<Record<string, unknown>>((acc, col, idx) => {
+      acc[col] = row[idx];
+      return acc;
+    }, {})
+  );
+};
+
+/**
+ * Executes a SQL query and returns the rows.
+ * @param executor - The database executor.
+ * @param sql - The SQL query.
+ * @param params - The query parameters.
+ * @returns The array of rows.
+ */
+export const queryRows = async (
+  executor: DbExecutor,
+  sql: string,
+  params: unknown[] = []
+): Promise<Record<string, unknown>[]> => {
+  const [first] = await executor.executeSql(sql, params);
+  return toRows(first);
+};
+
+/**
+ * Checks if a table should be included in introspection based on options.
+ * @param name - The table name.
+ * @param options - The introspection options.
+ * @returns True if the table should be included.
+ */
+export const shouldIncludeTable = (name: string, options: IntrospectOptions): boolean => {
+  if (options.includeTables && !options.includeTables.includes(name)) return false;
+  if (options.excludeTables && options.excludeTables.includes(name)) return false;
+  return true;
+};
+
+/**
+ * Checks if a view should be included in introspection based on options.
+ * @param name - The view name.
+ * @param options - The introspection options.
+ * @returns True if the view should be included.
+ */
+export const shouldIncludeView = (name: string, options: IntrospectOptions): boolean => {
+  if (options.excludeViews && options.excludeViews.includes(name)) return false;
+  return true;
+};