rake-db 2.33.10 → 2.33.11

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Adapter, Column as Column$1, ColumnSchemaConfig, ColumnsByType, ColumnsShape, DbDomainArg, DbResult, DbStructureDomainsMap, DefaultColumnTypes, DefaultPrivileges, DefaultSchemaConfig, EmptyObject, EnumColumn, MaybeArray, MaybePromise, NoPrimaryKeyOption, QueryLogObject, QueryLogOptions, QueryLogger, QuerySchema, RawSqlBase, RecordOptionalString, RecordString, SearchWeight, TableData, TableDataFn, TableDataItem, TableDataMethods, raw } from "pqb/internal";
+import { Adapter, Column as Column$1, ColumnSchemaConfig, ColumnsByType, ColumnsShape, DbDomainArg, DbResult, DbStructureDomainsMap, DefaultColumnTypes, DefaultPrivileges, DefaultSchemaConfig, EmptyObject, EnumColumn, MaybeArray, MaybePromise, NoPrimaryKeyOption, NonUniqDataItem, QueryLogObject, QueryLogOptions, QueryLogger, QuerySchema, RawSqlBase, RecordOptionalString, RecordString, SearchWeight, TableData, TableDataFn, TableDataItem, TableDataMethods, raw } from "pqb/internal";
 import { Db } from "pqb";
 declare namespace DbStructure {
   interface TableNameAndSchemaName {
@@ -463,11 +463,26 @@ interface OneWayChange {
   to: RakeDbAst.ColumnChange;
   using?: RakeDbAst.ChangeTableItem.ChangeUsing;
 }
+interface ColumnForeignKeyChangeInput {
+  columnForeignKey: TableData.ColumnReferences;
+}
+interface NoForeignKeyChangeInput {
+  noForeignKey: true;
+}
+type ChangeInput = Column$1 | OneWayChange | NonUniqDataItem | ColumnForeignKeyChangeInput | NoForeignKeyChangeInput;
 interface TableChangeMethods extends TableMethods, TableDataMethods<string> {
   name(name: string): TableChangeMethods;
   add: Add;
   drop: Add;
-  change(from: Column$1 | OneWayChange, to: Column$1 | OneWayChange, using?: ChangeOptions): Change;
+  foreignKey<Shape>(columns: [string, ...string[]], fnOrTable: () => new () => {
+    columns: {
+      shape: Shape;
+    };
+  }, foreignColumns: [keyof Shape, ...(keyof Shape)[]], options?: TableData.References.Options): NonUniqDataItem;
+  foreignKey(columns: [string, ...string[]], fnOrTable: string, foreignColumns: [string, ...string[]], options?: TableData.References.Options): NonUniqDataItem;
+  foreignKey(fnOrTable: string, foreignColumn: string, options?: TableData.References.Options): ColumnForeignKeyChangeInput;
+  noForeignKey(): NoForeignKeyChangeInput;
+  change(from: ChangeInput, to: ChangeInput, using?: ChangeOptions): Change;
   default(value: unknown | RawSqlBase): OneWayChange;
   nullable(): OneWayChange;
   nonNullable(): OneWayChange;

package/dist/index.js

@@ -544,6 +544,7 @@ const addOrDropChanges = [];
 function add(item, options) {
 	(0, pqb_internal.consumeColumnName)();
 	setName(this, item);
+	if (isNoForeignKeyChangeInput(item)) throw new Error("t.noForeignKey() is only supported in t.change(...)");
 	if (item instanceof pqb_internal.Column) {
 		const result = addOrDrop("add", item, options);
 		if (result.type === "change") return result;
@@ -567,6 +568,7 @@ function add(item, options) {
 const drop = function(item, options) {
 	(0, pqb_internal.consumeColumnName)();
 	setName(this, item);
+	if (isNoForeignKeyChangeInput(item)) throw new Error("t.noForeignKey() is only supported in t.change(...)");
 	if (item instanceof pqb_internal.Column) {
 		const result = addOrDrop("drop", item, options);
 		if (result.type === "change") return result;
@@ -610,6 +612,28 @@ const addOrDrop = (type, item, options) => {
 		dropMode: options?.dropMode
 	};
 };
+const isColumnForeignKeyChangeInput = (item) => {
+	return "columnForeignKey" in item;
+};
+const isNoForeignKeyChangeInput = (item) => {
+	return "noForeignKey" in item;
+};
+const isCheckConstraintItem = (item) => {
+	return !!item.constraint?.check;
+};
+const changeInputToColumnChange = (item, opposite) => {
+	if (item instanceof pqb_internal.Column || "type" in item) return columnTypeToColumnChange(item);
+	if (isColumnForeignKeyChangeInput(item)) return { foreignKeys: [item.columnForeignKey] };
+	if (isNoForeignKeyChangeInput(item)) {
+		if (!isColumnForeignKeyChangeInput(opposite)) throw new Error("t.noForeignKey() in t.change(...) must be paired with t.foreignKey(...)");
+		return { foreignKeys: [] };
+	}
+	if (isCheckConstraintItem(item)) return { checks: [{
+		sql: item.constraint.check,
+		name: item.constraint.name
+	}] };
+	throw new Error("t.change(...) supports t.check(...) only for check constraints in this form");
+};
 const columnTypeToColumnChange = (item, name) => {
 	if (item instanceof pqb_internal.Column) {
 		let column = item;
@@ -641,6 +665,18 @@ const setName = (self, item) => {
 	else if (item instanceof pqb_internal.Column) item.data.name ??= name;
 	else item.name ??= name;
 };
+function foreignKey(...args) {
+	if (Array.isArray(args[0])) {
+		const [columns, fnOrTable, foreignColumns, options] = args;
+		return pqb_internal.tableDataMethods.foreignKey(columns, fnOrTable, foreignColumns, options);
+	}
+	const [fnOrTable, foreignColumn, options] = args;
+	return { columnForeignKey: {
+		fnOrTable,
+		foreignColumns: [foreignColumn],
+		options
+	} };
+}
 const tableChangeMethods = {
 	...tableMethods,
 	...pqb_internal.tableDataMethods,
@@ -652,10 +688,14 @@ const tableChangeMethods = {
 	},
 	add,
 	drop,
+	foreignKey,
+	noForeignKey() {
+		return { noForeignKey: true };
+	},
 	change(from, to, using) {
 		(0, pqb_internal.consumeColumnName)();
-		const f = columnTypeToColumnChange(from);
-		const t = columnTypeToColumnChange(to);
+		const f = changeInputToColumnChange(from, to);
+		const t = changeInputToColumnChange(to, from);
 		setName(this, f);
 		setName(this, t);
 		return {