@immich/sql-tools 0.1.1 → 0.2.0

package/dist/index.d.ts

@@ -1,6 +1,8 @@
 import { ColumnType as ColumnType_2 } from 'kysely';
+import { default as default_2 } from 'postgres';
 import { Kysely } from 'kysely';
-import { Sql } from 'postgres';
+import { Notice } from 'postgres';
+import { SSLConfig } from 'pg-connection-string';
 
 export declare enum ActionType {
     NO_ACTION = "NO ACTION",
@@ -16,6 +18,15 @@ export declare const AfterInsertTrigger: (options: Omit<TriggerFunctionOptions,
 
 export declare const asHuman: (item: SchemaDiff) => string;
 
+export declare const asPostgresConfig: (params: DatabaseConnectionParams) => {
+    host: string | undefined;
+    port: number | undefined;
+    username: string | undefined;
+    password: string | undefined;
+    database: string | undefined;
+    ssl: PostgresSsl | undefined;
+};
+
 export declare const asSql: (item: SchemaDiff, options: SchemaDiffToSqlOptions) => string[];
 
 declare class BaseContext {
@@ -130,6 +141,8 @@ export declare enum ConstraintType {
 
 export declare const CreateDateColumn: (options?: ColumnOptions) => PropertyDecorator;
 
+export declare const createPostgres: (options?: DatabasePostgresOptions) => default_2.Sql<{}>;
+
 export declare const Database: (options: DatabaseOptions) => ClassDecorator;
 
 export declare type DatabaseCheckConstraint = {
@@ -160,6 +173,23 @@ export declare type DatabaseColumn = {
     numericScale?: number;
 };
 
+export declare type DatabaseConnectionParams = DatabaseConnectionURL | DatabaseConnectionParts;
+
+export declare type DatabaseConnectionParts = {
+    connectionType: 'parts';
+    host: string;
+    port: number;
+    username: string;
+    password: string;
+    database: string;
+    ssl?: DatabaseSslMode;
+};
+
+export declare type DatabaseConnectionURL = {
+    connectionType: 'url';
+    url: string;
+};
+
 export declare type DatabaseConstraint = DatabasePrimaryKeyConstraint | DatabaseForeignKeyConstraint | DatabaseUniqueConstraint | DatabaseCheckConstraint;
 
 export declare type DatabaseEnum = {
@@ -202,8 +232,6 @@ export declare type DatabaseIndex = {
     synchronize: boolean;
 };
 
-export declare type DatabaseLike = Sql | Kysely<unknown>;
-
 export declare type DatabaseOptions = {
     name?: string;
     synchronize?: boolean;
@@ -227,6 +255,16 @@ export declare type DatabaseParameter = {
     synchronize: boolean;
 };
 
+export declare type DatabasePostgresOptions = {
+    connection?: DatabaseConnectionParams;
+    maxConnections?: number;
+    timeZone?: string;
+    convertToJsDate?: boolean;
+    convertBigIntToNumber?: boolean;
+    onNotice?: (notice: Notice) => void;
+    onClose?: (connectionId: number) => void;
+};
+
 export declare type DatabasePrimaryKeyConstraint = ColumBasedConstraint & {
     type: ConstraintType.PRIMARY_KEY;
     synchronize: boolean;
@@ -244,6 +282,14 @@ export declare type DatabaseSchema = {
     warnings: string[];
 };
 
+export declare enum DatabaseSslMode {
+    Disable = "disable",
+    Allow = "allow",
+    Prefer = "prefer",
+    Require = "require",
+    VerifyFull = "verify-full"
+}
+
 export declare type DatabaseTable = {
     name: string;
     columns: DatabaseColumn[];
@@ -371,6 +417,8 @@ export declare type IndexOptions = {
 
 export declare type Int8 = ColumnType_2<number>;
 
+export declare const isPostgresSsl: (ssl?: string | boolean | object) => ssl is PostgresSsl;
+
 export declare interface NamingInterface {
     getName(item: NamingItem): string;
 }
@@ -639,6 +687,8 @@ export declare type PostgresDB = {
     };
 };
 
+export declare type PostgresSsl = 'require' | 'allow' | 'prefer' | 'verify-full' | boolean | SSLConfig;
+
 declare type PostgresYesOrNo = 'YES' | 'NO';
 
 export declare const PrimaryColumn: (options?: Omit<ColumnOptions, "primary">) => PropertyDecorator;
@@ -895,9 +945,9 @@ export declare type SchemaFromCodeOptions = BaseContextOptions & {
 /**
  * Load schema from a database url
  */
-export declare const schemaFromDatabase: (database: DatabaseLike, options?: SchemaFromDatabaseOptions) => Promise<DatabaseSchema>;
+export declare const schemaFromDatabase: (options?: SchemaFromDatabaseOptions) => Promise<DatabaseSchema>;
 
-export declare type SchemaFromDatabaseOptions = BaseContextOptions;
+export declare type SchemaFromDatabaseOptions = BaseContextOptions & DatabasePostgresOptions;
 
 /** Table comments here */
 export declare const Table: (options?: string | TableOptions) => ClassDecorator;