Home / Class/ MySqlCountBuilder Class — drizzle-orm Architecture

MySqlCountBuilder Class — drizzle-orm Architecture

Architecture documentation for the MySqlCountBuilder class in count.ts from the drizzle-orm codebase.

Entity Profile

Dependency Diagram

graph TD
  7ca41881_9524_bd95_d93b_aa44d5e89fa7["MySqlCountBuilder"]
  eee8ef5a_a55a_1296_0eb0_8b784d2ecf58["count.ts"]
  7ca41881_9524_bd95_d93b_aa44d5e89fa7 -->|defined in| eee8ef5a_a55a_1296_0eb0_8b784d2ecf58
  6261180a_f546_fc42_f336_61946fd294d0["buildEmbeddedCount()"]
  7ca41881_9524_bd95_d93b_aa44d5e89fa7 -->|method| 6261180a_f546_fc42_f336_61946fd294d0
  c009b554_f184_1c54_fa5b_bf0a0e5df73f["buildCount()"]
  7ca41881_9524_bd95_d93b_aa44d5e89fa7 -->|method| c009b554_f184_1c54_fa5b_bf0a0e5df73f
  6d22c227_e20e_6c6f_6c2b_f80c229811b3["constructor()"]
  7ca41881_9524_bd95_d93b_aa44d5e89fa7 -->|method| 6d22c227_e20e_6c6f_6c2b_f80c229811b3
  37a67c64_be88_efea_e0f4_79037ba94146["then()"]
  7ca41881_9524_bd95_d93b_aa44d5e89fa7 -->|method| 37a67c64_be88_efea_e0f4_79037ba94146
  1c183101_f541_2bbd_103e_26e43888380f["catch()"]
  7ca41881_9524_bd95_d93b_aa44d5e89fa7 -->|method| 1c183101_f541_2bbd_103e_26e43888380f
  2057f344_8505_6fb5_350e_43674c3b291a["finally()"]
  7ca41881_9524_bd95_d93b_aa44d5e89fa7 -->|method| 2057f344_8505_6fb5_350e_43674c3b291a

Relationship Graph

Source Code

drizzle-orm/src/mysql-core/query-builders/count.ts lines 7–79

export class MySqlCountBuilder<
	TSession extends MySqlSession<any, any, any>,
> extends SQL<number> implements Promise<number>, SQLWrapper {
	private sql: SQL<number>;

	static override readonly [entityKind] = 'MySqlCountBuilder';
	[Symbol.toStringTag] = 'MySqlCountBuilder';

	private session: TSession;

	private static buildEmbeddedCount(
		source: MySqlTable | MySqlViewBase | SQL | SQLWrapper,
		filters?: SQL<unknown>,
	): SQL<number> {
		return sql<number>`(select count(*) from ${source}${sql.raw(' where ').if(filters)}${filters})`;
	}

	private static buildCount(
		source: MySqlTable | MySqlViewBase | SQL | SQLWrapper,
		filters?: SQL<unknown>,
	): SQL<number> {
		return sql<number>`select count(*) as count from ${source}${sql.raw(' where ').if(filters)}${filters}`;
	}

	constructor(
		readonly params: {
			source: MySqlTable | MySqlViewBase | SQL | SQLWrapper;
			filters?: SQL<unknown>;
			session: TSession;
		},
	) {
		super(MySqlCountBuilder.buildEmbeddedCount(params.source, params.filters).queryChunks);

		this.mapWith(Number);

		this.session = params.session;

		this.sql = MySqlCountBuilder.buildCount(
			params.source,
			params.filters,
		);
	}

	then<TResult1 = number, TResult2 = never>(
		onfulfilled?: ((value: number) => TResult1 | PromiseLike<TResult1>) | null | undefined,
		onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null | undefined,
	): Promise<TResult1 | TResult2> {
		return Promise.resolve(this.session.count(this.sql))
			.then(
				onfulfilled,
				onrejected,
			);
	}

	catch(
		onRejected?: ((reason: any) => never | PromiseLike<never>) | null | undefined,
	): Promise<number> {
		return this.then(undefined, onRejected);
	}

	finally(onFinally?: (() => void) | null | undefined): Promise<number> {
		return this.then(
			(value) => {
				onFinally?.();
				return value;
			},
			(reason) => {
				onFinally?.();
				throw reason;
			},
		);
	}
}

Domain

Frequently Asked Questions

What is the MySqlCountBuilder class?
MySqlCountBuilder is a class in the drizzle-orm codebase, defined in drizzle-orm/src/mysql-core/query-builders/count.ts.
Where is MySqlCountBuilder defined?
MySqlCountBuilder is defined in drizzle-orm/src/mysql-core/query-builders/count.ts at line 7.

Analyze Your Own Codebase

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

Try Supermodel Free