hysteria-orm 10.3.6 → 10.3.8

package/lib/index.d.cts

@@ -1,8 +1,8 @@
+import * as mongodb from 'mongodb';
+import { Collection as Collection$1 } from 'mongodb';
 import { PoolAttributes, Pool, Connection, Result } from 'oracledb';
 import * as mssql from 'mssql';
 import { config, Transaction as Transaction$1, IResult } from 'mssql';
-import * as mongodb from 'mongodb';
-import { Collection as Collection$1 } from 'mongodb';
 import * as sqlite3 from 'sqlite3';
 import { RunResult } from 'sqlite3';
 import * as pg from 'pg';
@@ -113,6 +113,10 @@ interface NotNullableMysqlSqlDataSourceInput extends MysqlSqlDataSourceInput {
 }
 interface SqliteDataSourceInput extends CommonDataSourceInput {
     readonly type?: "sqlite";
+    /**
+     * @description The filename of the database file for SQLite
+     * @default ":memory:"
+     */
     readonly database?: string;
 }
 interface NotNullableSqliteDataSourceInput extends SqliteDataSourceInput {
@@ -759,6 +763,7 @@ type ForeignKeyOptions = CommonConstraintOptions & {
     onUpdate?: OnUpdateOrDelete;
 };
 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 AdminJS plugin types - All AdminJS imports are done at runtime via dynamic import()
@@ -1126,6 +1131,11 @@ type MigrationConfigBase = {
      * @default true
      */
     lock?: boolean;
+    /**
+     * @description Lock timeout in milliseconds for migration advisory lock acquisition, can be overridden in the cli command
+     * @default 30000
+     */
+    lockTimeout?: number;
 };
 /**
  * @description Migration configuration with transactional support for PostgreSQL and CockroachDB
@@ -1592,7 +1602,7 @@ declare class CreateTableBuilder extends BaseBuilder {
     constructor(sqlType: SqlDataSourceType, nodes: QueryNode[], tableName?: string, context?: "alter_table" | "create_table");
     private build;
     /**
-     * @description Adds a raw statement to an operation that will be executed as is
+     * @description Adds a raw statement to define a default value as is
      * @example
      * ```ts
      * table.varchar("name").default(table.rawStatement("CURRENT_TIMESTAMP"));
@@ -1873,6 +1883,41 @@ declare class CreateTableBuilder extends BaseBuilder {
      * ```
      */
     rawColumn(raw: string): ConstraintBuilder;
+    /**
+     * Geometry data type
+     * @mysql GEOMETRY
+     * @postgres GEOMETRY (must have PostGIS extension)
+     * @sqlite GEOMETRY must have SpatiaLite extension
+     */
+    geometry(name: string): ConstraintBuilder;
+    /**
+     * Point data type
+     * @mysql POINT
+     * @postgres POINT
+     * @sqlite POINT must have SpatiaLite extension
+     */
+    point(name: string): ConstraintBuilder;
+    /**
+     * Linestring data type
+     * @mysql LINESTRING
+     * @postgres LINESTRING
+     * @sqlite LINESTRING must have SpatiaLite extension
+     */
+    linestring(name: string): ConstraintBuilder;
+    /**
+     * Polygon data type
+     * @mysql POLYGON
+     * @postgres POLYGON
+     * @sqlite POLYGON must have SpatiaLite extension
+     */
+    polygon(name: string): ConstraintBuilder;
+    /**
+     * MultiPoint data type
+     * @mysql MULTIPOINT
+     * @postgres MULTIPOINT
+     * @sqlite MULTIPOINT must have SpatiaLite extension
+     */
+    multiPoint(name: string): ConstraintBuilder;
     getNamedConstraints(): QueryNode[];
 }
 
@@ -1881,7 +1926,7 @@ declare class AlterTableBuilder extends BaseBuilder {
     private sqlType;
     constructor(table: string, nodes: QueryNode[], sqlType: SqlDataSourceType);
     /**
-     * @description Adds a raw statement to an operation that will be executed as is
+     * @description Adds a raw statement to define a default value as is
      * @example
      * ```ts
      * table.varchar("name").default(table.rawStatement("CURRENT_TIMESTAMP"));
@@ -1982,7 +2027,7 @@ declare class Schema {
     sqlType: SqlDataSourceType;
     constructor(sqlType?: SqlDataSourceType);
     /**
-     * @description Adds a raw statement to an operation that will be executed as is
+     * @description Adds a raw statement to define a default value as is
      * @example
      * ```ts
      * schema.rawStatement("CURRENT_TIMESTAMP");
@@ -2065,6 +2110,16 @@ declare class Schema {
      * @description Drops a constraint from a table
      */
     dropConstraint(table: string, constraintName: string): void;
+    /**
+     * @description Create database extension, only supported for postgres
+     * @postgres Supports extensions like PostGIS, uuid-ossp, hstore, etc.
+     * @mysql Extensions are not supported - outputs a comment
+     * @sqlite Extensions are loaded dynamically - outputs a comment
+     * @mssql Extensions are not supported - outputs a comment
+     * @oracledb Extensions are not supported - outputs a comment
+     */
+    createExtension(extensionName: CommonPostgresExtensions, ifNotExists?: boolean): void;
+    createExtension(extensionName: string, ifNotExists?: boolean): void;
     private generateAstInstance;
 }
 
@@ -3780,6 +3835,7 @@ declare class SqlDataSource<D extends SqlDataSourceType = SqlDataSourceType, T e
         tsconfig?: string;
         lock: boolean;
         transactional: boolean;
+        lockTimeout?: number;
     };
     /**
      * @description AdminJS configuration options

package/lib/index.d.ts

@@ -1,8 +1,8 @@
+import * as mongodb from 'mongodb';
+import { Collection as Collection$1 } from 'mongodb';
 import { PoolAttributes, Pool, Connection, Result } from 'oracledb';
 import * as mssql from 'mssql';
 import { config, Transaction as Transaction$1, IResult } from 'mssql';
-import * as mongodb from 'mongodb';
-import { Collection as Collection$1 } from 'mongodb';
 import * as sqlite3 from 'sqlite3';
 import { RunResult } from 'sqlite3';
 import * as pg from 'pg';
@@ -113,6 +113,10 @@ interface NotNullableMysqlSqlDataSourceInput extends MysqlSqlDataSourceInput {
 }
 interface SqliteDataSourceInput extends CommonDataSourceInput {
     readonly type?: "sqlite";
+    /**
+     * @description The filename of the database file for SQLite
+     * @default ":memory:"
+     */
     readonly database?: string;
 }
 interface NotNullableSqliteDataSourceInput extends SqliteDataSourceInput {
@@ -759,6 +763,7 @@ type ForeignKeyOptions = CommonConstraintOptions & {
     onUpdate?: OnUpdateOrDelete;
 };
 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 AdminJS plugin types - All AdminJS imports are done at runtime via dynamic import()
@@ -1126,6 +1131,11 @@ type MigrationConfigBase = {
      * @default true
      */
     lock?: boolean;
+    /**
+     * @description Lock timeout in milliseconds for migration advisory lock acquisition, can be overridden in the cli command
+     * @default 30000
+     */
+    lockTimeout?: number;
 };
 /**
  * @description Migration configuration with transactional support for PostgreSQL and CockroachDB
@@ -1592,7 +1602,7 @@ declare class CreateTableBuilder extends BaseBuilder {
     constructor(sqlType: SqlDataSourceType, nodes: QueryNode[], tableName?: string, context?: "alter_table" | "create_table");
     private build;
     /**
-     * @description Adds a raw statement to an operation that will be executed as is
+     * @description Adds a raw statement to define a default value as is
      * @example
      * ```ts
      * table.varchar("name").default(table.rawStatement("CURRENT_TIMESTAMP"));
@@ -1873,6 +1883,41 @@ declare class CreateTableBuilder extends BaseBuilder {
      * ```
      */
     rawColumn(raw: string): ConstraintBuilder;
+    /**
+     * Geometry data type
+     * @mysql GEOMETRY
+     * @postgres GEOMETRY (must have PostGIS extension)
+     * @sqlite GEOMETRY must have SpatiaLite extension
+     */
+    geometry(name: string): ConstraintBuilder;
+    /**
+     * Point data type
+     * @mysql POINT
+     * @postgres POINT
+     * @sqlite POINT must have SpatiaLite extension
+     */
+    point(name: string): ConstraintBuilder;
+    /**
+     * Linestring data type
+     * @mysql LINESTRING
+     * @postgres LINESTRING
+     * @sqlite LINESTRING must have SpatiaLite extension
+     */
+    linestring(name: string): ConstraintBuilder;
+    /**
+     * Polygon data type
+     * @mysql POLYGON
+     * @postgres POLYGON
+     * @sqlite POLYGON must have SpatiaLite extension
+     */
+    polygon(name: string): ConstraintBuilder;
+    /**
+     * MultiPoint data type
+     * @mysql MULTIPOINT
+     * @postgres MULTIPOINT
+     * @sqlite MULTIPOINT must have SpatiaLite extension
+     */
+    multiPoint(name: string): ConstraintBuilder;
     getNamedConstraints(): QueryNode[];
 }
 
@@ -1881,7 +1926,7 @@ declare class AlterTableBuilder extends BaseBuilder {
     private sqlType;
     constructor(table: string, nodes: QueryNode[], sqlType: SqlDataSourceType);
     /**
-     * @description Adds a raw statement to an operation that will be executed as is
+     * @description Adds a raw statement to define a default value as is
      * @example
      * ```ts
      * table.varchar("name").default(table.rawStatement("CURRENT_TIMESTAMP"));
@@ -1982,7 +2027,7 @@ declare class Schema {
     sqlType: SqlDataSourceType;
     constructor(sqlType?: SqlDataSourceType);
     /**
-     * @description Adds a raw statement to an operation that will be executed as is
+     * @description Adds a raw statement to define a default value as is
      * @example
      * ```ts
      * schema.rawStatement("CURRENT_TIMESTAMP");
@@ -2065,6 +2110,16 @@ declare class Schema {
      * @description Drops a constraint from a table
      */
     dropConstraint(table: string, constraintName: string): void;
+    /**
+     * @description Create database extension, only supported for postgres
+     * @postgres Supports extensions like PostGIS, uuid-ossp, hstore, etc.
+     * @mysql Extensions are not supported - outputs a comment
+     * @sqlite Extensions are loaded dynamically - outputs a comment
+     * @mssql Extensions are not supported - outputs a comment
+     * @oracledb Extensions are not supported - outputs a comment
+     */
+    createExtension(extensionName: CommonPostgresExtensions, ifNotExists?: boolean): void;
+    createExtension(extensionName: string, ifNotExists?: boolean): void;
     private generateAstInstance;
 }
 
@@ -3780,6 +3835,7 @@ declare class SqlDataSource<D extends SqlDataSourceType = SqlDataSourceType, T e
         tsconfig?: string;
         lock: boolean;
         transactional: boolean;
+        lockTimeout?: number;
     };
     /**
      * @description AdminJS configuration options