rake-db 2.36.6 → 2.36.8

package/dist/index.mjs

@@ -404,7 +404,7 @@ const createTable$1 = async (migration, tableMethods, up, tableName, first, seco
 		});
 	} else shape = tableData = emptyObject;
 	const schema = migration.adapter.getSchema();
-	const ast = makeAst$4(schema, up, tableName, shape, tableData, options, migration.options.noPrimaryKey);
+	const ast = makeAst$5(schema, up, tableName, shape, tableData, options, migration.options.noPrimaryKey);
 	fn && validatePrimaryKey(ast);
 	const queries = astToQueries$1(schema, ast, snakeCase, language);
 	for (const { then, ...query } of queries) {
@@ -419,7 +419,7 @@ const createTable$1 = async (migration, tableMethods, up, tableName, first, seco
 		});
 	} };
 };
-const makeAst$4 = (schema, up, tableName, shape, tableData, options, noPrimaryKey) => {
+const makeAst$5 = (schema, up, tableName, shape, tableData, options, noPrimaryKey) => {
 	const shapePKeys = [];
 	for (const key in shape) if (shape[key].data.primaryKey) shapePKeys.push(key);
 	const { primaryKey } = tableData;
@@ -837,13 +837,13 @@ const changeTable = async (migration, tableChangeMethods, up, tableName, options
 	standaloneCheckChanges.length = 0;
 	const changeData = fn?.(tableChanger) || {};
 	const schema = migration.adapter.getSchema();
-	const queries = astToQueries(schema, makeAst$3(schema, up, tableName, changeData, changeTableData, options), snakeCase, language);
+	const queries = astToQueries(schema, makeAst$4(schema, up, tableName, changeData, changeTableData, options), snakeCase, language);
 	for (const query of queries) {
 		const result = await migration.adapter.arrays(interpolateSqlValues(query));
 		query.then?.(result);
 	}
 };
-const makeAst$3 = (schema, up, name, changeData, changeTableData, options) => {
+const makeAst$4 = (schema, up, name, changeData, changeTableData, options) => {
 	const { comment } = options;
 	const shape = {};
 	const consumedChanges = {};
@@ -1116,10 +1116,10 @@ const renameColumnSql = (from, to) => {
 	return `RENAME COLUMN "${from}" TO "${to}"`;
 };
 const createView = async (migration, up, name, options, sql) => {
-	const query = astToQuery$1(makeAst$2(migration.adapter.getSchema(), up, name, options, sql));
+	const query = astToQuery$2(makeAst$3(migration.adapter.getSchema(), up, name, options, sql));
 	await migration.adapter.arrays(interpolateSqlValues(query));
 };
-const makeAst$2 = (schema, up, fullName, options, sql) => {
+const makeAst$3 = (schema, up, fullName, options, sql) => {
 	if (typeof sql === "string") sql = raw({ raw: sql });
 	const [s, name] = getSchemaAndTableFromName(schema, fullName);
 	return {
@@ -1133,7 +1133,7 @@ const makeAst$2 = (schema, up, fullName, options, sql) => {
 		deps: []
 	};
 };
-const astToQuery$1 = (ast) => {
+const astToQuery$2 = (ast) => {
 	const values = [];
 	const sql = [];
 	const { options } = ast;
@@ -1145,11 +1145,10 @@ const astToQuery$1 = (ast) => {
 		if (options?.recursive) sql.push("RECURSIVE");
 		sql.push(`VIEW ${sqlName}`);
 		if (options?.columns) sql.push(`(${options.columns.map((column) => `"${column}"`).join(", ")})`);
-		const withOptions = options?.with;
 		const list = [];
-		if (withOptions?.checkOption) list.push(`check_option = ${singleQuote(withOptions.checkOption)}`);
-		if (withOptions?.securityBarrier) list.push(`security_barrier = true`);
-		if (withOptions?.securityInvoker !== false) list.push(`security_invoker = true`);
+		if (options?.checkOption) list.push(`check_option = ${singleQuote(options.checkOption)}`);
+		if (options?.securityBarrier) list.push(`security_barrier = true`);
+		if (options?.securityInvoker !== false) list.push(`security_invoker = true`);
 		if (list.length) sql.push(`WITH ( ${list.join(", ")} )`);
 		sql.push(`AS (${ast.sql.toSQL({ values })})`);
 	} else {
@@ -1163,6 +1162,58 @@ const astToQuery$1 = (ast) => {
 		values
 	};
 };
+const createMaterializedView = async (migration, up, name, options, sql) => {
+	const query = astToQuery$1(makeAst$2(migration.adapter.getSchema(), up, name, options, sql));
+	await migration.adapter.arrays(interpolateSqlValues(query));
+};
+const refreshMaterializedView = async (migration, name, options = {}) => {
+	if (options.concurrently && options.withData === false) throw new Error("Cannot refresh a materialized view concurrently with WITH NO DATA");
+	const [s, viewName] = getSchemaAndTableFromName(migration.adapter.getSchema(), name);
+	const sql = ["REFRESH MATERIALIZED VIEW"];
+	if (options.concurrently) sql.push("CONCURRENTLY");
+	sql.push(`${s ? `"${s}".` : ""}"${viewName}"`);
+	pushWithData(sql, options);
+	await migration.adapter.arrays(sql.join(" "));
+};
+const makeAst$2 = (schema, up, fullName, options, sql) => {
+	if (typeof sql === "string") sql = raw({ raw: sql });
+	const [s, name] = getSchemaAndTableFromName(schema, fullName);
+	return {
+		type: "materializedView",
+		action: up ? "create" : "drop",
+		schema: s,
+		name,
+		shape: {},
+		sql,
+		options,
+		deps: []
+	};
+};
+const astToQuery$1 = (ast) => {
+	const values = [];
+	const sql = [];
+	const { options } = ast;
+	const sqlName = `${ast.schema ? `"${ast.schema}".` : ""}"${ast.name}"`;
+	if (ast.action === "create") {
+		sql.push(`CREATE MATERIALIZED VIEW ${sqlName}`);
+		if (options?.columns) sql.push(`(${options.columns.map((column) => `"${column}"`).join(", ")})`);
+		sql.push(`AS (${ast.sql.toSQL({ values })})`);
+		pushWithData(sql, options);
+	} else {
+		sql.push("DROP MATERIALIZED VIEW");
+		if (options?.dropIfExists) sql.push(`IF EXISTS`);
+		sql.push(sqlName);
+		if (options?.dropMode) sql.push(options.dropMode);
+	}
+	return {
+		text: sql.join(" "),
+		values
+	};
+};
+const pushWithData = (sql, options) => {
+	if (options.withData === true) sql.push("WITH DATA");
+	else if (options.withData === false) sql.push("WITH NO DATA");
+};
 const serializers = {
 	super: (b) => `${b ? "" : "NO"}SUPERUSER`,
 	inherit: (b) => `${b ? "" : "NO"}INHERIT`,
@@ -2360,6 +2411,23 @@ var Migration = class {
 		const [options, sql] = args.length === 2 ? args : [emptyObject, args[0]];
 		return createView(this, !this.up, name, options, sql);
 	}
+	createMaterializedView(name, ...args) {
+		const [options, sql] = args.length === 2 ? args : [emptyObject, args[0]];
+		return createMaterializedView(this, this.up, name, options, sql);
+	}
+	dropMaterializedView(name, ...args) {
+		const [options, sql] = args.length === 2 ? args : [emptyObject, args[0]];
+		return createMaterializedView(this, !this.up, name, options, sql);
+	}
+	/**
+	* Refresh a materialized view.
+	*
+	* @param name - name of the materialized view
+	* @param options - refresh options
+	*/
+	refreshMaterializedView(name, options) {
+		return refreshMaterializedView(this, name, options);
+	}
 	/**
 	* Returns boolean to know if table exists:
 	*
@@ -3686,10 +3754,11 @@ const astToGenerateItem = (config, ast, currentSchema) => {
 	switch (ast.type) {
 		case "table":
 		case "changeTable":
-		case "view": {
+		case "view":
+		case "materializedView": {
 			const schema = ast.schema ?? currentSchema;
 			const table = `${schema}.${ast.name}`;
-			if (ast.type === "table" || ast.type === "view") {
+			if (ast.type === "table" || ast.type === "view" || ast.type === "materializedView") {
 				const keys = ast.action === "create" ? add : drop;
 				keys.push(table);
 				deps.push(schema);
@@ -4228,31 +4297,41 @@ const astEncoders = {
 		})}, ${singleQuote(ast.from)}, ${singleQuote(ast.to)});`];
 	},
 	view(ast, _, currentSchema) {
-		const code = [`await db.createView(${quoteSchemaTable(ast, currentSchema)}`];
+		const code = [`await db.${ast.action}View(${quoteSchemaTable(ast, currentSchema)}`];
 		const options = [];
-		if (ast.options.recursive) options.push("recursive: true,");
-		const w = ast.options.with;
-		if (w?.checkOption) options.push(`checkOption: '${w.checkOption}',`);
-		if (w?.securityBarrier) options.push(`securityBarrier: ${w.securityBarrier},`);
-		if (w?.securityInvoker) options.push(`securityInvoker: ${w.securityInvoker},`);
+		const { options: astOptions } = ast;
+		if (astOptions.createOrReplace !== void 0) options.push(`createOrReplace: ${astOptions.createOrReplace},`);
+		if (astOptions.dropIfExists !== void 0) options.push(`dropIfExists: ${astOptions.dropIfExists},`);
+		if (astOptions.dropMode) options.push(`dropMode: '${astOptions.dropMode}',`);
+		if (astOptions.temporary !== void 0) options.push(`temporary: ${astOptions.temporary},`);
+		if (astOptions.recursive !== void 0) options.push(`recursive: ${astOptions.recursive},`);
+		if (astOptions.columns) options.push(`columns: [${astOptions.columns.map(singleQuote).join(", ")}],`);
+		if (astOptions.checkOption) options.push(`checkOption: '${astOptions.checkOption}',`);
+		if (astOptions.securityBarrier !== void 0) options.push(`securityBarrier: ${astOptions.securityBarrier},`);
+		if (astOptions.securityInvoker !== void 0) options.push(`securityInvoker: ${astOptions.securityInvoker},`);
 		if (options.length) {
 			addCode(code, ", {");
 			code.push(options, "}");
 		}
 		addCode(code, ", ");
-		if (!ast.sql._values) {
-			const raw = ast.sql._sql;
-			let sql;
-			if (typeof raw === "string") sql = raw;
-			else {
-				sql = "";
-				const parts = raw[0];
-				const last = parts.length - 1;
-				for (let i = 0; i < last; i++) sql += parts[i] + `\${${raw[i + 1]}}`;
-				sql += parts[last];
-			}
-			addCode(code, backtickQuote(sql));
-		} else addCode(code, rawSqlToCode(ast.sql, "db"));
+		addViewSqlCode(code, ast.sql);
+		addCode(code, ");");
+		return code;
+	},
+	materializedView(ast, _, currentSchema) {
+		const code = [`await db.${ast.action}MaterializedView(${quoteSchemaTable(ast, currentSchema)}`];
+		const options = [];
+		const { options: astOptions } = ast;
+		if (astOptions.dropIfExists !== void 0) options.push(`dropIfExists: ${astOptions.dropIfExists},`);
+		if (astOptions.dropMode) options.push(`dropMode: '${astOptions.dropMode}',`);
+		if (astOptions.columns) options.push(`columns: [${astOptions.columns.map(singleQuote).join(", ")}],`);
+		if (astOptions.withData !== void 0) options.push(`withData: ${astOptions.withData},`);
+		if (options.length) {
+			addCode(code, ", {");
+			code.push(options, "}");
+		}
+		addCode(code, ", ");
+		addViewSqlCode(code, ast.sql);
 		addCode(code, ");");
 		return code;
 	},
@@ -4428,6 +4507,21 @@ const isPolicyRecreateDefinition = (policy) => {
 const rawSqlStringToCode = (sql) => {
 	return `db.sql${backtickQuote(sql)}`;
 };
+const addViewSqlCode = (code, sqlAst) => {
+	if (!sqlAst._values) {
+		const raw = sqlAst._sql;
+		let sql;
+		if (typeof raw === "string") sql = raw;
+		else {
+			sql = "";
+			const parts = raw[0];
+			const last = parts.length - 1;
+			for (let i = 0; i < last; i++) sql += parts[i] + `\${${raw[i + 1]}}`;
+			sql += parts[last];
+		}
+		addCode(code, backtickQuote(sql));
+	} else addCode(code, rawSqlToCode(sqlAst, "db"));
+};
 const roleParams = (name, ast, compare, to) => {
 	const params = [];
 	for (const key of [
@@ -4612,6 +4706,39 @@ JOIN pg_class c
 JOIN pg_rewrite r ON r.ev_class = c.oid
 WHERE ${filterSchema("nc.nspname")}
 ORDER BY c.relname`;
+const materializedViewsSql = `SELECT
+  nc.nspname AS "schemaName",
+  c.relname AS "name",
+  (
+    SELECT COALESCE(json_agg(t.*), '[]')
+    FROM (
+      SELECT
+        ns.nspname AS "schemaName",
+        obj.relname AS "name"
+      FROM pg_class obj
+      JOIN pg_depend dep ON dep.refobjid = obj.oid
+      JOIN pg_rewrite rew ON rew.oid = dep.objid
+      JOIN pg_namespace ns ON ns.oid = obj.relnamespace
+      WHERE rew.ev_class = c.oid AND obj.oid <> c.oid
+    ) t
+  ) "deps",
+  (SELECT coalesce(json_agg(t), '[]') FROM (${columnsSql({
+	schema: "nc",
+	table: "c",
+	where: "a.attrelid = c.oid"
+})}) t) AS "columns",
+  pg_get_viewdef(c.oid) AS "sql",
+  c.relispopulated AS "isPopulated",
+  spc.spcname AS "tablespace"
+FROM pg_namespace nc
+JOIN pg_class c
+  ON nc.oid = c.relnamespace
+ AND c.relkind = 'm'
+ AND c.relpersistence != 't'
+JOIN pg_rewrite r ON r.ev_class = c.oid
+LEFT JOIN pg_tablespace spc ON spc.oid = c.reltablespace
+WHERE ${filterSchema("nc.nspname")}
+ORDER BY c.relname`;
 const indexesSql = `SELECT
   n.nspname "schemaName",
   t.relname "tableName",
@@ -4913,7 +5040,7 @@ const grantsSql = `SELECT COALESCE(json_agg(t.* ORDER BY t."target", t."schema",
   FROM pg_class c
   JOIN pg_namespace n ON n.oid = c.relnamespace
   JOIN LATERAL aclexplode(coalesce(c.relacl, acldefault('r', c.relowner))) ae ON true
-  WHERE c.relkind IN ('r', 'p')
+  WHERE c.relkind IN ('r', 'p', 'v')
     AND ${filterSchema("n.nspname")}
     AND ae.grantee <> c.relowner
   GROUP BY "grantor", "grantee", "schema", "name", "target"
@@ -5045,7 +5172,7 @@ FROM pg_policy p
 JOIN pg_class c ON c.oid = p.polrelid
 JOIN pg_namespace n ON n.oid = c.relnamespace
 ORDER BY n.nspname, c.relname, p.polname`;
-const sql = (version, params) => `SELECT (${schemasSql}) AS "schemas", ${jsonAgg(tablesSql(params?.rls), "tables")}, ${jsonAgg(viewsSql, "views")}, ${jsonAgg(indexesSql, "indexes")}, ${jsonAgg(constraintsSql, "constraints")}, ${jsonAgg(triggersSql, "triggers")}, ${jsonAgg(extensionsSql, "extensions")}, ${jsonAgg(enumsSql, "enums")}, ${jsonAgg(domainsSql, "domains")}, ${jsonAgg(collationsSql(version), "collations")}${params?.roles ? `, (${roleSql(params.roles)}) AS "roles"` : ""}${params?.loadDefaultPrivileges ? `, (${defaultPrivilegesSql}) AS "defaultPrivileges"` : ""}${params?.loadGrants ? `, (${grantsSql}) AS "grants"` : ""}${params?.rls ? `, ${jsonAgg(policiesSql, "policies")}` : ""}`;
+const sql = (version, params) => `SELECT (${schemasSql}) AS "schemas", ${jsonAgg(tablesSql(params?.rls), "tables")}, ${params?.loadViews ? `${jsonAgg(viewsSql, "views")}, ${jsonAgg(materializedViewsSql, "materializedViews")}, ` : ""}${jsonAgg(indexesSql, "indexes")}, ${jsonAgg(constraintsSql, "constraints")}, ${jsonAgg(triggersSql, "triggers")}, ${jsonAgg(extensionsSql, "extensions")}, ${jsonAgg(enumsSql, "enums")}, ${jsonAgg(domainsSql, "domains")}, ${jsonAgg(collationsSql(version), "collations")}${params?.roles ? `, (${roleSql(params.roles)}) AS "roles"` : ""}${params?.loadDefaultPrivileges ? `, (${defaultPrivilegesSql}) AS "defaultPrivileges"` : ""}${params?.loadGrants ? `, (${grantsSql}) AS "grants"` : ""}${params?.rls ? `, ${jsonAgg(policiesSql, "policies")}` : ""}`;
 async function getDbVersion(db) {
 	const { rows: [{ version: versionString }] } = await db.query("SELECT version()");
 	return +versionString.match(/\d+/)[0];
@@ -5057,10 +5184,11 @@ async function introspectDbSchema(db, params) {
 		domain.checks = domain.checks?.filter((check) => check);
 		nullsToUndefined(domain);
 	}
-	for (const table of raw.tables) for (const column of table.columns) {
-		nullsToUndefined(column);
-		if (column.identity) nullsToUndefined(column.identity);
-		if (column.compression) column.compression = column.compression === "p" ? "pglz" : "lz4";
+	for (const table of raw.tables) processColumns(table.columns);
+	for (const view of raw.views || []) processColumns(view.columns);
+	for (const materializedView of raw.materializedViews || []) {
+		nullsToUndefined(materializedView);
+		processColumns(materializedView.columns);
 	}
 	const indexes = [];
 	const excludes = [];
@@ -5189,6 +5317,13 @@ const mapRawGrant = (raw) => {
 	if (grantablePrivileges.length) grant.grantablePrivileges = grantablePrivileges;
 	return grant;
 };
+const processColumns = (columns) => {
+	for (const column of columns) {
+		nullsToUndefined(column);
+		if (column.identity) nullsToUndefined(column.identity);
+		if (column.compression) column.compression = column.compression === "p" ? "pglz" : "lz4";
+	}
+};
 const nullsToUndefined = (obj) => {
 	for (const key in obj) if (obj[key] === null) obj[key] = void 0;
 };
@@ -5286,7 +5421,19 @@ const structureToAst = async (ctx, adapter, config) => {
 		tableSchema: table.schemaName === ctx.currentSchema ? void 0 : table.schemaName,
 		tableName: fkey.tableName
 	});
-	for (const view of data.views) ast.push(viewToAst(ctx, data, domains, view));
+	for (const view of data.views || []) ast.push(viewToAst(ctx, data, domains, view));
+	for (const view of data.materializedViews || []) {
+		ast.push(materializedViewToAst(ctx, data, domains, view));
+		const indexes = materializedViewIndexesToAst(view, data);
+		if (indexes.length) ast.push({
+			type: "changeTable",
+			schema: view.schemaName === ctx.currentSchema ? void 0 : view.schemaName,
+			name: view.name,
+			shape: {},
+			add: { indexes },
+			drop: {}
+		});
+	}
 	if (data.roles) for (const role of data.roles) ast.push({
 		type: "role",
 		action: "create",
@@ -5456,13 +5603,22 @@ const isColumnCheck = (it) => {
 const viewToAst = (ctx, data, domains, view) => {
 	const shape = makeDbStructureColumnsShape(ctx, data, domains, view);
 	const options = {};
-	if (view.isRecursive) options.recursive = true;
-	if (view.with) {
-		const withOptions = {};
-		options.with = withOptions;
-		for (const pair of view.with) {
-			const [key, value] = pair.split("=");
-			withOptions[toCamelCase(key)] = value === "true" ? true : value === "false" ? false : value;
+	if (view.isRecursive) {
+		options.recursive = true;
+		options.columns = view.columns.map((column) => column.name);
+	}
+	if (view.with) for (const pair of view.with) {
+		const [key, value] = pair.split("=");
+		switch (toCamelCase(key)) {
+			case "checkOption":
+				if (value === "LOCAL" || value === "CASCADED") options.checkOption = value;
+				break;
+			case "securityBarrier":
+				options.securityBarrier = value === "true";
+				break;
+			case "securityInvoker":
+				options.securityInvoker = value === "true";
+				break;
 		}
 	}
 	return {
@@ -5476,11 +5632,40 @@ const viewToAst = (ctx, data, domains, view) => {
 		deps: view.deps
 	};
 };
+const materializedViewToAst = (ctx, data, domains, view) => {
+	const options = {};
+	if (!view.isPopulated) options.withData = false;
+	return {
+		type: "materializedView",
+		action: "create",
+		schema: view.schemaName === ctx.currentSchema ? void 0 : view.schemaName,
+		name: view.name,
+		shape: makeDbStructureColumnsShape(ctx, data, domains, view),
+		sql: raw({ raw: view.sql }),
+		options,
+		deps: view.deps
+	};
+};
+const materializedViewIndexesToAst = (view, data) => {
+	return data.indexes.filter(filterByTableSchema(view.name, view.schemaName)).map((index) => ({
+		columns: index.columns.map((column) => ({
+			..."expression" in column ? { expression: column.expression } : { column: toCamelCase(column.column) },
+			collate: column.collate,
+			opclass: column.opclass,
+			order: column.order
+		})),
+		options: {
+			...makeIndexOrExcludeOptions(view.name, index, "indexes"),
+			include: index.include?.map(toCamelCase)
+		}
+	}));
+};
 const makeDbStructureColumnsShape = (ctx, data, domains, table, tableData) => {
 	const shape = {};
 	const checks = tableData ? getDbTableColumnsChecks(tableData) : void 0;
+	const dbTable = tableData ? table : void 0;
 	for (const item of table.columns) {
-		const [key, column] = dbColumnToAst(ctx, data, domains, table.name, item, table, tableData, checks);
+		const [key, column] = dbColumnToAst(ctx, data, domains, table.name, item, dbTable, tableData, checks);
 		shape[key] = column;
 	}
 	return shape;