Home / File/ refresh-materialized-view.ts — drizzle-orm Source File

refresh-materialized-view.ts — drizzle-orm Source File

Architecture documentation for refresh-materialized-view.ts, a typescript file in the drizzle-orm codebase. 8 imports, 0 dependents.

File typescript DrizzleORM QueryBuilders 8 imports 1 classes

Entity Profile

Dependency Diagram

graph LR
  407d31e6_0821_26fb_d684_39fb0c14d1f7["refresh-materialized-view.ts"]
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  407d31e6_0821_26fb_d684_39fb0c14d1f7 --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  f86d3f7c_7b46_5b9f_94e2_ac0a5f48d903["dialect.ts"]
  407d31e6_0821_26fb_d684_39fb0c14d1f7 --> f86d3f7c_7b46_5b9f_94e2_ac0a5f48d903
  90dfe595_29ab_0495_4263_3b19b4bb4d9b["session.ts"]
  407d31e6_0821_26fb_d684_39fb0c14d1f7 --> 90dfe595_29ab_0495_4263_3b19b4bb4d9b
  bf1c2706_39d8_f0dc_eef7_5f34428539b3["view.ts"]
  407d31e6_0821_26fb_d684_39fb0c14d1f7 --> bf1c2706_39d8_f0dc_eef7_5f34428539b3
  6acf5c54_62a7_1da1_984a_7374cbb9983e["query-promise.ts"]
  407d31e6_0821_26fb_d684_39fb0c14d1f7 --> 6acf5c54_62a7_1da1_984a_7374cbb9983e
  05d1039e_d7d0_0fa1_6f52_956655638080["runnable-query.ts"]
  407d31e6_0821_26fb_d684_39fb0c14d1f7 --> 05d1039e_d7d0_0fa1_6f52_956655638080
  be483a7f_d5d7_7a9b_9a13_44a4a6aafbbd["sql.ts"]
  407d31e6_0821_26fb_d684_39fb0c14d1f7 --> be483a7f_d5d7_7a9b_9a13_44a4a6aafbbd
  051cc2d2_fe6f_16df_aaec_3b341d2c2576["tracing.ts"]
  407d31e6_0821_26fb_d684_39fb0c14d1f7 --> 051cc2d2_fe6f_16df_aaec_3b341d2c2576
  style 407d31e6_0821_26fb_d684_39fb0c14d1f7 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import { entityKind } from '~/entity.ts';
import type { GelDialect } from '~/gel-core/dialect.ts';
import type {
	GelPreparedQuery,
	GelQueryResultHKT,
	GelQueryResultKind,
	GelSession,
	PreparedQueryConfig,
} from '~/gel-core/session.ts';
import type { GelMaterializedView } from '~/gel-core/view.ts';
import { QueryPromise } from '~/query-promise.ts';
import type { RunnableQuery } from '~/runnable-query.ts';
import type { Query, SQL, SQLWrapper } from '~/sql/sql.ts';
import { tracer } from '~/tracing.ts';

// eslint-disable-next-line @typescript-eslint/no-empty-interface
export interface GelRefreshMaterializedView<TQueryResult extends GelQueryResultHKT>
	extends
		QueryPromise<GelQueryResultKind<TQueryResult, never>>,
		RunnableQuery<GelQueryResultKind<TQueryResult, never>, 'gel'>,
		SQLWrapper
{
	readonly _: {
		readonly dialect: 'gel';
		readonly result: GelQueryResultKind<TQueryResult, never>;
	};
}

export class GelRefreshMaterializedView<TQueryResult extends GelQueryResultHKT>
	extends QueryPromise<GelQueryResultKind<TQueryResult, never>>
	implements RunnableQuery<GelQueryResultKind<TQueryResult, never>, 'gel'>, SQLWrapper
{
	static override readonly [entityKind]: string = 'GelRefreshMaterializedView';

	private config: {
		view: GelMaterializedView;
		concurrently?: boolean;
		withNoData?: boolean;
	};

	constructor(
		view: GelMaterializedView,
		private session: GelSession,
		private dialect: GelDialect,
	) {
		super();
		this.config = { view };
	}

	concurrently(): this {
		if (this.config.withNoData !== undefined) {
			throw new Error('Cannot use concurrently and withNoData together');
		}
		this.config.concurrently = true;
		return this;
	}

	withNoData(): this {
		if (this.config.concurrently !== undefined) {
			throw new Error('Cannot use concurrently and withNoData together');
		}
		this.config.withNoData = true;
		return this;
	}

	/** @internal */
	getSQL(): SQL {
		return this.dialect.buildRefreshMaterializedViewQuery(this.config);
	}

	toSQL(): Query {
		const { typings: _typings, ...rest } = this.dialect.sqlToQuery(this.getSQL());
		return rest;
	}

	/** @internal */
	_prepare(name?: string): GelPreparedQuery<
		PreparedQueryConfig & {
			execute: GelQueryResultKind<TQueryResult, never>;
		}
	> {
		return tracer.startActiveSpan('drizzle.prepareQuery', () => {
			return this.session.prepareQuery(this.dialect.sqlToQuery(this.getSQL()), undefined, name, true);
		});
	}

	prepare(name: string): GelPreparedQuery<
		PreparedQueryConfig & {
			execute: GelQueryResultKind<TQueryResult, never>;
		}
	> {
		return this._prepare(name);
	}

	execute: ReturnType<this['prepare']>['execute'] = (placeholderValues) => {
		return tracer.startActiveSpan('drizzle.operation', () => {
			return this._prepare().execute(placeholderValues);
		});
	};
}

Domain

Subdomains

Dependencies

  • dialect.ts
  • entity.ts
  • query-promise.ts
  • runnable-query.ts
  • session.ts
  • sql.ts
  • tracing.ts
  • view.ts

Frequently Asked Questions

What does refresh-materialized-view.ts do?
refresh-materialized-view.ts is a source file in the drizzle-orm codebase, written in typescript. It belongs to the DrizzleORM domain, QueryBuilders subdomain.
What does refresh-materialized-view.ts depend on?
refresh-materialized-view.ts imports 8 module(s): dialect.ts, entity.ts, query-promise.ts, runnable-query.ts, session.ts, sql.ts, tracing.ts, view.ts.
Where is refresh-materialized-view.ts in the architecture?
refresh-materialized-view.ts is located at drizzle-orm/src/gel-core/query-builders/refresh-materialized-view.ts (domain: DrizzleORM, subdomain: QueryBuilders, directory: drizzle-orm/src/gel-core/query-builders).

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free