rake-db 2.29.3 → 2.29.4

package/dist/index.d.ts

@@ -1746,7 +1746,100 @@ declare const dbColumnToAst: (ctx: StructureToAstCtx, data: IntrospectedStructur
 declare const writeMigrationFile: (config: RakeDbConfig, version: string, name: string, migrationCode: string) => Promise<void>;
 declare const makeFileVersion: (ctx: RakeDbCtx, config: RakeDbConfig) => Promise<string>;
 
+type CreateOrDropOk = 'done' | 'already';
+/**
+ * To create a database, reconfigure the connection with a power user and an existing database to connect to.
+ *
+ * ```ts
+ * import { createDatabase } from 'orchid-orm/migrations';
+ *
+ * const adapter = db.$adapter.reconfigure({
+ *   user: 'postgres',
+ *   database: 'postgres',
+ * });
+ *
+ * await createDatabase(adapter, {
+ *   database: 'database-to-create',
+ *   owner: 'username', // optional
+ * });
+ * ```
+ */
+declare const createDatabase: (db: DbParam, { database, owner, }: {
+    database: string;
+    owner?: string;
+}) => Promise<CreateOrDropOk>;
+/**
+ * To drop a database, reconfigure the connection with a power user and a different database to connect to.
+ *
+ * Ensure the connections to the database are closed before dropping, because Postgres won't be able to drop it otherwise.
+ *
+ * ```ts
+ * import { createDatabase } from 'orchid-orm/migrations';
+ *
+ * const adapter = db.$adapter.reconfigure({
+ *   user: 'postgres',
+ *   database: 'postgres',
+ * });
+ *
+ * await createDatabase(adapter, {
+ *   database: 'database-to-create',
+ *   owner: 'username', // optional
+ * });
+ * ```
+ */
+declare const dropDatabase: (db: DbParam, { database }: {
+    database: string;
+}) => Promise<CreateOrDropOk>;
+/**
+ * `createSchema` uses a savepoint when it is called in a transaction to not break it if the schema already exists.
+ *
+ * Prepends `CREATE SCHEMA` to a given SQL.
+ *
+ * ```ts
+ * import { createSchema } from 'orchid-orm/migrations';
+ *
+ * const result: 'done' | 'already' = await createSchema(db, '"schema"');
+ * ```
+ */
+declare const createSchema: (db: DbParam, sql: string) => Promise<'done' | 'already'>;
+/**
+ * `dropSchema` uses a savepoint when it is called in a transaction to not break it if the schema does not exist.
+ *
+ * Prepends `DROP SCHEMA` to a given SQL.
+ *
+ * ```ts
+ * import { dropSchema } from 'orchid-orm/migrations';
+ *
+ * const result: 'done' | 'already' = await dropSchema(db, '"schema"');
+ * ```
+ */
+declare const dropSchema: (db: DbParam, sql: string) => Promise<'done' | 'already'>;
+/**
+ * `createTable` uses a savepoint when it is called in a transaction to not break it if the table already exists.
+ *
+ * Prepends `CREATE TABLE` to a given SQL.
+ *
+ * ```ts
+ * import { createTable } from 'orchid-orm/migrations';
+ *
+ * const result: 'done' | 'already' = await createTable(db, '"table"');
+ * ```
+ */
+declare const createTable: (db: DbParam, sql: string) => Promise<'done' | 'already'>;
+/**
+ * `dropTable` uses a savepoint when it is called in a transaction to not break it if the table does not exist.
+ *
+ * Prepends `DROP TABLE` to a given SQL.
+ *
+ * ```ts
+ * import { dropTable } from 'orchid-orm/migrations';
+ *
+ * const result: 'done' | 'already' = await dropTable(db, '"table"');
+ * ```
+ */
+declare const dropTable: (db: DbParam, sql: string) => Promise<'done' | 'already'>;
+
 declare class RakeDbError extends Error {
 }
 
-export { type ChangeCallback, type DbMigration, DbStructure, type IntrospectedStructure, RakeDbAst, type RakeDbChangeFn, type RakeDbCliConfigInput, type RakeDbConfig, RakeDbError, type RakeDbFn, type SilentQueries, type StructureToAstCtx, type StructureToAstTableData, astToMigration, concatSchemaAndName, createMigrationInterface, dbColumnToAst, encodeColumnDefault, getConstraintName, getDbStructureTableData, getDbTableColumnsChecks, getExcludeName, getIndexName, getMigrationsSchemaAndTable, getSchemaAndTableFromName, incrementIntermediateCaller, instantiateDbColumn, introspectDbSchema, makeDomainsMap, makeFileVersion, makeRakeDbConfig, makeStructureToAstCtx, migrate, migrateAndClose, migrationConfigDefaults, promptSelect, rakeDbCliWithAdapter, rakeDbCommands, redo, rollback, runMigration, saveMigratedVersion, setRakeDbCliRunFn, structureToAst, tableToAst, writeMigrationFile };
+export { type ChangeCallback, type DbMigration, DbStructure, type IntrospectedStructure, RakeDbAst, type RakeDbChangeFn, type RakeDbCliConfigInput, type RakeDbConfig, RakeDbError, type RakeDbFn, type SilentQueries, type StructureToAstCtx, type StructureToAstTableData, astToMigration, concatSchemaAndName, createDatabase, createMigrationInterface, createSchema, createTable, dbColumnToAst, dropDatabase, dropSchema, dropTable, encodeColumnDefault, getConstraintName, getDbStructureTableData, getDbTableColumnsChecks, getExcludeName, getIndexName, getMigrationsSchemaAndTable, getSchemaAndTableFromName, incrementIntermediateCaller, instantiateDbColumn, introspectDbSchema, makeDomainsMap, makeFileVersion, makeRakeDbConfig, makeStructureToAstCtx, migrate, migrateAndClose, migrationConfigDefaults, promptSelect, rakeDbCliWithAdapter, rakeDbCommands, redo, rollback, runMigration, saveMigratedVersion, setRakeDbCliRunFn, structureToAst, tableToAst, writeMigrationFile };

package/dist/index.js

@@ -246,7 +246,9 @@ const createOrDrop = async (db, sql) => {
   }
 };
 const createSchema$1 = async (db, sql) => runSqlInSavePoint(db, `CREATE SCHEMA ${sql}`, "42P06");
+const dropSchema = async (db, sql) => runSqlInSavePoint(db, `DROP SCHEMA ${sql}`, "3F000");
 const createTable$1 = async (db, sql) => runSqlInSavePoint(db, `CREATE TABLE ${sql}`, "42P07");
+const dropTable = async (db, sql) => runSqlInSavePoint(db, `DROP TABLE ${sql}`, "42P01");
 
 const RAKE_DB_LOCK_KEY = "8582141715823621641";
 const getFirstWordAndRest = (input) => {
@@ -6078,8 +6080,14 @@ for (const key in rakeDbAliases) {
 exports.RakeDbError = RakeDbError;
 exports.astToMigration = astToMigration;
 exports.concatSchemaAndName = concatSchemaAndName;
+exports.createDatabase = createDatabase;
 exports.createMigrationInterface = createMigrationInterface;
+exports.createSchema = createSchema$1;
+exports.createTable = createTable$1;
 exports.dbColumnToAst = dbColumnToAst;
+exports.dropDatabase = dropDatabase;
+exports.dropSchema = dropSchema;
+exports.dropTable = dropTable;
 exports.encodeColumnDefault = encodeColumnDefault;
 exports.getConstraintName = getConstraintName;
 exports.getDbStructureTableData = getDbStructureTableData;