@c9up/atlas 0.2.0 → 0.2.1

package/src/schema/Schema.ts

@@ -149,7 +149,18 @@ export class Schema {
 		return this;
 	}
 
+	/** `DROP TABLE` — errors if the table is missing (Adonis Lucid/Knex `dropTable`). */
 	dropTable(name: string): this {
+		const { statements } = compileStatementNative(
+			{ kind: "dropTable", table: this.#qualify(name), ifExists: false },
+			this.#dialect,
+		);
+		this.#statements.push(...statements);
+		return this;
+	}
+
+	/** `DROP TABLE IF EXISTS` — a no-op when missing (Lucid/Knex `dropTableIfExists`). */
+	dropTableIfExists(name: string): this {
 		const { statements } = compileStatementNative(
 			{ kind: "dropTable", table: this.#qualify(name), ifExists: true },
 			this.#dialect,
@@ -158,6 +169,89 @@ export class Schema {
 		return this;
 	}
 
+	/**
+	 * `CREATE SCHEMA` (Lucid/Knex `createSchema`). Postgres and MySQL (where a
+	 * schema is a database); rejected on SQLite, which has no schemas.
+	 */
+	createSchema(name: string): this {
+		return this.#schemaStmt({ kind: "createSchema", name, ifNotExists: false });
+	}
+
+	/** `CREATE SCHEMA IF NOT EXISTS` (Lucid/Knex `createSchemaIfNotExists`). */
+	createSchemaIfNotExists(name: string): this {
+		return this.#schemaStmt({ kind: "createSchema", name, ifNotExists: true });
+	}
+
+	/** `DROP SCHEMA [CASCADE]` (Lucid/Knex `dropSchema`). CASCADE is Postgres-only. */
+	dropSchema(name: string, cascade = false): this {
+		return this.#schemaStmt({
+			kind: "dropSchema",
+			name,
+			ifExists: false,
+			cascade,
+		});
+	}
+
+	/** `DROP SCHEMA IF EXISTS [CASCADE]` (Lucid/Knex `dropSchemaIfExists`). */
+	dropSchemaIfExists(name: string, cascade = false): this {
+		return this.#schemaStmt({
+			kind: "dropSchema",
+			name,
+			ifExists: true,
+			cascade,
+		});
+	}
+
+	/** Compile a schema-level DDL spec and queue it. */
+	#schemaStmt(spec: object): this {
+		const { statements } = compileStatementNative(spec, this.#dialect);
+		this.#statements.push(...statements);
+		return this;
+	}
+
+	/**
+	 * `CREATE TABLE new LIKE old` (Lucid/Knex `createTableLike`) — copy a table's
+	 * structure. Postgres copies everything (`INCLUDING ALL`), MySQL uses `LIKE`,
+	 * SQLite copies COLUMNS ONLY (`AS SELECT … WHERE 0` — no constraints/indexes,
+	 * the same limitation Knex documents).
+	 */
+	createTableLike(
+		name: string,
+		likeTable: string,
+		callback?: (table: TableBuilder) => void,
+	): this {
+		this.#schemaStmt({
+			kind: "createTableLike",
+			table: this.#qualify(name),
+			likeTable: this.#qualify(likeTable),
+			ifNotExists: false,
+		});
+		// Lucid's optional callback adds columns to the copied table — emit them as
+		// a follow-up ALTER TABLE (the copy exists by the time it runs).
+		if (callback) this.alterTable(name, callback);
+		return this;
+	}
+
+	/**
+	 * `ALTER VIEW` (Lucid/Knex `alterView`) — rename a view's columns via the
+	 * callback (`view.column('id').rename('user_id')`). Postgres only: MySQL/SQLite
+	 * can't rename view columns in place, so drop and re-create the view there.
+	 */
+	alterView(name: string, callback: (view: AlterViewBuilder) => void): this {
+		const builder = new AlterViewBuilder();
+		callback(builder);
+		return this.#schemaStmt({
+			kind: "alterView",
+			view: this.#qualify(name),
+			renames: builder.renames,
+		});
+	}
+
+	/** Alias of {@link alterView} (Lucid/Knex `view`). */
+	view(name: string, callback: (view: AlterViewBuilder) => void): this {
+		return this.alterView(name, callback);
+	}
+
 	createIndex(
 		table: string,
 		columns: string | string[],
@@ -221,29 +315,67 @@ export class Schema {
 		return this.#pushView(name, select, { ...options, materialized: true });
 	}
 
-	/** `DROP VIEW IF EXISTS name` (Lucid/Knex `dropView`/`dropViewIfExists`). */
+	/** `DROP VIEW` — errors if missing (Lucid/Knex `dropView`). */
 	dropView(name: string): this {
-		const { statements } = compileStatementNative(
-			{ kind: "dropView", name: this.#qualify(name), ifExists: true },
-			this.#dialect,
-		);
-		this.#statements.push(...statements);
-		return this;
+		return this.#schemaStmt({
+			kind: "dropView",
+			name: this.#qualify(name),
+			ifExists: false,
+		});
+	}
+
+	/** `DROP VIEW IF EXISTS` — a no-op when missing (Lucid/Knex `dropViewIfExists`). */
+	dropViewIfExists(name: string): this {
+		return this.#schemaStmt({
+			kind: "dropView",
+			name: this.#qualify(name),
+			ifExists: true,
+		});
 	}
 
-	/** `DROP MATERIALIZED VIEW IF EXISTS name` (Lucid/Knex). Postgres-only. */
+	/** `DROP MATERIALIZED VIEW` (Lucid/Knex). Postgres-only. */
 	dropMaterializedView(name: string): this {
-		const { statements } = compileStatementNative(
-			{
-				kind: "dropView",
-				name: this.#qualify(name),
-				ifExists: true,
-				materialized: true,
-			},
-			this.#dialect,
-		);
-		this.#statements.push(...statements);
-		return this;
+		return this.#schemaStmt({
+			kind: "dropView",
+			name: this.#qualify(name),
+			ifExists: false,
+			materialized: true,
+		});
+	}
+
+	/** `DROP MATERIALIZED VIEW IF EXISTS` (Lucid/Knex). Postgres-only. */
+	dropMaterializedViewIfExists(name: string): this {
+		return this.#schemaStmt({
+			kind: "dropView",
+			name: this.#qualify(name),
+			ifExists: true,
+			materialized: true,
+		});
+	}
+
+	/**
+	 * Rename a view (Lucid/Knex `renameView`). Postgres `ALTER VIEW … RENAME TO`,
+	 * MySQL `RENAME TABLE`; SQLite can't rename a view (drop and re-create).
+	 */
+	renameView(from: string, to: string): this {
+		return this.#schemaStmt({
+			kind: "renameView",
+			from: this.#qualify(from),
+			to: this.#qualify(to),
+			materialized: false,
+		});
+	}
+
+	/**
+	 * `REFRESH MATERIALIZED VIEW [CONCURRENTLY]` (Lucid/Knex
+	 * `refreshMaterializedView`). Postgres-only.
+	 */
+	refreshMaterializedView(name: string, concurrently = false): this {
+		return this.#schemaStmt({
+			kind: "refreshMaterializedView",
+			name: this.#qualify(name),
+			concurrently,
+		});
 	}
 
 	#pushView(
@@ -283,3 +415,20 @@ export class Schema {
 		return [...this.#statements];
 	}
 }
+
+/**
+ * Callback builder for {@link Schema.alterView} — collects column renames
+ * (Adonis Lucid `view.column('id').rename('user_id')`).
+ */
+export class AlterViewBuilder {
+	readonly renames: Array<{ from: string; to: string }> = [];
+
+	/** Target a view column; `.rename(to)` queues its rename. */
+	column(name: string): { rename(to: string): void } {
+		return {
+			rename: (to: string): void => {
+				this.renames.push({ from: name, to });
+			},
+		};
+	}
+}