@reactor/data — postgrestquerybuilder

@reactor/data

---

@reactor/data / PostgrestQueryBuilder

Class: PostgrestQueryBuilder<T>

Defined in: builder.ts:346

Builder for SELECT queries with column selection.

Extends

• PostgrestFilterBuilder<T>

Type Parameters

T

T

Constructors

Constructor

new PostgrestQueryBuilder<T>(ctx, table): PostgrestQueryBuilder<T>

Defined in: builder.ts:39

Parameters

ctx

RequestContext

table

string

Returns

PostgrestQueryBuilder<T>

Inherited from

PostgrestFilterBuilder.constructor

Properties

body?

protected optional body?: unknown

Defined in: builder.ts:37

Inherited from

PostgrestFilterBuilder.body

---

countMode?

protected optional countMode?: CountMode

Defined in: builder.ts:30

Inherited from

PostgrestFilterBuilder.countMode

---

ctx

protected ctx: RequestContext

Defined in: builder.ts:24

Inherited from

PostgrestFilterBuilder.ctx

---

customHeaders

protected customHeaders: Record<string, string> = {}

Defined in: builder.ts:32

Inherited from

PostgrestFilterBuilder.customHeaders

---

explainMode?

protected optional explainMode?: object

Defined in: builder.ts:34

analyze?

optional analyze?: boolean

buffers?

optional buffers?: boolean

costs?

optional costs?: boolean

verbose?

optional verbose?: boolean

Inherited from

PostgrestFilterBuilder.explainMode

---

filters

protected filters: PendingFilter[] = []

Defined in: builder.ts:26

Inherited from

PostgrestFilterBuilder.filters

---

limitValue?

protected optional limitValue?: number

Defined in: builder.ts:28

Inherited from

PostgrestFilterBuilder.limitValue

---

method

protected method: "GET" | "POST" | "PATCH" | "DELETE" = 'GET'

Defined in: builder.ts:36

Inherited from

PostgrestFilterBuilder.method

---

offsetValue?

protected optional offsetValue?: number

Defined in: builder.ts:29

Inherited from

PostgrestFilterBuilder.offsetValue

---

orderClauses

protected orderClauses: string[] = []

Defined in: builder.ts:27

Inherited from

PostgrestFilterBuilder.orderClauses

---

responseFormat

protected responseFormat: "json" | "csv" = 'json'

Defined in: builder.ts:33

Inherited from

PostgrestFilterBuilder.responseFormat

---

resultModifier?

protected optional resultModifier?: "single" | "maybeSingle"

Defined in: builder.ts:35

Inherited from

PostgrestFilterBuilder.resultModifier

---

selectColumns

protected selectColumns: string = '*'

Defined in: builder.ts:25

Inherited from

PostgrestFilterBuilder.selectColumns

---

signalValue?

protected optional signalValue?: AbortSignal

Defined in: builder.ts:31

Inherited from

PostgrestFilterBuilder.signalValue

---

table

protected table: string

Defined in: builder.ts:23

Inherited from

PostgrestFilterBuilder.table

Methods

abortSignal()

abortSignal(signal): this

Defined in: builder.ts:199

Provide an AbortSignal

Parameters

signal

AbortSignal

Returns

this

Inherited from

PostgrestFilterBuilder.abortSignal

---

buildHeaders()

protected buildHeaders(): Record<string, string>

Defined in: builder.ts:264

Returns

Record<string, string>

Inherited from

PostgrestFilterBuilder.buildHeaders

---

buildUrl()

protected buildUrl(): string

Defined in: builder.ts:233

Returns

string

Inherited from

PostgrestFilterBuilder.buildUrl

---

containedBy()

containedBy<K>(column, values): this

Defined in: builder.ts:111

Array contained by

Type Parameters

K

K extends string

Parameters

column

K

values

unknown[]

Returns

this

Inherited from

PostgrestFilterBuilder.containedBy

---

contains()

contains<K>(column, values): this

Defined in: builder.ts:105

Array contains

Type Parameters

K

K extends string

Parameters

column

K

values

unknown[]

Returns

this

Inherited from

PostgrestFilterBuilder.contains

---

csv()

csv(): PostgrestFilterBuilder<T, string>

Defined in: builder.ts:205

Return CSV instead of JSON

Returns

PostgrestFilterBuilder<T, string>

Inherited from

PostgrestFilterBuilder.csv

---

delete()

delete(options?): PostgrestFilterBuilder<T>

Defined in: builder.ts:387

Delete row(s)

Parameters

options?

count?

CountMode

Returns

PostgrestFilterBuilder<T>

---

eq()

eq<K>(column, value): this

Defined in: builder.ts:45

Equal to

Type Parameters

K

K extends string

Parameters

column

K

value

T[K]

Returns

this

Inherited from

PostgrestFilterBuilder.eq

---

execute()

protected execute(): Promise<Result<unknown>>

Defined in: builder.ts:312

Returns

Promise<Result<unknown>>

Inherited from

PostgrestFilterBuilder.execute

---

explain()

explain(options?): this

Defined in: builder.ts:211

Return query execution plan

Parameters

options?

analyze?

boolean

buffers?

boolean

costs?

boolean

verbose?

boolean

Returns

this

Inherited from

PostgrestFilterBuilder.explain

---

filter()

filter<K>(column, operator, value): this

Defined in: builder.ts:154

Generic filter (escape hatch)

Type Parameters

K

K extends string

Parameters

column

K

operator

FilterOperator

value

FilterValue

Returns

this

Inherited from

PostgrestFilterBuilder.filter

---

gt()

gt<K>(column, value): this

Defined in: builder.ts:57

Greater than

Type Parameters

K

K extends string

Parameters

column

K

value

T[K]

Returns

this

Inherited from

PostgrestFilterBuilder.gt

---

gte()

gte<K>(column, value): this

Defined in: builder.ts:63

Greater than or equal

Type Parameters

K

K extends string

Parameters

column

K

value

T[K]

Returns

this

Inherited from

PostgrestFilterBuilder.gte

---

ilike()

ilike<K>(column, pattern): this

Defined in: builder.ts:87

Case-insensitive pattern match (ILIKE)

Type Parameters

K

K extends string

Parameters

column

K

pattern

string

Returns

this

Inherited from

PostgrestFilterBuilder.ilike

---

in()

in<K>(column, values): this

Defined in: builder.ts:99

In list

Type Parameters

K

K extends string

Parameters

column

K

values

T[K][]

Returns

this

Inherited from

PostgrestFilterBuilder.in

---

insert()

insert(values, options?): PostgrestFilterBuilder<T>

Defined in: builder.ts:359

Insert row(s)

Parameters

values

Partial<T> | Partial<T>[]

options?

count?

CountMode

Returns

PostgrestFilterBuilder<T>

---

is()

is<K>(column, value): this

Defined in: builder.ts:93

Is NULL or boolean

Type Parameters

K

K extends string

Parameters

column

K

value

boolean | null

Returns

this

Inherited from

PostgrestFilterBuilder.is

---

like()

like<K>(column, pattern): this

Defined in: builder.ts:81

Pattern match (LIKE)

Type Parameters

K

K extends string

Parameters

column

K

pattern

string

Returns

this

Inherited from

PostgrestFilterBuilder.like

---

limit()

limit(count, options?): this

Defined in: builder.ts:177

Limit results

Parameters

count

number

options?

foreignTable?

string

Returns

this

Inherited from

PostgrestFilterBuilder.limit

---

lt()

lt<K>(column, value): this

Defined in: builder.ts:69

Less than

Type Parameters

K

K extends string

Parameters

column

K

value

T[K]

Returns

this

Inherited from

PostgrestFilterBuilder.lt

---

lte()

lte<K>(column, value): this

Defined in: builder.ts:75

Less than or equal

Type Parameters

K

K extends string

Parameters

column

K

value

T[K]

Returns

this

Inherited from

PostgrestFilterBuilder.lte

---

match()

match(query): this

Defined in: builder.ts:131

Match multiple conditions (shorthand for multiple eq)

Parameters

query

Partial<T>

Returns

this

Inherited from

PostgrestFilterBuilder.match

---

maybeSingle()

maybeSingle(): PostgrestFilterBuilder<T, T | null>

Defined in: builder.ts:228

Execute and return zero or one row

Returns

PostgrestFilterBuilder<T, T | null>

Inherited from

PostgrestFilterBuilder.maybeSingle

---

neq()

neq<K>(column, value): this

Defined in: builder.ts:51

Not equal to

Type Parameters

K

K extends string

Parameters

column

K

value

T[K]

Returns

this

Inherited from

PostgrestFilterBuilder.neq

---

not()

not<K>(column, operator, value): this

Defined in: builder.ts:141

Negate a filter

Type Parameters

K

K extends string

Parameters

column

K

operator

FilterOperator

value

FilterValue

Returns

this

Inherited from

PostgrestFilterBuilder.not

---

or()

or(conditions, options?): this

Defined in: builder.ts:147

OR condition (raw string format)

Parameters

conditions

string

options?

foreignTable?

string

Returns

this

Inherited from

PostgrestFilterBuilder.or

---

order()

order<K>(column, options?): this

Defined in: builder.ts:160

Order results

Type Parameters

K

K extends string

Parameters

column

K

options?

OrderOptions

Returns

this

Inherited from

PostgrestFilterBuilder.order

---

overlaps()

overlaps<K>(column, values): this

Defined in: builder.ts:117

Array overlaps

Type Parameters

K

K extends string

Parameters

column

K

values

unknown[]

Returns

this

Inherited from

PostgrestFilterBuilder.overlaps

---

range()

range(from, to, options?): this

Defined in: builder.ts:187

Offset results (for pagination)

Parameters

from

number

to

number

options?

foreignTable?

string

Returns

this

Inherited from

PostgrestFilterBuilder.range

---

returns()

returns<R>(): PostgrestFilterBuilder<R, R[]>

Defined in: builder.ts:217

Override return type

Type Parameters

R

R

Returns

PostgrestFilterBuilder<R, R[]>

Inherited from

PostgrestFilterBuilder.returns

---

select()

select<Columns>(columns?, options?): PostgrestFilterBuilder<T>

Defined in: builder.ts:348

Select specific columns

Type Parameters

Columns

Columns extends string = "*"

Parameters

columns?

Columns

options?

count?

CountMode

Returns

PostgrestFilterBuilder<T>

---

single()

single(): PostgrestFilterBuilder<T, T>

Defined in: builder.ts:222

Execute and return exactly one row (throws if not exactly one)

Returns

PostgrestFilterBuilder<T, T>

Inherited from

PostgrestFilterBuilder.single

---

textSearch()

textSearch<K>(column, query, options?): this

Defined in: builder.ts:123

Full-text search

Type Parameters

K

K extends string

Parameters

column

K

query

string

options?

TextSearchOptions

Returns

this

Inherited from

PostgrestFilterBuilder.textSearch

---

then()

then<TResult1, TResult2>(onfulfilled?, _onrejected?): Promise<TResult1 | TResult2>

Defined in: builder.ts:292

Execute the query

Type Parameters

TResult1

TResult1 = Result<ResultType>

TResult2

TResult2 = never

Parameters

onfulfilled?

((value) => TResult1 | PromiseLike<TResult1>) | null

_onrejected?

((reason) => TResult2 | PromiseLike<TResult2>) | null

Returns

Promise<TResult1 | TResult2>

Inherited from

PostgrestFilterBuilder.then

---

throwOnError()

throwOnError(): Promise<T[]>

Defined in: builder.ts:328

Throw on error instead of returning { data, error }

Returns

Promise<T[]>

Inherited from

PostgrestFilterBuilder.throwOnError

---

update()

update(values, options?): PostgrestFilterBuilder<T>

Defined in: builder.ts:379

Update row(s)

Parameters

values

Partial<T>

options?

count?

CountMode

Returns

PostgrestFilterBuilder<T>

---

upsert()

upsert(values, options?): PostgrestFilterBuilder<T>

Defined in: builder.ts:367

Upsert row(s)

Parameters

values

Partial<T> | Partial<T>[]

options?

UpsertOptions

Returns

PostgrestFilterBuilder<T>