preparePgCreateViewJson() — drizzle-orm Function Reference

Architecture documentation for the preparePgCreateViewJson() function in jsonStatements.ts from the drizzle-orm codebase.

Function typescript DrizzleKit SnapshotSerializer called by 1

Entity Profile

DrizzleKit→ SnapshotSerializer→ preparePgCreateViewJson() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  61c6a849_63cb_31f7_70b3_d5155d2bf4ca["preparePgCreateViewJson()"]
  6139f734_8ada_c641_9fec_9a55cfdf376f["jsonStatements.ts"]
  61c6a849_63cb_31f7_70b3_d5155d2bf4ca -->|defined in| 6139f734_8ada_c641_9fec_9a55cfdf376f
  c7a398db_43c9_7771_09b7_73bc09e703e8["applyPgSnapshotsDiff()"]
  c7a398db_43c9_7771_09b7_73bc09e703e8 -->|calls| 61c6a849_63cb_31f7_70b3_d5155d2bf4ca
  style 61c6a849_63cb_31f7_70b3_d5155d2bf4ca fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/src/jsonStatements.ts lines 3365–3447

export const preparePgCreateViewJson = (
	name: string,
	schema: string,
	definition: string,
	materialized: boolean,
	withNoData: boolean = false,
	withOption?: any,
	using?: string,
	tablespace?: string,
): JsonCreatePgViewStatement => {
	return {
		type: 'create_view',
		name: name,
		schema: schema,
		definition: definition,
		with: withOption,
		materialized: materialized,
		withNoData,
		using,
		tablespace,
	};
};

export const prepareMySqlCreateViewJson = (
	name: string,
	definition: string,
	meta: string,
	replace: boolean = false,
): JsonCreateMySqlViewStatement => {
	const { algorithm, sqlSecurity, withCheckOption } = MySqlSquasher.unsquashView(meta);
	return {
		type: 'mysql_create_view',
		name: name,
		definition: definition,
		algorithm,
		sqlSecurity,
		withCheckOption,
		replace,
	};
};

/* export const prepareSingleStoreCreateViewJson = (
	name: string,
	definition: string,
	meta: string,
	replace: boolean = false,
): JsonCreateSingleStoreViewStatement => {
	const { algorithm, sqlSecurity, withCheckOption } = SingleStoreSquasher.unsquashView(meta);
	return {
		type: 'singlestore_create_view',
		name: name,
		definition: definition,
		algorithm,
		sqlSecurity,
		withCheckOption,
		replace,
	};
}; */

export const prepareSqliteCreateViewJson = (
	name: string,
	definition: string,
): JsonCreateSqliteViewStatement => {
	return {
		type: 'sqlite_create_view',
		name: name,
		definition: definition,
	};
};

export const prepareDropViewJson = (
	name: string,
	schema?: string,
	materialized?: boolean,
): JsonDropViewStatement => {
	const resObject: JsonDropViewStatement = <JsonDropViewStatement> { name, type: 'drop_view' };

	if (schema) resObject['schema'] = schema;

	if (materialized) resObject['materialized'] = materialized;