Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

PostgrestBuilder

import { PostgrestBuilder } from "https://esm.sh/@supabase/supabase-js@2.103.0/dist/index.d.mts";

abstract

abstract class PostgrestBuilder<ClientOptions extends ClientServerOptions, Result$1, ThrowOnError extends boolean = false> implements PromiseLike<ThrowOnError extends true ? PostgrestResponseSuccess<Result$1> : PostgrestSingleResponse<Result$1>> {

constructor(builder: {

method:

| "GET"

| "HEAD"

| "POST"

| "PATCH"

| "DELETE";

url: URL;

headers: HeadersInit;

schema?: string;

body?: unknown;

shouldThrowOnError?: boolean;

signal?: AbortSignal;

fetch?: Fetch;

isMaybeSingle?: boolean;

shouldStripNulls?: boolean;

urlLengthLimit?: number;

retry?: boolean;

});

private processResponse;

protected body?: unknown;

protected fetch: Fetch;

protected headers: Headers;

protected isMaybeSingle: boolean;

protected method:

| "GET"

| "HEAD"

| "POST"

| "PATCH"

| "DELETE";

protected retryEnabled: boolean;

protected schema?: string;

protected shouldStripNulls: boolean;

protected shouldThrowOnError: boolean;

protected signal?: AbortSignal;

protected url: URL;

protected urlLengthLimit: number;

overrideTypes<NewResult, Options extends {

merge?: boolean;

} = {

merge: true;

}>(): PostgrestBuilder<ClientOptions, IsValidResultOverride<Result$1, NewResult, false, false> extends true ? ContainsNull<Result$1> extends true ? MergePartialResult<NewResult, NonNullable<Result$1>, Options> | null : MergePartialResult<NewResult, Result$1, Options> : CheckMatchingArrayTypes<Result$1, NewResult>, ThrowOnError>;

retry(enabled: boolean): this;

returns<NewResult>(): PostgrestBuilder<ClientOptions, CheckMatchingArrayTypes<Result$1, NewResult>, ThrowOnError>;

setHeader(name: string, value: string): this;

stripNulls(): this;

then<TResult1 = (ThrowOnError extends true ? PostgrestResponseSuccess<Result$1> : PostgrestSingleResponse<Result$1>), TResult2 = never>(onfulfilled?: ((value: ThrowOnError extends true ? PostgrestResponseSuccess<Result$1> : PostgrestSingleResponse<Result$1>) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): PromiseLike<TResult1 | TResult2>;

throwOnError(): this & PostgrestBuilder<ClientOptions, Result$1, true>;

}

§Type Parameters

ClientOptions extends ClientServerOptions

Result$1

ThrowOnError extends boolean = false

§Implements

PromiseLike<ThrowOnError extends true ? PostgrestResponseSuccess<Result$1> : PostgrestSingleResponse<Result$1>>

§Constructors

new PostgrestBuilder(builder: {

method:

| "GET"

| "HEAD"

| "POST"

| "PATCH"

| "DELETE";

url: URL;

headers: HeadersInit;

schema?: string;

body?: unknown;

shouldThrowOnError?: boolean;

signal?: AbortSignal;

fetch?: Fetch;

isMaybeSingle?: boolean;

shouldStripNulls?: boolean;

urlLengthLimit?: number;

retry?: boolean;

})

Creates a builder configured for a specific PostgREST request.

@example

import { PostgrestQueryBuilder } from '@supabase/postgrest-js'

const builder = new PostgrestQueryBuilder(
  new URL('https://xyzcompany.supabase.co/rest/v1/users'),
  { headers: new Headers({ apikey: 'public-anon-key' }) }
)

@example

Creating a Postgrest query builder

import { PostgrestQueryBuilder } from '@supabase/postgrest-js'

const builder = new PostgrestQueryBuilder(
  new URL('https://xyzcompany.supabase.co/rest/v1/users'),
  { headers: new Headers({ apikey: 'public-anon-key' }) }
)

§Properties

processResponse

Process a fetch response and return the standardized postgrest response.

body: unknown

fetch: Fetch

headers: Headers

isMaybeSingle: boolean

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

retryEnabled: boolean

schema: string

shouldStripNulls: boolean

shouldThrowOnError: boolean

signal: AbortSignal

url: URL

urlLengthLimit: number

§Methods

overrideTypes<NewResult, Options extends {

merge?: boolean;

} = {

merge: true;

}>(): PostgrestBuilder<ClientOptions, IsValidResultOverride<Result$1, NewResult, false, false> extends true ? ContainsNull<Result$1> extends true ? MergePartialResult<NewResult, NonNullable<Result$1>, Options> | null : MergePartialResult<NewResult, Result$1, Options> : CheckMatchingArrayTypes<Result$1, NewResult>, ThrowOnError>

Override the type of the returned data field in the response.

@example

// Merge with existing types (default behavior)
const query = supabase
  .from('users')
  .select()
  .overrideTypes<{ custom_field: string }>()

// Replace existing types completely
const replaceQuery = supabase
  .from('users')
  .select()
  .overrideTypes<{ id: number; name: string }, { merge: false }>()

@return

A PostgrestBuilder instance with the new type

@example

Complete Override type of successful response

const { data } = await supabase
  .from('countries')
  .select()
  .overrideTypes<Array<MyType>, { merge: false }>()

@example

@example

Complete Override type of object response

const { data } = await supabase
  .from('countries')
  .select()
  .maybeSingle()
  .overrideTypes<MyType, { merge: false }>()

@example

@example

Partial Override type of successful response

const { data } = await supabase
  .from('countries')
  .select()
  .overrideTypes<Array<{ status: "A" | "B" }>>()

@example

@example

Partial Override type of object response

const { data } = await supabase
  .from('countries')
  .select()
  .maybeSingle()
  .overrideTypes<{ status: "A" | "B" }>()

@example

@example

Example 5

// Merge with existing types (default behavior)
const query = supabase
  .from('users')
  .select()
  .overrideTypes<{ custom_field: string }>()

// Replace existing types completely
const replaceQuery = supabase
  .from('users')
  .select()
  .overrideTypes<{ id: number; name: string }, { merge: false }>()

retry(enabled: boolean): this

@param enabled

Whether to enable retries for this request

@example

// Disable retries for a specific query
const { data, error } = await supabase
  .from('users')
  .select()
  .retry(false)

returns<NewResult>(): PostgrestBuilder<ClientOptions, CheckMatchingArrayTypes<Result$1, NewResult>, ThrowOnError> deprecated

Override the type of the returned data.

@deprecated

Use overrideTypes<yourType, { merge: false }>() method at the end of your call chain instead

setHeader(name: string, value: string): this

Set an HTTP header for the request.

stripNulls(): this

Strip null values from the response data. Properties with null values will be omitted from the returned JSON objects.

Requires PostgREST 11.2.0+.

https://docs.postgrest.org/en/stable/references/api/resource_representation.html#stripped-nulls

@example

With select()

const { data, error } = await supabase
  .from('characters')
  .select()
  .stripNulls()

@example

@example

then<TResult1 = (ThrowOnError extends true ? PostgrestResponseSuccess<Result$1> : PostgrestSingleResponse<Result$1>), TResult2 = never>(onfulfilled?: ((value: ThrowOnError extends true ? PostgrestResponseSuccess<Result$1> : PostgrestSingleResponse<Result$1>) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): PromiseLike<TResult1 | TResult2>

throwOnError(): this & PostgrestBuilder<ClientOptions, Result$1, true>

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