PostgrestTransformBuilder | @supabase/postgrest-js

Post-filters (transforms)

Type parameters

Hierarchy

PostgrestBuilder<T>
- PostgrestTransformBuilder
  - PostgrestFilterBuilder

Implements

PromiseLike<PostgrestResponse<T>>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

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

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

Properties

Protected allowEmpty

allowEmpty: boolean

Protected Optional body

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

Protected fetch

fetch: Fetch

Protected headers

headers: {}

Type declaration

[key: string]: string

Protected method

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

Protected Optional schema

schema: undefined | string

Protected shouldThrowOnError

shouldThrowOnError: boolean

Protected Optional signal

signal: AbortSignal

Protected url

url: URL

Methods

abortSignal

abortSignal(signal: AbortSignal): this

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

Parameters
- signal: AbortSignal
Returns this

csv

csv(): PromiseLike<PostgrestSingleResponse<string>>

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

Returns PromiseLike<PostgrestSingleResponse<string>>

explain

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

- 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>>>

geojson

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

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

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

limit

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

- 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

maybeSingle

maybeSingle(): PromiseLike<PostgrestMaybeSingleResponse<T>>

- 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>>

order

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

- 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

range

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

- 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

select

select(columns?: string): this

- 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>>

- 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>>

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

Type parameters

T

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

builder: PostgrestBuilder<T>

Returns PostgrestTransformBuilder

Properties

Protected allowEmpty

Protected Optional body

Protected fetch

Protected headers

Type declaration

[key: string]: string

Protected method

Protected Optional schema

Protected shouldThrowOnError

Protected Optional signal

Protected url

Methods

abortSignal

Parameters

signal: AbortSignal

Returns this

csv

Returns PromiseLike<PostgrestSingleResponse<string>>

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>>>

geojson

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

limit

Parameters

count: number

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

foreignTable: undefined | string

Returns this

maybeSingle

Returns PromiseLike<PostgrestMaybeSingleResponse<T>>

order

Parameters

column: keyof T

Default value __namedParameters: { ascending: boolean; foreignTable: undefined | string; nullsFirst: boolean } = {}

ascending: boolean

foreignTable: undefined | string

nullsFirst: boolean

Returns this

range

Parameters

from: number

to: number

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

foreignTable: undefined | string

Returns this

select

Parameters

Default value columns: string = "*"

Returns this

single

Returns PromiseLike<PostgrestSingleResponse<T>>

then

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>