PgwasmTransaction

Defined in: packages/pgwasm/src/drizzle/session.ts:100

Extends

• PgAsyncTransaction<PgwasmQueryResultHKT, TRelations>

Type Parameters

TRelations

TRelations extends AnyRelations

Constructors

Constructor

new PgwasmTransaction<TRelations>(dialect, session, relations, nestedIndex, parseRqbJson): PgwasmTransaction<TRelations>

Defined in: packages/pgwasm/src/drizzle/session.ts:108

Parameters

dialect

PgDialect

session

PgwasmSession<TRelations>

relations

TRelations

nestedIndex

number | undefined

parseRqbJson

boolean | undefined

Returns

PgwasmTransaction<TRelations>

Overrides

PgAsyncTransaction< PgwasmQueryResultHKT, TRelations >.constructor

Properties

_

readonly _: object

Defined in: node_modules/.bun/drizzle-orm@1.0.0-rc.4+7a682c4b82ae109f/node_modules/drizzle-orm/pg-core/async/db.d.ts:30

relations

readonly relations: TRelations

session

readonly session: PgAsyncSession<PgwasmQueryResultHKT, TRelations>

Inherited from

PgAsyncTransaction._

---

$cache

$cache: object

Defined in: node_modules/.bun/drizzle-orm@1.0.0-rc.4+7a682c4b82ae109f/node_modules/drizzle-orm/pg-core/async/db.d.ts:74

invalidate

invalidate: (params) => Promise<void>

Invoked if insert, update, delete was invoked

Parameters

params

MutationOption

Returns

Promise<void>

Inherited from

PgAsyncTransaction.$cache

---

$with

$with: WithBuilder

Defined in: node_modules/.bun/drizzle-orm@1.0.0-rc.4+7a682c4b82ae109f/node_modules/drizzle-orm/pg-core/async/db.d.ts:72

Creates a subquery that defines a temporary named result set as a CTE.

It is useful for breaking down complex queries into simpler parts and for reusing the result set in subsequent parts of the query.

See docs: https://orm.drizzle.team/docs/select#with-clause

Param

alias

The alias for the subquery.

Failure to provide an alias will result in a DrizzleTypeError, preventing the subquery from being referenced in other queries.

Example

// Create a subquery with alias 'sq' and use it in the select query
const sq = db.$with('sq').as(db.select().from(users).where(eq(users.id, 42)));

const result = await db.with(sq).select().from(sq);

To select arbitrary SQL values as fields in a CTE and reference them in other CTEs or in the main query, you need to add aliases to them:

// Select an arbitrary SQL value as a field in a CTE and reference it in the main query
const sq = db.$with('sq').as(db.select({
  name: sql<string>`upper(${users.name})`.as('name'),
})
.from(users));

const result = await db.with(sq).select({ name: sq.name }).from(sq);

Inherited from

PgAsyncTransaction.$with

---

query

query: { [K in string | number | symbol]: RelationalQueryBuilder<TRelations, TRelations[K], PgAsyncRelationalQueryHKT> }

Defined in: node_modules/.bun/drizzle-orm@1.0.0-rc.4+7a682c4b82ae109f/node_modules/drizzle-orm/pg-core/async/db.d.ts:34

Inherited from

PgAsyncTransaction.query

---

tagged

readonly tagged: boolean

Defined in: node_modules/.bun/drizzle-orm@1.0.0-rc.4+7a682c4b82ae109f/node_modules/drizzle-orm/pg-core/async/db.d.ts:28

Inherited from

PgAsyncTransaction.tagged

---

[entityKind]

readonly static [entityKind]: string = "PgwasmTransaction"

Defined in: packages/pgwasm/src/drizzle/session.ts:104

Overrides

PgAsyncTransaction.[entityKind]

Methods

$count()

$count(source, filters?): PgAsyncCountBuilder

Defined in: node_modules/.bun/drizzle-orm@1.0.0-rc.4+7a682c4b82ae109f/node_modules/drizzle-orm/pg-core/async/db.d.ts:73

Parameters

source

SQLWrapper<unknown> | PgTable<TableConfig> | SQL<unknown> | PgViewBase<string, boolean, ColumnsSelection>

filters?

SQL<unknown>

Returns

PgAsyncCountBuilder

Inherited from

PgAsyncTransaction.$count

---

delete()

delete<TTable>(table): PgAsyncDeleteBase<TTable, PgwasmQueryResultHKT>

Defined in: node_modules/.bun/drizzle-orm@1.0.0-rc.4+7a682c4b82ae109f/node_modules/drizzle-orm/pg-core/async/db.d.ts:281

Creates a delete query.

Calling this method without .where() clause will delete all rows in a table. The .where() clause specifies which rows should be deleted.

See docs: https://orm.drizzle.team/docs/delete

Type Parameters

TTable

TTable extends PgTable<TableConfig>

Parameters

table

TTable

The table to delete from.

Returns

PgAsyncDeleteBase<TTable, PgwasmQueryResultHKT>

Example

// Delete all rows in the 'cars' table
await db.delete(cars);

// Delete rows with filters and conditions
await db.delete(cars).where(eq(cars.color, 'green'));

// Delete with returning clause
const deletedCar: Car[] = await db.delete(cars)
  .where(eq(cars.id, 1))
  .returning();

Inherited from

PgAsyncTransaction.delete

---

execute()

execute<TRow>(query): PgAsyncRaw<Results<Assume<TRow, Row>>>

Defined in: node_modules/.bun/drizzle-orm@1.0.0-rc.4+7a682c4b82ae109f/node_modules/drizzle-orm/pg-core/async/db.d.ts:283

Type Parameters

TRow

TRow extends Record<string, unknown> = Record<string, unknown>

Parameters

query

string | SQLWrapper<unknown>

Returns

PgAsyncRaw<Results<Assume<TRow, Row>>>

Inherited from

PgAsyncTransaction.execute

---

insert()

insert<TTable>(table): PgInsertBuilder<TTable, PgwasmQueryResultHKT, false, PgAsyncInsertHKT>

Defined in: node_modules/.bun/drizzle-orm@1.0.0-rc.4+7a682c4b82ae109f/node_modules/drizzle-orm/pg-core/async/db.d.ts:256

Creates an insert query.

Calling this method will create new rows in a table. Use .values() method to specify which values to insert.

See docs: https://orm.drizzle.team/docs/insert

Type Parameters

TTable

TTable extends PgTable<TableConfig>

Parameters

table

TTable

The table to insert into.

Returns

PgInsertBuilder<TTable, PgwasmQueryResultHKT, false, PgAsyncInsertHKT>

Example

// Insert one row
await db.insert(cars).values({ brand: 'BMW' });

// Insert multiple rows
await db.insert(cars).values([{ brand: 'BMW' }, { brand: 'Porsche' }]);

// Insert with returning clause
const insertedCar: Car[] = await db.insert(cars)
  .values({ brand: 'BMW' })
  .returning();

Inherited from

PgAsyncTransaction.insert

---

refreshMaterializedView()

refreshMaterializedView<TView>(view): PgAsyncRefreshMaterializedView<PgwasmQueryResultHKT>

Defined in: node_modules/.bun/drizzle-orm@1.0.0-rc.4+7a682c4b82ae109f/node_modules/drizzle-orm/pg-core/async/db.d.ts:282

Type Parameters

TView

TView extends PgMaterializedView<string, boolean, ColumnsSelection>

Parameters

view

TView

Returns

PgAsyncRefreshMaterializedView<PgwasmQueryResultHKT>

Inherited from

PgAsyncTransaction.refreshMaterializedView

---

rollback()

rollback(): never

Defined in: node_modules/.bun/drizzle-orm@1.0.0-rc.4+7a682c4b82ae109f/node_modules/drizzle-orm/pg-core/async/session.d.ts:46

Returns

never

Inherited from

PgAsyncTransaction.rollback

---

select()

Call Signature

select(): PgAsyncSelectBuilder<undefined>

Defined in: node_modules/.bun/drizzle-orm@1.0.0-rc.4+7a682c4b82ae109f/node_modules/drizzle-orm/pg-core/async/db.d.ts:149

Creates a select query.

Calling this method with no arguments will select all columns from the table. Pass a selection object to specify the columns you want to select.

Use .from() method to specify which table to select from.

See docs: https://orm.drizzle.team/docs/select

Returns

PgAsyncSelectBuilder<undefined>

Example

// Select all columns and all rows from the 'cars' table
const allCars: Car[] = await db.select().from(cars);

// Select specific columns and all rows from the 'cars' table
const carsIdsAndBrands: { id: number; brand: string }[] = await db.select({
  id: cars.id,
  brand: cars.brand
})
  .from(cars);

Like in SQL, you can use arbitrary expressions as selection fields, not just table columns:

// Select specific columns along with expression and all rows from the 'cars' table
const carsIdsAndLowerNames: { id: number; lowerBrand: string }[] = await db.select({
  id: cars.id,
  lowerBrand: sql<string>`lower(${cars.brand})`,
})
  .from(cars);

Inherited from

PgAsyncTransaction.select

Call Signature

select<TSelection>(fields): PgAsyncSelectBuilder<TSelection>

Defined in: node_modules/.bun/drizzle-orm@1.0.0-rc.4+7a682c4b82ae109f/node_modules/drizzle-orm/pg-core/async/db.d.ts:150

Creates a select query.

Calling this method with no arguments will select all columns from the table. Pass a selection object to specify the columns you want to select.

Use .from() method to specify which table to select from.

See docs: https://orm.drizzle.team/docs/select

Type Parameters

TSelection

TSelection extends SelectedFields

Parameters

fields

TSelection

The selection object.

Returns

PgAsyncSelectBuilder<TSelection>

Example

// Select all columns and all rows from the 'cars' table
const allCars: Car[] = await db.select().from(cars);

// Select specific columns and all rows from the 'cars' table
const carsIdsAndBrands: { id: number; brand: string }[] = await db.select({
  id: cars.id,
  brand: cars.brand
})
  .from(cars);

Like in SQL, you can use arbitrary expressions as selection fields, not just table columns:

// Select specific columns along with expression and all rows from the 'cars' table
const carsIdsAndLowerNames: { id: number; lowerBrand: string }[] = await db.select({
  id: cars.id,
  lowerBrand: sql<string>`lower(${cars.brand})`,
})
  .from(cars);

Inherited from

PgAsyncTransaction.select

---

selectDistinct()

Call Signature

selectDistinct(): PgAsyncSelectBuilder<undefined>

Defined in: node_modules/.bun/drizzle-orm@1.0.0-rc.4+7a682c4b82ae109f/node_modules/drizzle-orm/pg-core/async/db.d.ts:175

Adds distinct expression to the select query.

Calling this method will return only unique values. When multiple columns are selected, it returns rows with unique combinations of values in these columns.

Use .from() method to specify which table to select from.

See docs: https://orm.drizzle.team/docs/select#distinct

Returns

PgAsyncSelectBuilder<undefined>

Example

// Select all unique rows from the 'cars' table
await db.selectDistinct()
  .from(cars)
  .orderBy(cars.id, cars.brand, cars.color);

// Select all unique brands from the 'cars' table
await db.selectDistinct({ brand: cars.brand })
  .from(cars)
  .orderBy(cars.brand);

Inherited from

PgAsyncTransaction.selectDistinct

Call Signature

selectDistinct<TSelection>(fields): PgAsyncSelectBuilder<TSelection>

Defined in: node_modules/.bun/drizzle-orm@1.0.0-rc.4+7a682c4b82ae109f/node_modules/drizzle-orm/pg-core/async/db.d.ts:176

Adds distinct expression to the select query.

Calling this method will return only unique values. When multiple columns are selected, it returns rows with unique combinations of values in these columns.

Use .from() method to specify which table to select from.

See docs: https://orm.drizzle.team/docs/select#distinct

Type Parameters

TSelection

TSelection extends SelectedFields

Parameters

fields

TSelection

The selection object.

Returns

PgAsyncSelectBuilder<TSelection>

Example

// Select all unique rows from the 'cars' table
await db.selectDistinct()
  .from(cars)
  .orderBy(cars.id, cars.brand, cars.color);

// Select all unique brands from the 'cars' table
await db.selectDistinct({ brand: cars.brand })
  .from(cars)
  .orderBy(cars.brand);

Inherited from

PgAsyncTransaction.selectDistinct

---

selectDistinctOn()

Call Signature

selectDistinctOn(on): PgAsyncSelectBuilder<undefined>

Defined in: node_modules/.bun/drizzle-orm@1.0.0-rc.4+7a682c4b82ae109f/node_modules/drizzle-orm/pg-core/async/db.d.ts:202

Adds distinct on expression to the select query.

Calling this method will specify how the unique rows are determined.

Use .from() method to specify which table to select from.

See docs: https://orm.drizzle.team/docs/select#distinct

Parameters

on

(SQLWrapper<unknown> | PgColumn<any, PgColumnBaseConfig<any>, { }>)[]

The expression defining uniqueness.

Returns

PgAsyncSelectBuilder<undefined>

Example

// Select the first row for each unique brand from the 'cars' table
await db.selectDistinctOn([cars.brand])
  .from(cars)
  .orderBy(cars.brand);

// Selects the first occurrence of each unique car brand along with its color from the 'cars' table
await db.selectDistinctOn([cars.brand], { brand: cars.brand, color: cars.color })
  .from(cars)
  .orderBy(cars.brand, cars.color);

Inherited from

PgAsyncTransaction.selectDistinctOn

Call Signature

selectDistinctOn<TSelection>(on, fields): PgAsyncSelectBuilder<TSelection>

Defined in: node_modules/.bun/drizzle-orm@1.0.0-rc.4+7a682c4b82ae109f/node_modules/drizzle-orm/pg-core/async/db.d.ts:203

Adds distinct on expression to the select query.

Calling this method will specify how the unique rows are determined.

Use .from() method to specify which table to select from.

See docs: https://orm.drizzle.team/docs/select#distinct

Type Parameters

TSelection

TSelection extends SelectedFields

Parameters

on

(SQLWrapper<unknown> | PgColumn<any, PgColumnBaseConfig<any>, { }>)[]

The expression defining uniqueness.

fields

TSelection

The selection object.

Returns

PgAsyncSelectBuilder<TSelection>

Example

// Select the first row for each unique brand from the 'cars' table
await db.selectDistinctOn([cars.brand])
  .from(cars)
  .orderBy(cars.brand);

// Selects the first occurrence of each unique car brand along with its color from the 'cars' table
await db.selectDistinctOn([cars.brand], { brand: cars.brand, color: cars.color })
  .from(cars)
  .orderBy(cars.brand, cars.color);

Inherited from

PgAsyncTransaction.selectDistinctOn

---

setTransaction()

setTransaction(config): Promise<unknown>

Defined in: node_modules/.bun/drizzle-orm@1.0.0-rc.4+7a682c4b82ae109f/node_modules/drizzle-orm/pg-core/async/session.d.ts:47

Parameters

config

PgTransactionConfig

Returns

Promise<unknown>

Inherited from

PgAsyncTransaction.setTransaction

---

transaction()

transaction<T>(transaction): Promise<T>

Defined in: packages/pgwasm/src/drizzle/session.ts:120

Type Parameters

T

T

Parameters

transaction

(tx) => Promise<T>

Returns

Promise<T>

Overrides

PgAsyncTransaction.transaction

---

update()

update<TTable>(table): PgUpdateBuilder<TTable, PgwasmQueryResultHKT, PgAsyncUpdateHKT>

Defined in: node_modules/.bun/drizzle-orm@1.0.0-rc.4+7a682c4b82ae109f/node_modules/drizzle-orm/pg-core/async/db.d.ts:231

Creates an update query.

Calling this method without .where() clause will update all rows in a table. The .where() clause specifies which rows should be updated.

Use .set() method to specify which values to update.

See docs: https://orm.drizzle.team/docs/update

Type Parameters

TTable

TTable extends PgTable<TableConfig>

Parameters

table

TTable

The table to update.

Returns

PgUpdateBuilder<TTable, PgwasmQueryResultHKT, PgAsyncUpdateHKT>

Example

// Update all rows in the 'cars' table
await db.update(cars).set({ color: 'red' });

// Update rows with filters and conditions
await db.update(cars).set({ color: 'red' }).where(eq(cars.brand, 'BMW'));

// Update with returning clause
const updatedCar: Car[] = await db.update(cars)
  .set({ color: 'red' })
  .where(eq(cars.id, 1))
  .returning();

Inherited from

PgAsyncTransaction.update

---

with()

with(…queries): object

Defined in: node_modules/.bun/drizzle-orm@1.0.0-rc.4+7a682c4b82ae109f/node_modules/drizzle-orm/pg-core/async/db.d.ts:96

Incorporates a previously defined CTE (using $with) into the main query.

This method allows the main query to reference a temporary named result set.

See docs: https://orm.drizzle.team/docs/select#with-clause

Parameters

queries

…WithSubquery<string, Record<string, unknown>>[]

The CTEs to incorporate into the main query.

Returns

object

delete

delete: <TTable>(table) => PgAsyncDeleteBase<TTable, PgwasmQueryResultHKT>

Type Parameters

TTable

TTable extends PgTable<TableConfig>

Parameters

table

TTable

Returns

PgAsyncDeleteBase<TTable, PgwasmQueryResultHKT>

insert

insert: <TTable>(table) => PgInsertBuilder<TTable, PgwasmQueryResultHKT, false, PgAsyncInsertHKT>

Type Parameters

TTable

TTable extends PgTable<TableConfig>

Parameters

table

TTable

Returns

PgInsertBuilder<TTable, PgwasmQueryResultHKT, false, PgAsyncInsertHKT>

select

select: {(): PgAsyncSelectBuilder<undefined>; <TSelection>(fields): PgAsyncSelectBuilder<TSelection>; }

Call Signature

(): PgAsyncSelectBuilder<undefined>

Returns

PgAsyncSelectBuilder<undefined>

Call Signature

<TSelection>(fields): PgAsyncSelectBuilder<TSelection>

Type Parameters

TSelection

TSelection extends SelectedFields

Parameters

fields

TSelection

Returns

PgAsyncSelectBuilder<TSelection>

selectDistinct

selectDistinct: {(): PgAsyncSelectBuilder<undefined>; <TSelection>(fields): PgAsyncSelectBuilder<TSelection>; }

Call Signature

(): PgAsyncSelectBuilder<undefined>

Returns

PgAsyncSelectBuilder<undefined>

Call Signature

<TSelection>(fields): PgAsyncSelectBuilder<TSelection>

Type Parameters

TSelection

TSelection extends SelectedFields

Parameters

fields

TSelection

Returns

PgAsyncSelectBuilder<TSelection>

selectDistinctOn

selectDistinctOn: {(on): PgAsyncSelectBuilder<undefined>; <TSelection>(on, fields): PgAsyncSelectBuilder<TSelection>; }

Call Signature

(on): PgAsyncSelectBuilder<undefined>

Parameters

on

(SQLWrapper<unknown> | PgColumn<any, PgColumnBaseConfig<any>, { }>)[]

Returns

PgAsyncSelectBuilder<undefined>

Call Signature

<TSelection>(on, fields): PgAsyncSelectBuilder<TSelection>

Type Parameters

TSelection

TSelection extends SelectedFields

Parameters

on

(SQLWrapper<unknown> | PgColumn<any, PgColumnBaseConfig<any>, { }>)[]

fields

TSelection

Returns

PgAsyncSelectBuilder<TSelection>

update

update: <TTable>(table) => PgUpdateBuilder<TTable, PgwasmQueryResultHKT, PgAsyncUpdateHKT>

Type Parameters

TTable

TTable extends PgTable<TableConfig>

Parameters

table

TTable

Returns

PgUpdateBuilder<TTable, PgwasmQueryResultHKT, PgAsyncUpdateHKT>

Example

// Define a subquery 'sq' as a CTE using $with
const sq = db.$with('sq').as(db.select().from(users).where(eq(users.id, 42)));

// Incorporate the CTE 'sq' into the main query and select from it
const result = await db.with(sq).select().from(sq);

Inherited from

PgAsyncTransaction.with