sequence.ts — drizzle-orm Source File

Architecture documentation for sequence.ts, a typescript file in the drizzle-orm codebase. 1 imports, 2 dependents.

File typescript DrizzleORM DatabaseDrivers 1 imports 2 dependents 3 functions 1 classes

Entity Profile

DrizzleORM→ DatabaseDrivers→ sequence.ts — drizzle-orm Source File

Dependency Diagram

graph LR
  c67b5e95_842f_36c8_80c4_20ed982f5bfe["sequence.ts"]
  27705a9d_afe9_57dd_8c97_e52d8a67d426["entity.ts"]
  c67b5e95_842f_36c8_80c4_20ed982f5bfe --> 27705a9d_afe9_57dd_8c97_e52d8a67d426
  5e8f073a_0845_8d49_1d60_aeb1c020baaf["int.common.ts"]
  5e8f073a_0845_8d49_1d60_aeb1c020baaf --> c67b5e95_842f_36c8_80c4_20ed982f5bfe
  06e0abfd_8dae_0f31_4535_349e0a684907["schema.ts"]
  06e0abfd_8dae_0f31_4535_349e0a684907 --> c67b5e95_842f_36c8_80c4_20ed982f5bfe
  style c67b5e95_842f_36c8_80c4_20ed982f5bfe fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import { entityKind, is } from '~/entity.ts';

export type PgSequenceOptions = {
	increment?: number | string;
	minValue?: number | string;
	maxValue?: number | string;
	startWith?: number | string;
	cache?: number | string;
	cycle?: boolean;
};

export class PgSequence {
	static readonly [entityKind]: string = 'PgSequence';

	constructor(
		public readonly seqName: string | undefined,
		public readonly seqOptions: PgSequenceOptions | undefined,
		public readonly schema: string | undefined,
	) {
	}
}

export function pgSequence(
	name: string,
	options?: PgSequenceOptions,
): PgSequence {
	return pgSequenceWithSchema(name, options, undefined);
}

/** @internal */
export function pgSequenceWithSchema(
	name: string,
	options?: PgSequenceOptions,
	schema?: string,
): PgSequence {
	return new PgSequence(name, options, schema);
}

export function isPgSequence(obj: unknown): obj is PgSequence {
	return is(obj, PgSequence);
}