@immich/sql-tools 0.0.1 → 0.1.1

package/README.md

@@ -0,0 +1,9 @@
+# SQL Tools
+
+Kysely-based tools and utilities for managing postgres schema.
+
+## Install
+
+```bash
+npm i @immich/sql-tool
+```

package/dist/index.d.ts

@@ -14,6 +14,10 @@ export declare const AfterDeleteTrigger: (options: Omit<TriggerFunctionOptions,
 
 export declare const AfterInsertTrigger: (options: Omit<TriggerFunctionOptions, "timing" | "actions">) => ClassDecorator;
 
+export declare const asHuman: (item: SchemaDiff) => string;
+
+export declare const asSql: (item: SchemaDiff, options: SchemaDiffToSqlOptions) => string[];
+
 declare class BaseContext {
     databaseName: string;
     schemaName: string;
@@ -198,7 +202,7 @@ export declare type DatabaseIndex = {
     synchronize: boolean;
 };
 
-declare type DatabaseLike = Sql | Kysely<any>;
+export declare type DatabaseLike = Sql | Kysely<unknown>;
 
 export declare type DatabaseOptions = {
     name?: string;
@@ -859,6 +863,11 @@ export declare type SchemaDiffOptions = BaseContextOptions & {
     overrides?: IgnoreOptions;
 };
 
+/**
+ * Convert schema diff into human readable statements
+ */
+export declare const schemaDiffToHuman: (items: SchemaDiff[]) => string[];
+
 /**
  * Convert schema diffs into SQL statements
  */