pgSuite.indexesToBeTriggered() — drizzle-orm Function Reference

Architecture documentation for the pgSuite.indexesToBeTriggered() function in pg.test.ts from the drizzle-orm codebase.

Function typescript DrizzleORM DatabaseDrivers

Entity Profile

DrizzleORM→ DatabaseDrivers→ pgSuite.indexesToBeTriggered() — drizzle-orm Function Reference

Dependency Diagram

graph TD
  7cc50057_5f4c_8dba_3ea7_97d8c07c1c9d["pgSuite.indexesToBeTriggered()"]
  66244d8b_f6c8_7e4e_5409_4e7e6a4add95["pg.test.ts"]
  7cc50057_5f4c_8dba_3ea7_97d8c07c1c9d -->|defined in| 66244d8b_f6c8_7e4e_5409_4e7e6a4add95
  style 7cc50057_5f4c_8dba_3ea7_97d8c07c1c9d fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

drizzle-kit/tests/indexes/pg.test.ts lines 71–136

	async indexesToBeTriggered() {
		const schema1 = {
			users: pgTable(
				'users',
				{
					id: serial('id').primaryKey(),
					name: text('name'),
				},
				(t) => ({
					indx: index('indx').on(t.name.desc()).concurrently(),
					indx1: index('indx1')
						.on(t.name.desc())
						.where(sql`true`),
					indx2: index('indx2')
						.on(t.name.op('text_ops'))
						.where(sql`true`),
					indx3: index('indx3')
						.on(sql`lower(name)`)
						.where(sql`true`),
				}),
			),
		};

		const schema2 = {
			users: pgTable(
				'users',
				{
					id: serial('id').primaryKey(),
					name: text('name'),
				},
				(t) => ({
					indx: index('indx').on(t.name.desc()),
					indx1: index('indx1')
						.on(t.name.desc())
						.where(sql`false`),
					indx2: index('indx2')
						.on(t.name.op('test'))
						.where(sql`true`),
					indx3: index('indx3')
						.on(sql`lower(${t.id})`)
						.where(sql`true`),
					indx4: index('indx4')
						.on(sql`lower(id)`)
						.where(sql`true`),
				}),
			),
		};

		const { statements, sqlStatements } = await diffTestSchemas(
			schema1,
			schema2,
			[],
		);

		expect(sqlStatements).toStrictEqual([
			'DROP INDEX "indx";',
			'DROP INDEX "indx1";',
			'DROP INDEX "indx2";',
			'DROP INDEX "indx3";',
			'CREATE INDEX "indx4" ON "users" USING btree (lower(id)) WHERE true;',
			'CREATE INDEX "indx" ON "users" USING btree ("name" DESC NULLS LAST);',
			'CREATE INDEX "indx1" ON "users" USING btree ("name" DESC NULLS LAST) WHERE false;',
			'CREATE INDEX "indx2" ON "users" USING btree ("name" test) WHERE true;',
			'CREATE INDEX "indx3" ON "users" USING btree (lower("id")) WHERE true;',
		]);
	},