generateGelSnapshot() — drizzle-orm Function Reference

Source Code

drizzle-kit/src/serializer/gelSerializer.ts lines 95–899

const generateGelSnapshot = (
	tables: AnyGelTable[],
	// enums: GelEnum<any>[],
	schemas: GelSchema[],
	sequences: GelSequence[],
	roles: GelRole[],
	policies: GelPolicy[],
	views: GelView[],
	matViews: GelMaterializedView[],
	casing: CasingType | undefined,
	schemaFilter?: string[],
): GelSchemaInternal => {
	const dialect = new GelDialect({ casing });
	const result: Record<string, Table> = {};
	const resultViews: Record<string, View> = {};
	const sequencesToReturn: Record<string, Sequence> = {};
	const rolesToReturn: Record<string, Role> = {};
	// this policies are a separate objects that were linked to a table outside of it
	const policiesToReturn: Record<string, Policy> = {};

	// This object stores unique names for indexes and will be used to detect if you have the same names for indexes
	// within the same PostgreSQL schema

	const indexesInSchema: Record<string, string[]> = {};

	for (const table of tables) {
		// This object stores unique names for checks and will be used to detect if you have the same names for checks
		// within the same PostgreSQL table
		const checksInTable: Record<string, string[]> = {};

		const {
			name: tableName,
			columns,
			indexes,
			foreignKeys,
			checks,
			schema,
			primaryKeys,
			uniqueConstraints,
			policies,
			enableRLS,
		} = getTableConfig(table);

		if (schemaFilter && !schemaFilter.includes(schema ?? 'public')) {
			continue;
		}

		const columnsObject: Record<string, Column> = {};
		const indexesObject: Record<string, Index> = {};
		// const checksObject: Record<string, CheckConstraint> = {};
		const foreignKeysObject: Record<string, ForeignKey> = {};
		const primaryKeysObject: Record<string, PrimaryKey> = {};
		// const uniqueConstraintObject: Record<string, UniqueConstraint> = {};
		const policiesObject: Record<string, Policy> = {};

		columns.forEach((column) => {
			const name = getColumnCasing(column, casing);
			const notNull: boolean = column.notNull;
			const primaryKey: boolean = column.primary;
			const sqlTypeLowered = column.getSQLType().toLowerCase();

			// const typeSchema = is(column, GelEnumColumn) ? column.enum.schema || 'public' : undefined;
			const generated = column.generated;
			const identity = column.generatedIdentity;

			const increment = stringFromIdentityProperty(identity?.sequenceOptions?.increment) ?? '1';
			const minValue = stringFromIdentityProperty(identity?.sequenceOptions?.minValue)
				?? (parseFloat(increment) < 0 ? minRangeForIdentityBasedOn(column.columnType) : '1');
			const maxValue = stringFromIdentityProperty(identity?.sequenceOptions?.maxValue)
				?? (parseFloat(increment) < 0 ? '-1' : maxRangeForIdentityBasedOn(column.getSQLType()));
			const startWith = stringFromIdentityProperty(identity?.sequenceOptions?.startWith)
				?? (parseFloat(increment) < 0 ? maxValue : minValue);
			const cache = stringFromIdentityProperty(identity?.sequenceOptions?.cache) ?? '1';

			const columnToSet: Column = {
				name,
				type: column.getSQLType(),
				typeSchema: undefined,
				primaryKey,
				notNull,
				generated: generated