Database governance built for humans and agents — controlling changes and access across every major database.
Go cicddata-governancedata-maskingdata-securitydatabase-accessdatabase-governancedevopsdevsecopsflywaygitopsliquibasemongodbmysqloraclepostgresqlschema-migrationssecuritysql-clientsqlservertidb
import { create } from "@bufbuild/protobuf";
import { createContextValues } from "@connectrpc/connect";
import { isEqual } from "lodash-es";
import { databaseServiceClientConnect } from "@/api";
import { silentContextKey } from "@/api/context-key";
import type {
Database,
DatabaseMetadata,
} from "@/types/proto-es/v1/database_service_pb";
import { DiffMetadataRequestSchema } from "@/types/proto-es/v1/database_service_pb";
import { extractGrpcErrorMessage } from "@/utils/connect";
import { validateDatabaseMetadata } from "./metadata";
export type GenerateDiffDDLResult = {
statement: string;
errors: string[];
};
export const generateDiffDDL = async ({
database,
sourceMetadata,
targetMetadata,
}: {
database: Database;
sourceMetadata: DatabaseMetadata;
targetMetadata: DatabaseMetadata;
}): Promise<GenerateDiffDDLResult> => {
const finish = (statement: string, errors: string[]) => {
return {
statement,
errors,
};
};
if (isEqual(sourceMetadata, targetMetadata)) {
return finish("", []);
}
const validationMessages = validateDatabaseMetadata(targetMetadata);
if (validationMessages.length > 0) {
return finish("", ["Invalid schema", ...validationMessages]);
}
try {
// The server reads the current (source) schema and engine from the
// database resource; only the target metadata travels in the request.
const newRequest = create(DiffMetadataRequestSchema, {
name: database.name,
targetMetadata: targetMetadata,
});
const diffResponse = await databaseServiceClientConnect.diffMetadata(
newRequest,
{
contextValues: createContextValues().set(silentContextKey, true),
}
);
const { diff } = diffResponse;
if (diff.length === 0) {
return finish("", []);
}
return finish(diff, []);
} catch (ex) {
console.warn("[generateDiffDDL]", ex);
return finish("", [extractGrpcErrorMessage(ex)]);
}
};