hysteria-orm 10.5.6 → 10.5.7

package/lib/index.d.cts

@@ -764,6 +764,122 @@ type ForeignKeyOptions = CommonConstraintOptions & {
 };
 type CreateTableContext = "alter_table" | "create_table";
 type CommonPostgresExtensions = "postgis" | "uuid-ossp" | "hstore" | "pg_trgm" | "btree_gin" | "btree_gist" | "citext" | "pgcrypto" | "tablefunc" | "unaccent" | "pg_stat_statements" | "ltree" | "cube" | "earthdistance" | "fuzzystrmatch" | "intarray" | "isn" | "lo" | "pg_buffercache" | "pgrowlocks" | "pgstattuple" | "pg_freespacemap" | "postgres_fdw" | "seg" | "tsm_system_rows" | "tsm_system_time" | "plpgsql" | "plperl" | "plpython3u" | "pltcl" | "adminpack" | "amcheck" | "autoinc" | "bloom" | "dict_int" | "dict_xsyn" | "file_fdw" | "insert_username" | "intagg" | "moddatetime" | "old_snapshot" | "pageinspect" | "pg_prewarm" | "pg_surgery" | "pg_visibility" | "pgaudit" | "pglogical" | "pgrouting" | "postgis_topology" | "postgis_raster" | "postgis_sfcgal" | "postgis_tiger_geocoder" | "address_standardizer" | "address_standardizer_data_us" | "refint" | "sslinfo" | "tcn" | "timescaledb" | "vector" | "xml2";
+/**
+ * @description Common MySQL storage engines
+ * @mysql only
+ */
+type CommonMysqlEngines = "InnoDB" | "MyISAM" | "MEMORY" | "CSV" | "ARCHIVE" | "BLACKHOLE" | "NDB" | "FEDERATED";
+/**
+ * @description Common MySQL character sets
+ * @mysql only
+ * @description utf8mb4 is recommended for new projects (full UTF-8 support including emojis)
+ */
+type CommonMysqlCharsets = "utf8mb4" | "utf8" | "latin1" | "ascii" | "binary" | "utf16" | "utf32" | "ucs2";
+/**
+ * @description Common MySQL collations for utf8mb4 charset
+ * @mysql only
+ * @description utf8mb4_unicode_ci is recommended for most use cases
+ */
+type CommonMysqlUtf8mb4Collations = "utf8mb4_unicode_ci" | "utf8mb4_general_ci" | "utf8mb4_bin" | "utf8mb4_0900_ai_ci" | "utf8mb4_0900_as_ci";
+/**
+ * @description Common MySQL collations for utf8 (legacy) charset
+ * @mysql only
+ * @description Note: utf8 is deprecated, use utf8mb4 instead
+ */
+type CommonMysqlUtf8Collations = "utf8_unicode_ci" | "utf8_general_ci" | "utf8_bin";
+/**
+ * @description Common MySQL collations for latin1 charset
+ * @mysql only
+ * @description latin1_swedish_ci is the default for latin1
+ */
+type CommonMysqlLatin1Collations = "latin1_swedish_ci" | "latin1_general_ci" | "latin1_general_cs" | "latin1_bin";
+/**
+ * @description Common MySQL collations for ascii charset
+ * @mysql only
+ */
+type CommonMysqlAsciiCollations = "ascii_general_ci" | "ascii_bin";
+/**
+ * @description All common MySQL collations (all charsets)
+ * @mysql only
+ */
+type CommonMysqlCollations = CommonMysqlUtf8mb4Collations | CommonMysqlUtf8Collations | CommonMysqlLatin1Collations | CommonMysqlAsciiCollations;
+/**
+ * @description MySQL-specific table options
+ * @mysql only
+ */
+type MysqlTableOptions = {
+    engine?: CommonMysqlEngines | (string & {});
+    charset?: CommonMysqlCharsets | (string & {});
+    collate?: CommonMysqlCollations | (string & {});
+};
+/**
+ * @description Additional MySQL/MariaDB table options beyond engine/charset/collate
+ * @mysql only
+ */
+type MysqlAdvancedTableOptions = {
+    rowFormat?: "DEFAULT" | "DYNAMIC" | "COMPRESSED" | "REDUNDANT" | "COMPACT" | "FIXED";
+    autoIncrement?: number;
+    dataDirectory?: string;
+    indexDirectory?: string;
+    maxRows?: number;
+    minRows?: number;
+    checksum?: boolean;
+    encrypted?: boolean;
+    comment?: string;
+};
+/**
+ * @description PostgreSQL-specific table options
+ * @postgres only
+ */
+type PostgresTableOptions = {
+    tablespace?: string;
+    unlogged?: boolean;
+    temporary?: boolean;
+    with?: Record<string, string | number | boolean>;
+};
+/**
+ * @description SQLite-specific table options
+ * @sqlite only
+ */
+type SqliteTableOptions = {
+    strict?: boolean;
+    withoutRowId?: boolean;
+    temporary?: boolean;
+};
+/**
+ * @description MSSQL-specific table options
+ * @mssql only
+ */
+type MssqlTableOptions = {
+    onFilegroup?: string;
+    textImageOn?: string;
+    dataCompression?: "NONE" | "ROW" | "PAGE" | "COLUMNSTORE" | "COLUMNSTORE_ARCHIVE";
+};
+/**
+ * @description OracleDB-specific table options
+ * @oracledb only
+ */
+type OracledbTableOptions = {
+    tablespace?: string;
+    compress?: boolean;
+    storage?: {
+        initial?: string;
+        next?: string;
+        minextents?: number;
+        maxextents?: string;
+        pctincrease?: number;
+        pctfree?: number;
+        pctused?: number;
+    };
+    logging?: boolean;
+    cache?: boolean;
+    inMemory?: boolean;
+    compressFor?: "QUERY LOW" | "QUERY HIGH" | "ARCHIVE LOW" | "ARCHIVE HIGH";
+};
+/**
+ * @description Union type for all database-specific table options
+ */
+type DatabaseTableOptions = MysqlTableOptions | PostgresTableOptions | SqliteTableOptions | MssqlTableOptions | OracledbTableOptions | MysqlAdvancedTableOptions;
 
 type OpenApiModelType = {
     type: "object";
@@ -1401,6 +1517,7 @@ declare class ColumnTypeNode extends QueryNode {
     enumValues?: readonly string[];
     autoIncrement?: boolean;
     withTimezone?: boolean;
+    collate?: string;
     chainsWith: string;
     canKeywordBeSeenMultipleTimes: boolean;
     folder: string;
@@ -1413,6 +1530,7 @@ declare class ColumnTypeNode extends QueryNode {
         enumValues?: readonly string[];
         withTimezone?: boolean;
         autoIncrement?: boolean;
+        collate?: string;
         isRawValue?: boolean;
     });
 }
@@ -1464,6 +1582,12 @@ declare class ConstraintBuilder extends BaseBuilder {
      * @mysql only
      */
     after(columnName: string): this;
+    /**
+     * @description Sets the COLLATE for the column
+     * @mysql only
+     */
+    collate(collation: CommonMysqlCollations): this;
+    collate(collation: string): this;
     private handleSqliteAutoIncrement;
 }
 
@@ -1472,7 +1596,10 @@ declare class CreateTableBuilder extends BaseBuilder {
     private namedConstraints;
     private context;
     private sqlType;
+    private _mysqlOptions?;
     constructor(sqlType: SqlDataSourceType, nodes: QueryNode[], tableName?: string, context?: "alter_table" | "create_table");
+    mysqlOptions(options: MysqlTableOptions): this;
+    getMysqlOptions(): MysqlTableOptions | undefined;
     private build;
     /**
      * @description Adds a raw statement to define a default value as is
@@ -1957,6 +2084,74 @@ declare class AlterTableBuilder extends BaseBuilder {
      * @mssql Foreign keys referencing this primary key must be dropped first
      */
     dropPrimaryKey(table?: string): void;
+    /**
+     * @description Sets table options for ALTER TABLE
+     * @mysql Supports: engine, charset, collate, rowFormat, autoIncrement, dataDirectory, etc.
+     * @postgres Supports: tablespace, with storage parameters
+     * @sqlite Not supported for ALTER TABLE table options (most table options are CREATE TABLE only)
+     * @mssql Supports: onFilegroup, dataCompression
+     * @oracledb Supports: tablespace, compress, storage parameters
+     */
+    setTableOptions(options: MysqlTableOptions & MysqlAdvancedTableOptions): this;
+    setTableOptions(options: PostgresTableOptions): this;
+    setTableOptions(options: SqliteTableOptions): this;
+    setTableOptions(options: MssqlTableOptions): this;
+    setTableOptions(options: OracledbTableOptions): this;
+    setTableOptions(options: {
+        engine?: CommonMysqlEngines | string;
+        charset?: CommonMysqlCharsets | string;
+        collate?: CommonMysqlCollations | string;
+        rowFormat?: "DEFAULT" | "DYNAMIC" | "COMPRESSED" | "REDUNDANT" | "COMPACT" | "FIXED";
+        autoIncrement?: number;
+        dataDirectory?: string;
+        indexDirectory?: string;
+        maxRows?: number;
+        minRows?: number;
+        checksum?: boolean;
+        encrypted?: boolean;
+        comment?: string;
+    }): this;
+    setTableOptions(options: {
+        engine?: CommonMysqlEngines | string;
+        charset?: CommonMysqlCharsets | string;
+        collate?: CommonMysqlCollations | string;
+    }): this;
+    setTableOptions(options: {
+        tablespace?: string;
+        unlogged?: boolean;
+        temporary?: boolean;
+        with?: Record<string, string | number | boolean>;
+    }): this;
+    setTableOptions(options: {
+        strict?: boolean;
+        withoutRowId?: boolean;
+        temporary?: boolean;
+    }): this;
+    setTableOptions(options: {
+        onFilegroup?: string;
+        textImageOn?: string;
+        dataCompression?: "NONE" | "ROW" | "PAGE" | "COLUMNSTORE" | "COLUMNSTORE_ARCHIVE";
+    }): this;
+    setTableOptions(options: {
+        tablespace?: string;
+        compress?: boolean;
+        storage?: {
+            initial?: string;
+            next?: string;
+            minextents?: number;
+            maxextents?: string;
+            pctincrease?: number;
+            pctfree?: number;
+            pctused?: number;
+        };
+        logging?: boolean;
+        cache?: boolean;
+        inMemory?: boolean;
+        compressFor?: "QUERY LOW" | "QUERY HIGH" | "ARCHIVE LOW" | "ARCHIVE HIGH";
+    }): this;
+    setTableOptions(options: {
+        ifNotExists?: boolean;
+    } & DatabaseTableOptions): this;
 }
 
 /**
@@ -2011,7 +2206,7 @@ declare class SchemaBuilder implements PromiseLike<void> {
      */
     createTable(table: string, cb: (table: CreateTableBuilder) => void, options?: {
         ifNotExists?: boolean;
-    }): this;
+    } & DatabaseTableOptions): this;
     /**
      * @description Alter table constructor
      */
@@ -7470,7 +7665,7 @@ declare class Schema {
      */
     createTable(table: string, cb: (table: CreateTableBuilder) => void, options?: {
         ifNotExists?: boolean;
-    }): void;
+    } & DatabaseTableOptions): void;
     /**
      * @description Alter table constructor
      * @mssql Limited support - cannot modify columns with constraints; see AlterTableBuilder methods for details

package/lib/index.d.ts

@@ -764,6 +764,122 @@ type ForeignKeyOptions = CommonConstraintOptions & {
 };
 type CreateTableContext = "alter_table" | "create_table";
 type CommonPostgresExtensions = "postgis" | "uuid-ossp" | "hstore" | "pg_trgm" | "btree_gin" | "btree_gist" | "citext" | "pgcrypto" | "tablefunc" | "unaccent" | "pg_stat_statements" | "ltree" | "cube" | "earthdistance" | "fuzzystrmatch" | "intarray" | "isn" | "lo" | "pg_buffercache" | "pgrowlocks" | "pgstattuple" | "pg_freespacemap" | "postgres_fdw" | "seg" | "tsm_system_rows" | "tsm_system_time" | "plpgsql" | "plperl" | "plpython3u" | "pltcl" | "adminpack" | "amcheck" | "autoinc" | "bloom" | "dict_int" | "dict_xsyn" | "file_fdw" | "insert_username" | "intagg" | "moddatetime" | "old_snapshot" | "pageinspect" | "pg_prewarm" | "pg_surgery" | "pg_visibility" | "pgaudit" | "pglogical" | "pgrouting" | "postgis_topology" | "postgis_raster" | "postgis_sfcgal" | "postgis_tiger_geocoder" | "address_standardizer" | "address_standardizer_data_us" | "refint" | "sslinfo" | "tcn" | "timescaledb" | "vector" | "xml2";
+/**
+ * @description Common MySQL storage engines
+ * @mysql only
+ */
+type CommonMysqlEngines = "InnoDB" | "MyISAM" | "MEMORY" | "CSV" | "ARCHIVE" | "BLACKHOLE" | "NDB" | "FEDERATED";
+/**
+ * @description Common MySQL character sets
+ * @mysql only
+ * @description utf8mb4 is recommended for new projects (full UTF-8 support including emojis)
+ */
+type CommonMysqlCharsets = "utf8mb4" | "utf8" | "latin1" | "ascii" | "binary" | "utf16" | "utf32" | "ucs2";
+/**
+ * @description Common MySQL collations for utf8mb4 charset
+ * @mysql only
+ * @description utf8mb4_unicode_ci is recommended for most use cases
+ */
+type CommonMysqlUtf8mb4Collations = "utf8mb4_unicode_ci" | "utf8mb4_general_ci" | "utf8mb4_bin" | "utf8mb4_0900_ai_ci" | "utf8mb4_0900_as_ci";
+/**
+ * @description Common MySQL collations for utf8 (legacy) charset
+ * @mysql only
+ * @description Note: utf8 is deprecated, use utf8mb4 instead
+ */
+type CommonMysqlUtf8Collations = "utf8_unicode_ci" | "utf8_general_ci" | "utf8_bin";
+/**
+ * @description Common MySQL collations for latin1 charset
+ * @mysql only
+ * @description latin1_swedish_ci is the default for latin1
+ */
+type CommonMysqlLatin1Collations = "latin1_swedish_ci" | "latin1_general_ci" | "latin1_general_cs" | "latin1_bin";
+/**
+ * @description Common MySQL collations for ascii charset
+ * @mysql only
+ */
+type CommonMysqlAsciiCollations = "ascii_general_ci" | "ascii_bin";
+/**
+ * @description All common MySQL collations (all charsets)
+ * @mysql only
+ */
+type CommonMysqlCollations = CommonMysqlUtf8mb4Collations | CommonMysqlUtf8Collations | CommonMysqlLatin1Collations | CommonMysqlAsciiCollations;
+/**
+ * @description MySQL-specific table options
+ * @mysql only
+ */
+type MysqlTableOptions = {
+    engine?: CommonMysqlEngines | (string & {});
+    charset?: CommonMysqlCharsets | (string & {});
+    collate?: CommonMysqlCollations | (string & {});
+};
+/**
+ * @description Additional MySQL/MariaDB table options beyond engine/charset/collate
+ * @mysql only
+ */
+type MysqlAdvancedTableOptions = {
+    rowFormat?: "DEFAULT" | "DYNAMIC" | "COMPRESSED" | "REDUNDANT" | "COMPACT" | "FIXED";
+    autoIncrement?: number;
+    dataDirectory?: string;
+    indexDirectory?: string;
+    maxRows?: number;
+    minRows?: number;
+    checksum?: boolean;
+    encrypted?: boolean;
+    comment?: string;
+};
+/**
+ * @description PostgreSQL-specific table options
+ * @postgres only
+ */
+type PostgresTableOptions = {
+    tablespace?: string;
+    unlogged?: boolean;
+    temporary?: boolean;
+    with?: Record<string, string | number | boolean>;
+};
+/**
+ * @description SQLite-specific table options
+ * @sqlite only
+ */
+type SqliteTableOptions = {
+    strict?: boolean;
+    withoutRowId?: boolean;
+    temporary?: boolean;
+};
+/**
+ * @description MSSQL-specific table options
+ * @mssql only
+ */
+type MssqlTableOptions = {
+    onFilegroup?: string;
+    textImageOn?: string;
+    dataCompression?: "NONE" | "ROW" | "PAGE" | "COLUMNSTORE" | "COLUMNSTORE_ARCHIVE";
+};
+/**
+ * @description OracleDB-specific table options
+ * @oracledb only
+ */
+type OracledbTableOptions = {
+    tablespace?: string;
+    compress?: boolean;
+    storage?: {
+        initial?: string;
+        next?: string;
+        minextents?: number;
+        maxextents?: string;
+        pctincrease?: number;
+        pctfree?: number;
+        pctused?: number;
+    };
+    logging?: boolean;
+    cache?: boolean;
+    inMemory?: boolean;
+    compressFor?: "QUERY LOW" | "QUERY HIGH" | "ARCHIVE LOW" | "ARCHIVE HIGH";
+};
+/**
+ * @description Union type for all database-specific table options
+ */
+type DatabaseTableOptions = MysqlTableOptions | PostgresTableOptions | SqliteTableOptions | MssqlTableOptions | OracledbTableOptions | MysqlAdvancedTableOptions;
 
 type OpenApiModelType = {
     type: "object";
@@ -1401,6 +1517,7 @@ declare class ColumnTypeNode extends QueryNode {
     enumValues?: readonly string[];
     autoIncrement?: boolean;
     withTimezone?: boolean;
+    collate?: string;
     chainsWith: string;
     canKeywordBeSeenMultipleTimes: boolean;
     folder: string;
@@ -1413,6 +1530,7 @@ declare class ColumnTypeNode extends QueryNode {
         enumValues?: readonly string[];
         withTimezone?: boolean;
         autoIncrement?: boolean;
+        collate?: string;
         isRawValue?: boolean;
     });
 }
@@ -1464,6 +1582,12 @@ declare class ConstraintBuilder extends BaseBuilder {
      * @mysql only
      */
     after(columnName: string): this;
+    /**
+     * @description Sets the COLLATE for the column
+     * @mysql only
+     */
+    collate(collation: CommonMysqlCollations): this;
+    collate(collation: string): this;
     private handleSqliteAutoIncrement;
 }
 
@@ -1472,7 +1596,10 @@ declare class CreateTableBuilder extends BaseBuilder {
     private namedConstraints;
     private context;
     private sqlType;
+    private _mysqlOptions?;
     constructor(sqlType: SqlDataSourceType, nodes: QueryNode[], tableName?: string, context?: "alter_table" | "create_table");
+    mysqlOptions(options: MysqlTableOptions): this;
+    getMysqlOptions(): MysqlTableOptions | undefined;
     private build;
     /**
      * @description Adds a raw statement to define a default value as is
@@ -1957,6 +2084,74 @@ declare class AlterTableBuilder extends BaseBuilder {
      * @mssql Foreign keys referencing this primary key must be dropped first
      */
     dropPrimaryKey(table?: string): void;
+    /**
+     * @description Sets table options for ALTER TABLE
+     * @mysql Supports: engine, charset, collate, rowFormat, autoIncrement, dataDirectory, etc.
+     * @postgres Supports: tablespace, with storage parameters
+     * @sqlite Not supported for ALTER TABLE table options (most table options are CREATE TABLE only)
+     * @mssql Supports: onFilegroup, dataCompression
+     * @oracledb Supports: tablespace, compress, storage parameters
+     */
+    setTableOptions(options: MysqlTableOptions & MysqlAdvancedTableOptions): this;
+    setTableOptions(options: PostgresTableOptions): this;
+    setTableOptions(options: SqliteTableOptions): this;
+    setTableOptions(options: MssqlTableOptions): this;
+    setTableOptions(options: OracledbTableOptions): this;
+    setTableOptions(options: {
+        engine?: CommonMysqlEngines | string;
+        charset?: CommonMysqlCharsets | string;
+        collate?: CommonMysqlCollations | string;
+        rowFormat?: "DEFAULT" | "DYNAMIC" | "COMPRESSED" | "REDUNDANT" | "COMPACT" | "FIXED";
+        autoIncrement?: number;
+        dataDirectory?: string;
+        indexDirectory?: string;
+        maxRows?: number;
+        minRows?: number;
+        checksum?: boolean;
+        encrypted?: boolean;
+        comment?: string;
+    }): this;
+    setTableOptions(options: {
+        engine?: CommonMysqlEngines | string;
+        charset?: CommonMysqlCharsets | string;
+        collate?: CommonMysqlCollations | string;
+    }): this;
+    setTableOptions(options: {
+        tablespace?: string;
+        unlogged?: boolean;
+        temporary?: boolean;
+        with?: Record<string, string | number | boolean>;
+    }): this;
+    setTableOptions(options: {
+        strict?: boolean;
+        withoutRowId?: boolean;
+        temporary?: boolean;
+    }): this;
+    setTableOptions(options: {
+        onFilegroup?: string;
+        textImageOn?: string;
+        dataCompression?: "NONE" | "ROW" | "PAGE" | "COLUMNSTORE" | "COLUMNSTORE_ARCHIVE";
+    }): this;
+    setTableOptions(options: {
+        tablespace?: string;
+        compress?: boolean;
+        storage?: {
+            initial?: string;
+            next?: string;
+            minextents?: number;
+            maxextents?: string;
+            pctincrease?: number;
+            pctfree?: number;
+            pctused?: number;
+        };
+        logging?: boolean;
+        cache?: boolean;
+        inMemory?: boolean;
+        compressFor?: "QUERY LOW" | "QUERY HIGH" | "ARCHIVE LOW" | "ARCHIVE HIGH";
+    }): this;
+    setTableOptions(options: {
+        ifNotExists?: boolean;
+    } & DatabaseTableOptions): this;
 }
 
 /**
@@ -2011,7 +2206,7 @@ declare class SchemaBuilder implements PromiseLike<void> {
      */
     createTable(table: string, cb: (table: CreateTableBuilder) => void, options?: {
         ifNotExists?: boolean;
-    }): this;
+    } & DatabaseTableOptions): this;
     /**
      * @description Alter table constructor
      */
@@ -7470,7 +7665,7 @@ declare class Schema {
      */
     createTable(table: string, cb: (table: CreateTableBuilder) => void, options?: {
         ifNotExists?: boolean;
-    }): void;
+    } & DatabaseTableOptions): void;
     /**
      * @description Alter table constructor
      * @mssql Limited support - cannot modify columns with constraints; see AlterTableBuilder methods for details