Skip to content

feat: Disable null constraints on revisions table #447

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thommymo merged 1 commit into from
Apr 1, 2026
Merged

feat: Disable null constraints on revisions table #447

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
112 changes: 56 additions & 56 deletions src/migrations/generate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ import {
validateCheckConstraint,
validateExcludeConstraint,
} from '../models/utils';
import { getColumnName } from '../resolvers';
import { Value } from '../values';
import { ParsedFunction } from './types';
import {
Expand Down Expand Up @@ -676,26 +675,30 @@ export class MigrationGenerator {

if (isUpdatableModel(model)) {
const updatableFields = fields.filter(and(isUpdatableField, isStoredInDatabase));
if (!updatableFields.length) {
const revisionFieldsNeedingAlter = updatableFields.filter((field) => this.revisionFieldNeedsSchemaAlter(model, field));
if (!revisionFieldsNeedingAlter.length) {
return;
}

up.push(() => {
this.alterTable(`${model.name}Revision`, () => {
for (const [index, field] of updatableFields.entries()) {
this.columnRaw(field, { alter: true }, index);
for (const [index, field] of revisionFieldsNeedingAlter.entries()) {
this.columnRaw(field, { alter: true, setNonNull: false }, index);
}
});
});

down.push(() => {
this.alterTable(`${model.name}Revision`, () => {
for (const [index, field] of updatableFields.entries()) {
for (const [index, field] of revisionFieldsNeedingAlter.entries()) {
this.columnRaw(
field,
{ alter: true },
{ alter: true, setNonNull: false },
index,
summonByName(this.columns[model.name], field.kind === 'relation' ? `${field.name}Id` : field.name),
summonByName(
this.columns[`${model.name}Revision`],
field.kind === 'relation' ? `${field.name}Id` : field.name,
),
);
}
});
Expand Down Expand Up @@ -730,25 +733,29 @@ export class MigrationGenerator {

if (isUpdatableModel(model)) {
const updatableFields = fields.filter(and(isUpdatableField, isStoredInDatabase));
if (!updatableFields.length) {
const revisionFieldsNeedingAlter = updatableFields.filter((field) => this.revisionFieldNeedsSchemaAlter(model, field));
if (!revisionFieldsNeedingAlter.length) {
return;
}

up.push(() => {
this.alterTable(`${model.name}Revision`, () => {
for (const field of updatableFields) {
this.column(field, { alter: true });
for (const field of revisionFieldsNeedingAlter) {
this.column(field, { alter: true, setUnique: false, setNonNull: false, foreign: false });
}
});
});

down.push(() => {
this.alterTable(`${model.name}Revision`, () => {
for (const field of updatableFields) {
for (const field of revisionFieldsNeedingAlter) {
this.column(
field,
{ alter: true },
summonByName(this.columns[model.name], field.kind === 'relation' ? `${field.name}Id` : field.name),
{ alter: true, setUnique: false, setNonNull: false, foreign: false },
summonByName(
this.columns[`${model.name}Revision`],
field.kind === 'relation' ? `${field.name}Id` : field.name,
),
);
}
});
Expand All @@ -774,7 +781,7 @@ export class MigrationGenerator {
}

for (const field of model.fields.filter(and(isUpdatableField, not(isInherited), isStoredInDatabase))) {
this.column(field, { setUnique: false, setDefault: false });
this.column(field, { setUnique: false, setDefault: false, setNonNull: false, foreign: false });
}
});
}
Expand All @@ -786,45 +793,9 @@ export class MigrationGenerator {
// Create missing revision columns
this.alterTable(revisionTable, () => {
for (const field of missingRevisionFields) {
this.column(field, { setUnique: false, setNonNull: false, setDefault: false });
this.column(field, { setUnique: false, setNonNull: false, setDefault: false, foreign: false });
}
});

// Insert data for missing revisions columns
const revisionFieldsWithDataToCopy = missingRevisionFields.filter(
(field) =>
this.columns[model.name].find((col) => col.name === getColumnName(field)) ||
field.defaultValue !== undefined ||
field.nonNull,
);
if (revisionFieldsWithDataToCopy.length) {
this.writer
.write(`await knex('${model.name}Revision').update(`)
.inlineBlock(() => {
for (const { name, kind: type } of revisionFieldsWithDataToCopy) {
const col = type === 'relation' ? `${name}Id` : name;
this.writer
.write(
`${col}: knex.raw('(select "${col}" from "${model.name}" where "${model.name}".id = "${
model.name
}Revision"."${typeToField(model.name)}Id")'),`,
)
.newLine();
}
})
.write(');')
.newLine()
.blankLine();
}

const nonNullableMissingRevisionFields = missingRevisionFields.filter(({ nonNull }) => nonNull);
if (nonNullableMissingRevisionFields.length) {
this.alterTable(revisionTable, () => {
for (const field of nonNullableMissingRevisionFields) {
this.column(field, { setUnique: false, setDefault: false, alter: true });
}
});
}
});

down.push(() => {
Expand Down Expand Up @@ -1616,24 +1587,32 @@ export class MigrationGenerator {
}

private hasChanged(model: EntityModel, field: EntityField) {
return this.hasChangedOnTable(model.name, field, { respectNullability: true });
}

private hasChangedOnTable(tableName: string, field: EntityField, { respectNullability }: { respectNullability: boolean }) {
if (field.generateAs?.type === 'expression') {
return false;
}

const col = this.getColumn(model.name, field.kind === 'relation' ? `${field.name}Id` : field.name);
const col = this.getColumn(tableName, field.kind === 'relation' ? `${field.name}Id` : field.name);
if (!col) {
return false;
}

if (field.generateAs) {
if (col.generation_expression !== field.generateAs.expression) {
throw new Error(
`Column ${col.name} has specific type ${col.generation_expression} but expected ${field.generateAs.expression}`,
);
if (respectNullability) {
throw new Error(
`Column ${col.name} has specific type ${col.generation_expression} but expected ${field.generateAs.expression}`,
);
}

return true;
}
}

if ((!field.nonNull && !col.is_nullable) || (field.nonNull && col.is_nullable)) {
if (respectNullability && ((!field.nonNull && !col.is_nullable) || (field.nonNull && col.is_nullable))) {
return true;
}

Expand Down Expand Up @@ -1679,6 +1658,27 @@ export class MigrationGenerator {
return false;
}

private revisionFieldNeedsSchemaAlter(model: EntityModel, field: EntityField) {
if (field.generateAs?.type === 'expression') {
return false;
}

const tableName = `${model.name}Revision`;
const colName = field.kind === 'relation' ? `${field.name}Id` : field.name;
const revCol = this.getColumn(tableName, colName);
if (!revCol) {
return false;
}

if (field.generateAs) {
if (revCol.generation_expression !== field.generateAs.expression) {
return true;
}
}

return this.hasChangedOnTable(tableName, field, { respectNullability: false });
}

private async handleFunctions(up: Callbacks, down: Callbacks) {
if (!this.parsedFunctions || this.parsedFunctions.length === 0) {
return;
Expand Down
Loading