rake-db 2.3.25 → 2.3.26

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # rake-db
 
+## 2.3.26
+
+### Patch Changes
+
+- Add createEnum and dropEnum to rake-db
+- Updated dependencies
+  - pqb@0.9.15
+
 ## 2.3.25
 
 ### Patch Changes

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as pqb from 'pqb';
-import { EmptyObject, RawExpression, ColumnType, ColumnTypes, raw, ColumnsShape, DbResult, DefaultColumnTypes, TransactionAdapter, AdapterOptions, TextColumn, MaybeArray, IndexColumnOptions, IndexOptions, ForeignKeyOptions, QueryLogObject, NoPrimaryKeyOption, TableData, SingleColumnIndexOptions, QueryLogOptions } from 'pqb';
+import { EmptyObject, RawExpression, ColumnType, ColumnTypes, EnumColumn, raw, ColumnsShape, DbResult, DefaultColumnTypes, TransactionAdapter, AdapterOptions, TextColumn, MaybeArray, IndexColumnOptions, IndexOptions, ForeignKeyOptions, QueryLogObject, NoPrimaryKeyOption, TableData, SingleColumnIndexOptions, QueryLogOptions } from 'pqb';
 
 declare function add(item: ColumnType, options?: {
     dropMode?: DropMode;
@@ -35,9 +35,10 @@ declare type TableOptions = {
     noPrimaryKey?: boolean;
 };
 declare type TextColumnCreator = () => TextColumn;
-declare type MigrationColumnTypes = Omit<ColumnTypes, 'text' | 'string'> & {
+declare type MigrationColumnTypes = Omit<ColumnTypes, 'text' | 'string' | 'enum'> & {
     text: TextColumnCreator;
     string: TextColumnCreator;
+    enum: (name: string) => EnumColumn;
 };
 declare type ColumnsShapeCallback = (t: MigrationColumnTypes & {
     raw: typeof raw;
@@ -55,11 +56,6 @@ declare type JoinTableOptions = {
     comment?: string;
     dropMode?: DropMode;
 };
-declare type ExtensionOptions = {
-    schema?: string;
-    version?: string;
-    cascade?: boolean;
-};
 declare type Migration = DbResult<DefaultColumnTypes> & MigrationBase;
 declare const createMigrationInterface: (tx: TransactionAdapter, up: boolean, options: RakeDbConfig, adapterOptions: AdapterOptions, appCodeUpdaterCache: object) => pqb.Db<string, Record<string, never>, pqb.RelationsBase, {
     smallint: () => pqb.SmallIntColumn;
@@ -85,7 +81,7 @@ declare const createMigrationInterface: (tx: TransactionAdapter, up: boolean, op
     timeWithTimeZone: <Precision_5 extends number | undefined = undefined>(precision?: Precision_5 | undefined) => pqb.TimeWithTimeZoneColumn<Precision_5>;
     interval: <Fields extends string | undefined = undefined, Precision_6 extends number | undefined = undefined>(fields?: Fields | undefined, precision?: Precision_6 | undefined) => pqb.IntervalColumn<Fields, Precision_6>;
     boolean: () => pqb.BooleanColumn;
-    enum: <U extends string, T extends [U, ...U[]]>(dataType: string, type: T) => pqb.EnumColumn<U, T>;
+    enum: <U extends string, T extends [U, ...U[]]>(dataType: string, type: T) => EnumColumn<U, T>;
     point: () => pqb.PointColumn;
     line: () => pqb.LineColumn;
     lseg: () => pqb.LsegColumn;
@@ -184,7 +180,7 @@ declare const createMigrationInterface: (tx: TransactionAdapter, up: boolean, op
         timeWithTimeZone: <Precision_5 extends number | undefined = undefined>(precision?: Precision_5 | undefined) => pqb.TimeWithTimeZoneColumn<Precision_5>;
         interval: <Fields extends string | undefined = undefined, Precision_6 extends number | undefined = undefined>(fields?: Fields | undefined, precision?: Precision_6 | undefined) => pqb.IntervalColumn<Fields, Precision_6>;
         boolean: () => pqb.BooleanColumn;
-        enum: <U extends string, T extends [U, ...U[]]>(dataType: string, type: T) => pqb.EnumColumn<U, T>;
+        enum: <U extends string, T extends [U, ...U[]]>(dataType: string, type: T) => EnumColumn<U, T>;
         point: () => pqb.PointColumn;
         line: () => pqb.LineColumn;
         lseg: () => pqb.LsegColumn;
@@ -282,7 +278,7 @@ declare const createMigrationInterface: (tx: TransactionAdapter, up: boolean, op
         timeWithTimeZone: <Precision_5 extends number | undefined = undefined>(precision?: Precision_5 | undefined) => pqb.TimeWithTimeZoneColumn<Precision_5>;
         interval: <Fields extends string | undefined = undefined, Precision_6 extends number | undefined = undefined>(fields?: Fields | undefined, precision?: Precision_6 | undefined) => pqb.IntervalColumn<Fields, Precision_6>;
         boolean: () => pqb.BooleanColumn;
-        enum: <U extends string, T extends [U, ...U[]]>(dataType: string, type: T) => pqb.EnumColumn<U, T>;
+        enum: <U extends string, T extends [U, ...U[]]>(dataType: string, type: T) => EnumColumn<U, T>;
         point: () => pqb.PointColumn;
         line: () => pqb.LineColumn;
         lseg: () => pqb.LsegColumn;
@@ -396,20 +392,17 @@ declare class MigrationBase {
     renameColumn(tableName: string, from: string, to: string): Promise<void>;
     createSchema(schemaName: string): Promise<void>;
     dropSchema(schemaName: string): Promise<void>;
-    createExtension(name: string, options?: ExtensionOptions & {
-        ifNotExists?: boolean;
-    }): Promise<void>;
-    dropExtension(name: string, options?: {
-        ifExists?: boolean;
-        cascade?: boolean;
-    }): Promise<void>;
+    createExtension(name: string, options?: Omit<RakeDbAst.Extension, 'type' | 'action' | 'name'>): Promise<void>;
+    dropExtension(name: string, options?: Omit<RakeDbAst.Extension, 'type' | 'action' | 'name' | 'values'>): Promise<void>;
+    createEnum(name: string, values: string[], options?: Omit<RakeDbAst.Enum, 'type' | 'action' | 'name' | 'values'>): Promise<void>;
+    dropEnum(name: string, values: string[], options?: Omit<RakeDbAst.Enum, 'type' | 'action' | 'name' | 'values'>): Promise<void>;
     tableExists(tableName: string): Promise<boolean>;
     columnExists(tableName: string, columnName: string): Promise<boolean>;
     constraintExists(constraintName: string): Promise<boolean>;
 }
 declare const runCodeUpdater: (migration: MigrationBase, ast: RakeDbAst) => Promise<void> | undefined;
 
-declare type RakeDbAst = RakeDbAst.Table | RakeDbAst.ChangeTable | RakeDbAst.RenameTable | RakeDbAst.Schema | RakeDbAst.Extension | RakeDbAst.ForeignKey;
+declare type RakeDbAst = RakeDbAst.Table | RakeDbAst.ChangeTable | RakeDbAst.RenameTable | RakeDbAst.Schema | RakeDbAst.Extension | RakeDbAst.Enum | RakeDbAst.ForeignKey;
 declare namespace RakeDbAst {
     type Table = {
         type: 'table';
@@ -482,8 +475,21 @@ declare namespace RakeDbAst {
         schema?: string;
         version?: string;
         cascade?: boolean;
-        ifExists?: boolean;
-        ifNotExists?: boolean;
+        createIfNotExists?: boolean;
+        dropIfExists?: boolean;
+    };
+    type Enum = {
+        type: 'enum';
+        action: 'create' | 'drop';
+        schema?: string;
+        name: string;
+        values: string[];
+        cascade?: boolean;
+        dropIfExists?: boolean;
+    };
+    type EnumOptions = {
+        createIfNotExists?: boolean;
+        dropIfExists?: boolean;
     };
     type ForeignKey = {
         type: 'foreignKey';
@@ -530,4 +536,4 @@ declare const change: (fn: ChangeCallback) => void;
 
 declare const rakeDb: (options: MaybeArray<AdapterOptions>, partialConfig?: Partial<RakeDbConfig>, args?: string[]) => Promise<void>;
 
-export { AppCodeUpdater, ChangeTableCallback, ChangeTableOptions, ColumnComment, ColumnsShapeCallback, DropMode, ExtensionOptions, JoinTableOptions, Migration, MigrationBase, MigrationColumnTypes, RakeDbAst, RakeDbConfig, TableOptions, change, createDb, createMigrationInterface, dropDb, generate, migrate, rakeDb, resetDb, rollback, runCodeUpdater, writeMigrationFile };
+export { AppCodeUpdater, ChangeTableCallback, ChangeTableOptions, ColumnComment, ColumnsShapeCallback, DropMode, JoinTableOptions, Migration, MigrationBase, MigrationColumnTypes, RakeDbAst, RakeDbConfig, TableOptions, change, createDb, createMigrationInterface, dropDb, generate, migrate, rakeDb, resetDb, rollback, runCodeUpdater, writeMigrationFile };

package/dist/index.js

@@ -1077,6 +1077,12 @@ class MigrationBase {
   dropExtension(name, options = {}) {
     return createExtension$1(this, !this.up, name, options);
   }
+  createEnum(name, values, options) {
+    return createEnum(this, this.up, name, values, options);
+  }
+  dropEnum(name, values, options) {
+    return createEnum(this, !this.up, name, values, options);
+  }
   async tableExists(tableName) {
     return queryExists(this, {
       text: `SELECT 1 FROM "information_schema"."tables" WHERE "table_name" = $1`,
@@ -1145,13 +1151,35 @@ const createExtension$1 = async (migration, up, name, options) => {
   }, options);
   let query;
   if (ast.action === "drop") {
-    query = `DROP EXTENSION${ast.ifNotExists ? " IF EXISTS" : ""} "${ast.name}"${ast.cascade ? " CASCADE" : ""}`;
+    query = `DROP EXTENSION${ast.dropIfExists ? " IF EXISTS" : ""} "${ast.name}"${ast.cascade ? " CASCADE" : ""}`;
   } else {
-    query = `CREATE EXTENSION${ast.ifExists ? " IF NOT EXISTS" : ""} "${ast.name}"${ast.schema ? ` SCHEMA "${ast.schema}"` : ""}${ast.version ? ` VERSION '${ast.version}'` : ""}${ast.cascade ? " CASCADE" : ""}`;
+    query = `CREATE EXTENSION${ast.createIfNotExists ? " IF NOT EXISTS" : ""} "${ast.name}"${ast.schema ? ` SCHEMA "${ast.schema}"` : ""}${ast.version ? ` VERSION '${ast.version}'` : ""}${ast.cascade ? " CASCADE" : ""}`;
   }
   await migration.adapter.query(query);
   await runCodeUpdater(migration, ast);
 };
+const createEnum = async (migration, up, name, values, options = {}) => {
+  const [schema, enumName] = getSchemaAndTableFromName(name);
+  const ast = __spreadValues$2({
+    type: "enum",
+    action: up ? "create" : "drop",
+    schema,
+    name: enumName,
+    values
+  }, options);
+  let text;
+  const quotedName = quoteWithSchema(ast);
+  if (ast.action === "create") {
+    text = `CREATE TYPE ${quotedName} AS ENUM (${values.map((_, i) => `$${i + 1}`).join(", ")})`;
+  } else {
+    text = `DROP TYPE${ast.dropIfExists ? " IF EXISTS" : ""} ${quotedName}${ast.cascade ? " CASCADE" : ""}`;
+  }
+  await migration.adapter.query({
+    text,
+    values
+  });
+  await runCodeUpdater(migration, ast);
+};
 const queryExists = (db, sql) => {
   return db.adapter.query(sql).then(({ rowCount }) => rowCount > 0);
 };