PostgrestFilterBuilder | @supabase/postgrest-js

Type parameters

Hierarchy

PostgrestTransformBuilder<T>
- PostgrestFilterBuilder

Implements

PromiseLike<PostgrestResponse<T>>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new PostgrestFilterBuilder(builder: PostgrestBuilder<T>): PostgrestFilterBuilder

Inherited from PostgrestBuilder.constructor
- Defined in lib/types.ts:60
Parameters
- builder: PostgrestBuilder<T>
Returns PostgrestFilterBuilder

Properties

adj

adj: rangeAdjacent = this.rangeAdjacent

deprecated: Use rangeAdjacent() instead.

Protected allowEmpty

allowEmpty: boolean

Protected Optional body

body: Partial<T> | Partial<T>[]

cd

cd: containedBy = this.containedBy

deprecated: Use containedBy() instead.

cs

cs: contains = this.contains

deprecated: Use contains() instead.

Protected fetch

fetch: Fetch

Protected headers

headers: {}

Type declaration

[key: string]: string

Protected method

method: "GET" | "HEAD" | "POST" | "PATCH" | "DELETE"

nxl

nxl: rangeGte = this.rangeGte

deprecated: Use rangeGte() instead.

nxr

nxr: rangeLte = this.rangeLte

deprecated: Use rangeLte() instead.

ov

ov: overlaps = this.overlaps

deprecated: Use overlaps() instead.

Protected Optional schema

schema: undefined | string

Protected shouldThrowOnError

shouldThrowOnError: boolean

Protected Optional signal

signal: AbortSignal

sl

sl: rangeLt = this.rangeLt

deprecated: Use rangeLt() instead.

sr

sr: rangeGt = this.rangeGt

deprecated: Use rangeGt() instead.

Protected url

url: URL

Methods

abortSignal

abortSignal(signal: AbortSignal): this

Inherited from PostgrestTransformBuilder.abortSignal
- Defined in lib/PostgrestTransformBuilder.ts:91
Sets the AbortSignal for the fetch request.

Parameters
- signal: AbortSignal
Returns this

containedBy

containedBy(column: keyof T, value: string | T[keyof T][] | object): this

- Defined in lib/PostgrestFilterBuilder.ts:238
Finds all rows whose json, array, or range value on the stated column is contained by the specified value.

Parameters
- column: keyof T
  
  The column to filter on.
- value: string | T[keyof T][] | object
  
  The value to filter with.
Returns this

contains

contains(column: keyof T, value: string | T[keyof T][] | object): this

- Defined in lib/PostgrestFilterBuilder.ts:213
Finds all rows whose json, array, or range value on the stated column contains the values specified in value.

Parameters
- column: keyof T
  
  The column to filter on.
- value: string | T[keyof T][] | object
  
  The value to filter with.
Returns this

csv

csv(): PromiseLike<PostgrestSingleResponse<string>>

Inherited from PostgrestTransformBuilder.csv
- Defined in lib/PostgrestTransformBuilder.ts:119
Set the response type to CSV.

Returns PromiseLike<PostgrestSingleResponse<string>>

eq

eq(column: keyof T, value: T[keyof T]): this

- Defined in lib/PostgrestFilterBuilder.ts:85
Finds all rows whose value on the stated column exactly matches the specified value.

Parameters
- column: keyof T
  
  The column to filter on.
- value: T[keyof T]
  
  The value to filter with.
Returns this

explain

explain(__namedParameters?: { analyze: boolean; buffers: boolean; settings: boolean; verbose: boolean; wal: boolean }): PromiseLike<PostgrestResponse<Record<string, unknown>>>

Inherited from PostgrestTransformBuilder.explain
- Defined in lib/PostgrestTransformBuilder.ts:141
Obtains the EXPLAIN plan for this request.

Parameters
- Default value __namedParameters: { analyze: boolean; buffers: boolean; settings: boolean; verbose: boolean; wal: boolean } = {}
  - analyze: boolean
    
    If true, the query will be executed and the actual run time will be displayed.
  - buffers: boolean
    
    If true, include information on buffer usage.
  - settings: boolean
    
    If true, include information on configuration parameters that affect query planning.
  - verbose: boolean
    
    If true, the query identifier will be displayed and the result will include the output columns of the query.
  - wal: boolean
    
    If true, include information on WAL record generation
Returns PromiseLike<PostgrestResponse<Record<string, unknown>>>

filter

filter(column: keyof T, operator: FilterOperator, value: any): this

- Defined in lib/PostgrestFilterBuilder.ts:452
Finds all rows whose column satisfies the filter.

Parameters
- column: keyof T
  
  The column to filter on.
- operator: FilterOperator
  
  The operator to filter with.
- value: any
  
  The value to filter with.
Returns this

fts

fts(column: keyof T, query: string, __namedParameters?: { config: undefined | string }): this

- Defined in lib/PostgrestFilterBuilder.ts:391
Finds all rows whose tsvector value on the stated column matches to_tsquery(query).

deprecated

Use textSearch() instead.

Parameters
- column: keyof T
  
  The column to filter on.
- query: string
  
  The Postgres tsquery string to filter with.
- Default value __namedParameters: { config: undefined | string } = {}
  - config: undefined | string
    
    The text search configuration to use.
Returns this

geojson

geojson(): PromiseLike<PostgrestSingleResponse<Record<string, unknown>>>

Inherited from PostgrestTransformBuilder.geojson
- Defined in lib/PostgrestTransformBuilder.ts:127
Set the response type to GeoJSON.

Returns PromiseLike<PostgrestSingleResponse<Record<string, unknown>>>

gt

gt(column: keyof T, value: T[keyof T]): this

- Defined in lib/PostgrestFilterBuilder.ts:109
Finds all rows whose value on the stated column is greater than the specified value.

Parameters
- column: keyof T
  
  The column to filter on.
- value: T[keyof T]
  
  The value to filter with.
Returns this

gte

gte(column: keyof T, value: T[keyof T]): this

- Defined in lib/PostgrestFilterBuilder.ts:121
Finds all rows whose value on the stated column is greater than or equal to the specified value.

Parameters
- column: keyof T
  
  The column to filter on.
- value: T[keyof T]
  
  The value to filter with.
Returns this

ilike

ilike(column: keyof T, pattern: string): this

- Defined in lib/PostgrestFilterBuilder.ts:169
Finds all rows whose value in the stated column matches the supplied pattern (case insensitive).

Parameters
- column: keyof T
  
  The column to filter on.
- pattern: string
  
  The pattern to filter with.
Returns this

in

in(column: keyof T, values: T[keyof T][]): this

- Defined in lib/PostgrestFilterBuilder.ts:193
Finds all rows whose value on the stated column is found on the specified values.

Parameters
- column: keyof T
  
  The column to filter on.
- values: T[keyof T][]
  
  The values to filter with.
Returns this

is

is(column: keyof T, value: boolean | null): this

- Defined in lib/PostgrestFilterBuilder.ts:181
A check for exact equality (null, true, false), finds all rows whose value on the stated column exactly match the specified value.

Parameters
- column: keyof T
  
  The column to filter on.
- value: boolean | null
  
  The value to filter with.
Returns this

like

like(column: keyof T, pattern: string): this

- Defined in lib/PostgrestFilterBuilder.ts:157
Finds all rows whose value in the stated column matches the supplied pattern (case sensitive).

Parameters
- column: keyof T
  
  The column to filter on.
- pattern: string
  
  The pattern to filter with.
Returns this

limit

limit(count: number, __namedParameters?: { foreignTable: undefined | string }): this

Inherited from PostgrestTransformBuilder.limit
- Defined in lib/PostgrestTransformBuilder.ts:66
Limits the result with the specified count.

Parameters
- count: number
  
  The maximum no. of rows to limit to.
- Default value __namedParameters: { foreignTable: undefined | string } = {}
  - foreignTable: undefined | string
    
    The foreign table to use (for foreign columns).
Returns this

lt

lt(column: keyof T, value: T[keyof T]): this

- Defined in lib/PostgrestFilterBuilder.ts:133
Finds all rows whose value on the stated column is less than the specified value.

Parameters
- column: keyof T
  
  The column to filter on.
- value: T[keyof T]
  
  The value to filter with.
Returns this

lte

lte(column: keyof T, value: T[keyof T]): this

- Defined in lib/PostgrestFilterBuilder.ts:145
Finds all rows whose value on the stated column is less than or equal to the specified value.

Parameters
- column: keyof T
  
  The column to filter on.
- value: T[keyof T]
  
  The value to filter with.
Returns this

match

match(query: Record<string, unknown>): this

- Defined in lib/PostgrestFilterBuilder.ts:463
Finds all rows whose columns match the specified query object.

Parameters
- query: Record<string, unknown>
  
  The object to filter with, with column names as keys mapped to their filter values.
Returns this

maybeSingle

maybeSingle(): PromiseLike<PostgrestMaybeSingleResponse<T>>

Inherited from PostgrestTransformBuilder.maybeSingle
- Defined in lib/PostgrestTransformBuilder.ts:110
Retrieves at most one row from the result. Result must be at most one row (e.g. using eq on a UNIQUE column), otherwise this will result in an error.

Returns PromiseLike<PostgrestMaybeSingleResponse<T>>

neq

neq(column: keyof T, value: T[keyof T]): this

- Defined in lib/PostgrestFilterBuilder.ts:97
Finds all rows whose value on the stated column doesn't match the specified value.

Parameters
- column: keyof T
  
  The column to filter on.
- value: T[keyof T]
  
  The value to filter with.
Returns this

not

not(column: keyof T, operator: FilterOperator, value: any): this

- Defined in lib/PostgrestFilterBuilder.ts:61
Finds all rows which doesn't satisfy the filter.

Parameters
- column: keyof T
  
  The column to filter on.
- operator: FilterOperator
  
  The operator to filter with.
- value: any
  
  The value to filter with.
Returns this

or

or(filters: string, __namedParameters?: { foreignTable: undefined | string }): this

- Defined in lib/PostgrestFilterBuilder.ts:72
Finds all rows satisfying at least one of the filters.

Parameters
- filters: string
  
  The filters to use, separated by commas.
- Default value __namedParameters: { foreignTable: undefined | string } = {}
  - foreignTable: undefined | string
    
    The foreign table to use (if column is a foreign column).
Returns this

order

order(column: keyof T, __namedParameters?: { ascending: boolean; foreignTable: undefined | string; nullsFirst: boolean }): this

Inherited from PostgrestTransformBuilder.order
- Defined in lib/PostgrestTransformBuilder.ts:40
Orders the result with the specified column.

Parameters
- column: keyof T
  
  The column to order on.
- Default value __namedParameters: { ascending: boolean; foreignTable: undefined | string; nullsFirst: boolean } = {}
  - ascending: boolean
    
    If true, the result will be in ascending order.
  - foreignTable: undefined | string
    
    The foreign table to use (if column is a foreign column).
  - nullsFirst: boolean
    
    If true, nulls appear first.
Returns this

overlaps

overlaps(column: keyof T, value: string | T[keyof T][]): this

- Defined in lib/PostgrestFilterBuilder.ts:337
Finds all rows whose array or range value on the stated column overlaps (has a value in common) with the specified value.

Parameters
- column: keyof T
  
  The column to filter on.
- value: string | T[keyof T][]
  
  The value to filter with.
Returns this

phfts

phfts(column: keyof T, query: string, __namedParameters?: { config: undefined | string }): this

- Defined in lib/PostgrestFilterBuilder.ts:423
Finds all rows whose tsvector value on the stated column matches phraseto_tsquery(query).

deprecated

Use textSearch() with type: 'phrase' instead.

Parameters
- column: keyof T
  
  The column to filter on.
- query: string
  
  The Postgres tsquery string to filter with.
- Default value __namedParameters: { config: undefined | string } = {}
  - config: undefined | string
    
    The text search configuration to use.
Returns this

plfts

plfts(column: keyof T, query: string, __namedParameters?: { config: undefined | string }): this

- Defined in lib/PostgrestFilterBuilder.ts:407
Finds all rows whose tsvector value on the stated column matches plainto_tsquery(query).

deprecated

Use textSearch() with type: 'plain' instead.

Parameters
- column: keyof T
  
  The column to filter on.
- query: string
  
  The Postgres tsquery string to filter with.
- Default value __namedParameters: { config: undefined | string } = {}
  - config: undefined | string
    
    The text search configuration to use.
Returns this

range

range(from: number, to: number, __namedParameters?: { foreignTable: undefined | string }): this

Inherited from PostgrestTransformBuilder.range
- Defined in lib/PostgrestTransformBuilder.ts:79
Limits the result to rows within the specified range, inclusive.

Parameters
- from: number
  
  The starting index from which to limit the result, inclusive.
- to: number
  
  The last index to which to limit the result, inclusive.
- Default value __namedParameters: { foreignTable: undefined | string } = {}
  - foreignTable: undefined | string
    
    The foreign table to use (for foreign columns).
Returns this

rangeAdjacent

rangeAdjacent(column: keyof T, range: string): this

- Defined in lib/PostgrestFilterBuilder.ts:322
Finds all rows whose range value on the stated column is adjacent to the specified range.

Parameters
- column: keyof T
  
  The column to filter on.
- range: string
  
  The range to filter with.
Returns this

rangeGt

rangeGt(column: keyof T, range: string): this

- Defined in lib/PostgrestFilterBuilder.ts:277
Finds all rows whose range value on the stated column is strictly to the right of the specified range.

Parameters
- column: keyof T
  
  The column to filter on.
- range: string
  
  The range to filter with.
Returns this

rangeGte

rangeGte(column: keyof T, range: string): this

- Defined in lib/PostgrestFilterBuilder.ts:292
Finds all rows whose range value on the stated column does not extend to the left of the specified range.

Parameters
- column: keyof T
  
  The column to filter on.
- range: string
  
  The range to filter with.
Returns this

rangeLt

rangeLt(column: keyof T, range: string): this

- Defined in lib/PostgrestFilterBuilder.ts:262
Finds all rows whose range value on the stated column is strictly to the left of the specified range.

Parameters
- column: keyof T
  
  The column to filter on.
- range: string
  
  The range to filter with.
Returns this

rangeLte

rangeLte(column: keyof T, range: string): this

- Defined in lib/PostgrestFilterBuilder.ts:307
Finds all rows whose range value on the stated column does not extend to the right of the specified range.

Parameters
- column: keyof T
  
  The column to filter on.
- range: string
  
  The range to filter with.
Returns this

select

select(columns?: string): this

Inherited from PostgrestTransformBuilder.select
- Defined in lib/PostgrestTransformBuilder.ts:13
Performs vertical filtering with SELECT.

Parameters
- Default value columns: string = "*"
  
  The columns to retrieve, separated by commas.
Returns this

single

single(): PromiseLike<PostgrestSingleResponse<T>>

Inherited from PostgrestTransformBuilder.single
- Defined in lib/PostgrestTransformBuilder.ts:100
Retrieves only one row from the result. Result must be one row (e.g. using limit), otherwise this will result in an error.

Returns PromiseLike<PostgrestSingleResponse<T>>

textSearch

textSearch(column: keyof T, query: string, __namedParameters?: { config: undefined | string; type: null | "plain" | "phrase" | "websearch" }): this

- Defined in lib/PostgrestFilterBuilder.ts:360
Finds all rows whose text or tsvector value on the stated column matches the tsquery in query.

Parameters
- column: keyof T
  
  The column to filter on.
- query: string
  
  The Postgres tsquery string to filter with.
- Default value __namedParameters: { config: undefined | string; type: null | "plain" | "phrase" | "websearch" } = {}
  - config: undefined | string
    
    The text search configuration to use.
  - type: null | "plain" | "phrase" | "websearch"
    
    The type of tsquery conversion to use on query.
Returns this

then

then<TResult1, TResult2>(onfulfilled?: ((value: PostgrestResponse<T>) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): PromiseLike<TResult1 | TResult2>

Inherited from PostgrestBuilder.then
- Defined in lib/types.ts:91
Type parameters
- TResult1 = PostgrestResponse<T>
- TResult2 = never
Parameters
- Optional onfulfilled: ((value: PostgrestResponse<T>) => TResult1 | PromiseLike<TResult1>) | undefined | null
- Optional onrejected: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null
Returns PromiseLike<TResult1 | TResult2>

throwOnError

throwOnError(throwOnError?: undefined | false | true): this

Inherited from PostgrestBuilder.throwOnError
- Defined in lib/types.ts:83
If there's an error with the query, throwOnError will reject the promise by throwing the error instead of returning it as part of a successful response.

https://github.com/supabase/supabase-js/issues/92

Parameters
- Optional throwOnError: undefined | false | true
Returns this

wfts

wfts(column: keyof T, query: string, __namedParameters?: { config: undefined | string }): this

- Defined in lib/PostgrestFilterBuilder.ts:439
Finds all rows whose tsvector value on the stated column matches websearch_to_tsquery(query).

deprecated

Use textSearch() with type: 'websearch' instead.

Parameters
- column: keyof T
  
  The column to filter on.
- query: string
  
  The Postgres tsquery string to filter with.
- Default value __namedParameters: { config: undefined | string } = {}
  - config: undefined | string
    
    The text search configuration to use.
Returns this

Type parameters

T

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

builder: PostgrestBuilder<T>

Returns PostgrestFilterBuilder

Properties

adj

Protected allowEmpty

Protected Optional body

cd

cs

Protected fetch

Protected headers

Type declaration

[key: string]: string

Protected method

nxl

nxr

ov

Protected Optional schema

Protected shouldThrowOnError

Protected Optional signal

sl

sr

Protected url

Methods

abortSignal

Parameters

signal: AbortSignal

Returns this

containedBy

Parameters

column: keyof T

value: string | T[keyof T][] | object

Returns this

contains

Parameters

column: keyof T

value: string | T[keyof T][] | object

Returns this

csv

Returns PromiseLike<PostgrestSingleResponse<string>>

eq

Parameters

column: keyof T

value: T[keyof T]

Returns this

explain

Parameters

Default value __namedParameters: { analyze: boolean; buffers: boolean; settings: boolean; verbose: boolean; wal: boolean } = {}

analyze: boolean

buffers: boolean

settings: boolean

verbose: boolean

wal: boolean

Returns PromiseLike<PostgrestResponse<Record<string, unknown>>>

filter

Parameters

column: keyof T

operator: FilterOperator

value: any

Returns this

fts

Parameters

column: keyof T

query: string

Default value __namedParameters: { config: undefined | string } = {}

config: undefined | string

Returns this

geojson

Returns PromiseLike<PostgrestSingleResponse<Record<string, unknown>>>

gt