metal-orm 1.1.10 → 1.1.16

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

package/src/core/ddl/naming-strategy.ts

@@ -1,16 +1,16 @@
-import type { TableDef, IndexDef } from '../../schema/table.js';
-
-/**
- * Derives the name for an index based on the table and index definition.
- * @param table - The table definition.
- * @param index - The index definition.
- * @returns The derived index name.
- */
-export const deriveIndexName = (table: TableDef, index: IndexDef): string => {
-  const base = (index.columns ?? [])
-    .map(col => (typeof col === 'string' ? col : col.column))
-    .join('_');
-
-  const suffix = index.unique ? 'uniq' : 'idx';
-  return `${table.name}_${base}_${suffix}`;
-};
+import type { TableDef, IndexDef } from '../../schema/table.js';
+
+/**
+ * Derives the name for an index based on the table and index definition.
+ * @param table - The table definition.
+ * @param index - The index definition.
+ * @returns The derived index name.
+ */
+export const deriveIndexName = (table: TableDef, index: IndexDef): string => {
+  const base = (index.columns ?? [])
+    .map(col => (typeof col === 'string' ? col : col.column))
+    .join('_');
+
+  const suffix = index.unique ? 'uniq' : 'idx';
+  return `${table.name}_${base}_${suffix}`;
+};

package/src/core/ddl/schema-dialect.ts

@@ -1,56 +1,56 @@
-import type { TableDef, IndexDef } from '../../schema/table.js';
-import type { ColumnDef, ForeignKeyReference } from '../../schema/column-types.js';
-import type { DatabaseTable, DatabaseColumn, ColumnDiff } from './schema-types.js';
-
-/** The name of a database dialect. */
-export type DialectName =
-  | 'postgres'
-  | 'mysql'
-  | 'sqlite'
-  | 'mssql'
-  | (string & {});
-
-/** Interface for schema dialect implementations that handle database-specific DDL operations. */
-export interface SchemaDialect {
-  /** The name of the dialect. */
-  readonly name: DialectName;
-
-  /** Quotes an identifier for use in SQL. */
-  quoteIdentifier(id: string): string;
-
-  /** Formats the table name for SQL. */
-  formatTableName(table: TableDef | DatabaseTable): string;
-
-  /** Renders the column type for SQL. */
-  renderColumnType(column: ColumnDef): string;
-  /** Renders the default value for SQL. */
-  renderDefault(value: unknown, column: ColumnDef): string;
-  /** Renders the auto-increment clause for SQL. */
-  renderAutoIncrement(column: ColumnDef, table: TableDef): string | undefined;
-
-  /** Renders a foreign key reference for SQL. */
-  renderReference(ref: ForeignKeyReference, table: TableDef): string;
-  /** Renders an index for SQL. */
-  renderIndex(table: TableDef, index: IndexDef): string;
-  /** Renders table options for SQL. */
-  renderTableOptions(table: TableDef): string | undefined;
-
-  /** Checks if the dialect supports partial indexes. */
-  supportsPartialIndexes(): boolean;
-  /** Checks if the dialect prefers inline primary key auto-increment. */
-  preferInlinePkAutoincrement(column: ColumnDef, table: TableDef, pk: string[]): boolean;
-
-  /** Generates SQL to drop a column. */
-  dropColumnSql?(table: DatabaseTable, column: string): string[];
-  /** Generates SQL to drop an index. */
-  dropIndexSql?(table: DatabaseTable, index: string): string[];
-  /** Generates SQL to drop a table. */
-  dropTableSql?(table: DatabaseTable): string[];
-  /** Returns a warning message for dropping a column. */
-  warnDropColumn?(table: DatabaseTable, column: string): string | undefined;
-  /** Generates SQL to alter a column. */
-  alterColumnSql?(table: TableDef, column: ColumnDef, actualColumn: DatabaseColumn, diff: ColumnDiff): string[];
-  /** Returns a warning message for altering a column. */
-  warnAlterColumn?(table: TableDef, column: ColumnDef, actualColumn: DatabaseColumn, diff: ColumnDiff): string | undefined;
-}
-
+import type { TableDef, IndexDef } from '../../schema/table.js';
+import type { ColumnDef, ForeignKeyReference } from '../../schema/column-types.js';
+import type { DatabaseTable, DatabaseColumn, ColumnDiff } from './schema-types.js';
+
+/** The name of a database dialect. */
+export type DialectName =
+  | 'postgres'
+  | 'mysql'
+  | 'sqlite'
+  | 'mssql'
+  | (string & {});
+
+/** Interface for schema dialect implementations that handle database-specific DDL operations. */
+export interface SchemaDialect {
+  /** The name of the dialect. */
+  readonly name: DialectName;
+
+  /** Quotes an identifier for use in SQL. */
+  quoteIdentifier(id: string): string;
+
+  /** Formats the table name for SQL. */
+  formatTableName(table: TableDef | DatabaseTable): string;
+
+  /** Renders the column type for SQL. */
+  renderColumnType(column: ColumnDef): string;
+  /** Renders the default value for SQL. */
+  renderDefault(value: unknown, column: ColumnDef): string;
+  /** Renders the auto-increment clause for SQL. */
+  renderAutoIncrement(column: ColumnDef, table: TableDef): string | undefined;
+
+  /** Renders a foreign key reference for SQL. */
+  renderReference(ref: ForeignKeyReference, table: TableDef): string;
+  /** Renders an index for SQL. */
+  renderIndex(table: TableDef, index: IndexDef): string;
+  /** Renders table options for SQL. */
+  renderTableOptions(table: TableDef): string | undefined;
+
+  /** Checks if the dialect supports partial indexes. */
+  supportsPartialIndexes(): boolean;
+  /** Checks if the dialect prefers inline primary key auto-increment. */
+  preferInlinePkAutoincrement(column: ColumnDef, table: TableDef, pk: string[]): boolean;
+
+  /** Generates SQL to drop a column. */
+  dropColumnSql?(table: DatabaseTable, column: string): string[];
+  /** Generates SQL to drop an index. */
+  dropIndexSql?(table: DatabaseTable, index: string): string[];
+  /** Generates SQL to drop a table. */
+  dropTableSql?(table: DatabaseTable): string[];
+  /** Returns a warning message for dropping a column. */
+  warnDropColumn?(table: DatabaseTable, column: string): string | undefined;
+  /** Generates SQL to alter a column. */
+  alterColumnSql?(table: TableDef, column: ColumnDef, actualColumn: DatabaseColumn, diff: ColumnDiff): string[];
+  /** Returns a warning message for altering a column. */
+  warnAlterColumn?(table: TableDef, column: ColumnDef, actualColumn: DatabaseColumn, diff: ColumnDiff): string | undefined;
+}
+