rake-db 2.10.12 → 2.10.14

package/dist/index.d.ts

@@ -37,6 +37,8 @@ type TableChangeData = Record<string, RakeDbAst.ChangeTableItem.Column | RakeDbA
 
 type DropMode = 'CASCADE' | 'RESTRICT';
 type TableOptions = {
+    createIfNotExists?: boolean;
+    dropIfExists?: boolean;
     dropMode?: DropMode;
     comment?: string;
     noPrimaryKey?: boolean;
@@ -102,6 +104,8 @@ declare class Migration<CT extends ColumnTypesBase> {
      *
      * `dropTable` accepts the same arguments, it will drop the table when migrating and create a table when rolling back.
      *
+     * To create an empty table, the callback with columns may be omitted.
+     *
      * When creating a table within a specific schema, write the table name with schema name: `'schemaName.tableName'`.
      *
      * Returns object `{ table: TableInterface }` that allows to insert records right after creating a table.
@@ -110,6 +114,12 @@ declare class Migration<CT extends ColumnTypesBase> {
      *
      * ```ts
      * type TableOptions = {
+     *   // create the table only if it not exists already
+     *   createIfNotExists?: boolean;
+     *
+     *   // drop the table only if it exists
+     *   dropIfExists?: boolean;
+     *
      *   // used when reverting a `createTable`
      *   dropMode?: 'CASCADE' | 'RESTRICT';
      *
@@ -164,30 +174,30 @@ declare class Migration<CT extends ColumnTypesBase> {
      * @param tableName - name of the table to create
      * @param fn - create table callback
      */
-    createTable<Table extends string, Shape extends ColumnsShape>(tableName: Table, fn: ColumnsShapeCallback<CT, Shape>): Promise<CreateTableResult<Table, Shape>>;
+    createTable<Table extends string, Shape extends ColumnsShape>(tableName: Table, fn?: ColumnsShapeCallback<CT, Shape>): Promise<CreateTableResult<Table, Shape>>;
     /**
      * See {@link createTable}
      *
      * @param tableName - name of the table to create
-     * @param options - create table options
+     * @param options - {@link TableOptions}
      * @param fn - create table callback
      */
-    createTable<Table extends string, Shape extends ColumnsShape>(tableName: Table, options: TableOptions, fn: ColumnsShapeCallback<CT, Shape>): Promise<CreateTableResult<Table, Shape>>;
+    createTable<Table extends string, Shape extends ColumnsShape>(tableName: Table, options: TableOptions, fn?: ColumnsShapeCallback<CT, Shape>): Promise<CreateTableResult<Table, Shape>>;
     /**
      * Drop the table, create it on rollback. See {@link createTable}.
      *
      * @param tableName - name of the table to drop
      * @param fn - create table callback
      */
-    dropTable<Table extends string, Shape extends ColumnsShape>(tableName: Table, fn: ColumnsShapeCallback<CT, Shape>): Promise<CreateTableResult<Table, Shape>>;
+    dropTable<Table extends string, Shape extends ColumnsShape>(tableName: Table, fn?: ColumnsShapeCallback<CT, Shape>): Promise<CreateTableResult<Table, Shape>>;
     /**
      * Drop the table, create it on rollback. See {@link createTable}.
      *
      * @param tableName - name of the table to drop
-     * @param options - create table options
+     * @param options - {@link TableOptions}
      * @param fn - create table callback
      */
-    dropTable<Table extends string, Shape extends ColumnsShape>(tableName: Table, options: TableOptions, fn: ColumnsShapeCallback<CT, Shape>): Promise<CreateTableResult<Table, Shape>>;
+    dropTable<Table extends string, Shape extends ColumnsShape>(tableName: Table, options: TableOptions, fn?: ColumnsShapeCallback<CT, Shape>): Promise<CreateTableResult<Table, Shape>>;
     /**
      * `changeTable` accepts a table name, optional options, and a special callback with column changes.
      *
@@ -794,6 +804,8 @@ declare namespace RakeDbAst {
         name: string;
         shape: ColumnsShape;
         noPrimaryKey: NoPrimaryKeyOption;
+        createIfNotExists?: boolean;
+        dropIfExists?: boolean;
         dropMode?: DropMode;
         comment?: string;
     } & TableData;

package/dist/index.js

@@ -609,12 +609,7 @@ const createTable$1 = async (migration, up, tableName, options, fn) => {
     tableMethods
   );
   types[orchidCore.snakeCaseKey] = snakeCase;
-  const shape = pqb.getColumnTypes(
-    types,
-    fn,
-    (_a = migration.options.baseTable) == null ? void 0 : _a.nowSQL,
-    language
-  );
+  const shape = !fn ? orchidCore.emptyObject : pqb.getColumnTypes(types, fn, (_a = migration.options.baseTable) == null ? void 0 : _a.nowSQL, language);
   const tableData = pqb.getTableData();
   const ast = makeAst$2(
     up,
@@ -624,7 +619,7 @@ const createTable$1 = async (migration, up, tableName, options, fn) => {
     options,
     migration.options.noPrimaryKey
   );
-  validatePrimaryKey(ast);
+  fn && validatePrimaryKey(ast);
   const queries = astToQueries$1(ast, snakeCase, language);
   for (const _b of queries) {
     const _c = _b, { then } = _c, query = __objRest$1(_c, ["then"]);
@@ -705,7 +700,7 @@ const astToQueries$1 = (ast, snakeCase, language) => {
   }
   if (ast.action === "drop") {
     queries.push({
-      text: `DROP TABLE ${quoteWithSchema(ast)}${ast.dropMode ? ` ${ast.dropMode}` : ""}`
+      text: `DROP TABLE${ast.dropIfExists ? " IF EXISTS" : ""} ${quoteWithSchema(ast)}${ast.dropMode ? ` ${ast.dropMode}` : ""}`
     });
     return queries;
   }
@@ -761,7 +756,7 @@ const astToQueries$1 = (ast, snakeCase, language) => {
   );
   queries.push(
     {
-      text: `CREATE TABLE ${quoteWithSchema(ast)} (${lines.join(",")}
+      text: `CREATE TABLE${ast.createIfNotExists ? " IF NOT EXISTS" : ""} ${quoteWithSchema(ast)} (${lines.join(",")}
 )`,
       values
     },
@@ -1372,12 +1367,12 @@ const createMigrationInterface = (tx, up, config) => {
 };
 class Migration {
   createTable(tableName, cbOrOptions, cb) {
-    const options = typeof cbOrOptions === "function" ? {} : cbOrOptions;
+    const options = !cbOrOptions || typeof cbOrOptions === "function" ? {} : cbOrOptions;
     const fn = cb || cbOrOptions;
     return createTable$1(this, this.up, tableName, options, fn);
   }
   dropTable(tableName, cbOrOptions, cb) {
-    const options = typeof cbOrOptions === "function" ? {} : cbOrOptions;
+    const options = !cbOrOptions || typeof cbOrOptions === "function" ? {} : cbOrOptions;
     const fn = cb || cbOrOptions;
     return createTable$1(this, !this.up, tableName, options, fn);
   }