metal-orm 1.0.55 → 1.0.57

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

@@ -3,6 +3,7 @@ import { col } from '../../../../schema/column-types.js';
 
 const INFORMATION_SCHEMA = 'information_schema';
 
+/** Table definition for `information_schema.tables`. */
 export const InformationSchemaTables = defineTable(
   'tables',
   {
@@ -15,6 +16,7 @@ export const InformationSchemaTables = defineTable(
   { schema: INFORMATION_SCHEMA }
 );
 
+/** Table definition for `information_schema.columns`. */
 export const InformationSchemaColumns = defineTable(
   'columns',
   {
@@ -34,6 +36,7 @@ export const InformationSchemaColumns = defineTable(
   { schema: INFORMATION_SCHEMA }
 );
 
+/** Table definition for `information_schema.key_column_usage`. */
 export const InformationSchemaKeyColumnUsage = defineTable(
   'key_column_usage',
   {
@@ -52,6 +55,7 @@ export const InformationSchemaKeyColumnUsage = defineTable(
   { schema: INFORMATION_SCHEMA }
 );
 
+/** Table definition for `information_schema.referential_constraints`. */
 export const InformationSchemaReferentialConstraints = defineTable(
   'referential_constraints',
   {
@@ -65,6 +69,7 @@ export const InformationSchemaReferentialConstraints = defineTable(
   { schema: INFORMATION_SCHEMA }
 );
 
+/** Table definition for `information_schema.statistics`. */
 export const InformationSchemaStatistics = defineTable(
   'statistics',
   {

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

@@ -3,6 +3,7 @@ import { col } from '../../../../schema/column-types.js';
 
 // SQLite catalogs are limited; most metadata comes from PRAGMAs, but these tables are queryable.
 
+/** Table definition for the `sqlite_master` system table. */
 export const SqliteMaster = defineTable(
   'sqlite_master',
   {
@@ -17,6 +18,7 @@ export const SqliteMaster = defineTable(
   { schema: undefined }
 );
 
+/** Table definition for the `sqlite_sequence` system table, used for autoincrement tracking. */
 export const SqliteSequence = defineTable(
   'sqlite_sequence',
   {
@@ -28,6 +30,7 @@ export const SqliteSequence = defineTable(
   { schema: undefined }
 );
 
+/** Table definition for the `sqlite_stat1` system table, used for query planner statistics. */
 export const SqliteStat1 = defineTable(
   'sqlite_stat1',
   {

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

@@ -29,8 +29,21 @@ const fn = (name: string, args: OperandInput[]): OperandNode => ({
 const CHAR_TYPES = ['varchar', 'char', 'varbinary', 'binary', 'nvarchar', 'nchar'];
 const DECIMAL_TYPES = ['decimal', 'numeric'];
 
+/**
+ * Returns an expression that calls OBJECT_DEFINITION for the given object ID.
+ * Used to retrieve the source text of views, procedures, etc.
+ */
 export const objectDefinition = (objectId: OperandInput): OperandNode => fn('OBJECT_DEFINITION', [objectId]);
 
+/**
+ * Builds a SQL Server data type string representation from its components.
+ * 
+ * @param typeName The base type name.
+ * @param maxLength The maximum length for char/binary types.
+ * @param precision The precision for decimal/numeric types.
+ * @param scale The scale for decimal/numeric types.
+ * @returns An expression that evaluates to the full data type string.
+ */
 export const buildMssqlDataType = (
   typeName: OperandInput,
   maxLength: OperandInput,

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

@@ -116,6 +116,10 @@ const combineConditions = (...expressions: (ExpressionNode | undefined)[]): Expr
   return and(...filtered);
 };
 
+/**
+ * Schema introspector for Microsoft SQL Server.
+ * Queryies system catalogs (sys.tables, sys.columns, etc.) to extract schema metadata.
+ */
 export const mssqlIntrospector: SchemaIntrospector = {
   async introspect(ctx: IntrospectContext, options: IntrospectOptions): Promise<DatabaseSchema> {
     const schema = options.schema;

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

@@ -98,6 +98,10 @@ const databaseFunction: FunctionNode = {
   args: []
 };
 
+/**
+ * Schema introspector for MySQL.
+ * Queries information_schema tables to extract schema metadata.
+ */
 export const mysqlIntrospector: SchemaIntrospector = {
   async introspect(ctx: IntrospectContext, options: IntrospectOptions): Promise<DatabaseSchema> {
     const schema = options.schema;

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

@@ -141,6 +141,10 @@ const loadSqliteSchemaComments = async (ctx: IntrospectContext) => {
   };
 };
 
+/**
+ * Schema introspector for SQLite.
+ * Uses PRAGMA commands and sqlite_master to extract schema metadata.
+ */
 export const sqliteIntrospector: SchemaIntrospector = {
   async introspect(ctx: IntrospectContext, options: IntrospectOptions): Promise<DatabaseSchema> {
     const alias = 'sqlite_master';