Type Alias SupabaseFilter

Type declaration

• abortSignal: ((signal: AbortSignal) => this)

  • • (signal): this

    • Set the AbortSignal for the fetch request.

      Parameters

      • signal: AbortSignal

        The AbortSignal to use for the fetch request

      Returns this

• body: unknown

• containedBy: {
      <ColumnName>(column: ColumnName, value: string | readonly any[] | Record<string, unknown>): this;
      (column: string, value: string | readonly unknown[] | Record<string, unknown>): this;
  }

  • • <ColumnName>(column, value): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • value: string | readonly any[] | Record<string, unknown>

      Returns this

    • (column, value): this

    • Parameters

      • column: string
      • value: string | readonly unknown[] | Record<string, unknown>

      Returns this

• contains: {
      <ColumnName>(column: ColumnName, value: string | readonly any[] | Record<string, unknown>): this;
      (column: string, value: string | readonly unknown[] | Record<string, unknown>): this;
  }

  • • <ColumnName>(column, value): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • value: string | readonly any[] | Record<string, unknown>

      Returns this

    • (column, value): this

    • Parameters

      • column: string
      • value: string | readonly unknown[] | Record<string, unknown>

      Returns this

• csv: (() => PostgrestBuilder<string>)

  • • (): PostgrestBuilder<string>

    • Return data as a string in CSV format.

      Returns PostgrestBuilder<string>

• eq: {
      <ColumnName>(column: ColumnName, value: any): this;
      <Value>(column: string, value: NonNullable<Value>): this;
  }

  • • <ColumnName>(column, value): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • value: any

      Returns this

    • <Value>(column, value): this

    • Type Parameters

      • Value extends unknown

      Parameters

      • column: string
      • value: NonNullable<Value>

      Returns this

• explain: ((options?: {
      analyze?: boolean;
      buffers?: boolean;
      format?: "text" | "json";
      settings?: boolean;
      verbose?: boolean;
      wal?: boolean;
  }) => PostgrestBuilder<string> | PostgrestBuilder<Record<string, unknown>[]>)

  • • (options?): PostgrestBuilder<string> | PostgrestBuilder<Record<string, unknown>[]>

    • Return data as the EXPLAIN plan for the query.

      You need to enable the db_plan_enabled setting before using this method.

      Parameters

      • Optionaloptions: {
            analyze?: boolean;
            buffers?: boolean;
            format?: "text" | "json";
            settings?: boolean;
            verbose?: boolean;
            wal?: boolean;
        }

        Named parameters

        • Optionalanalyze?: boolean

          If true, the query will be executed and the actual run time will be returned

        • Optionalbuffers?: boolean

          If true, include information on buffer usage

        • Optionalformat?: "text" | "json"

          The format of the output, can be "text" (default) or "json"

        • Optionalsettings?: boolean

          If true, include information on configuration parameters that affect query planning

        • Optionalverbose?: boolean

          If true, the query identifier will be returned and data will include the output columns of the query

        • Optionalwal?: boolean

          If true, include information on WAL record generation

      Returns PostgrestBuilder<string> | PostgrestBuilder<Record<string, unknown>[]>

• fetch: {
      (input: RequestInfo | URL, init?: RequestInit): Promise<Response>;
      (input: string | Request | URL, init?: RequestInit): Promise<Response>;
  }

  • • (input, init?): Promise<Response>

    • MDN Reference

      Parameters

      • input: RequestInfo | URL
      • Optionalinit: RequestInit

      Returns Promise<Response>
    • (input, init?): Promise<Response>

    • Parameters

      • input: string | Request | URL
      • Optionalinit: RequestInit

      Returns Promise<Response>

• filter: {
      <ColumnName>(column: ColumnName, operator:
          | FilterOperator
          | "not.in"
          | "not.cs"
          | "not.is"
          | "not.lt"
          | "not.sr"
          | "not.sl"
          | "not.gt"
          | "not.gte"
          | "not.lte"
          | "not.neq"
          | "not.like"
          | "not.fts"
          | "not.eq"
          | "not.ilike"
          | "not.cd"
          | "not.nxl"
          | "not.nxr"
          | "not.adj"
          | "not.ov"
          | "not.plfts"
          | "not.phfts"
          | "not.wfts", value: unknown): this;
      (column: string, operator: string, value: unknown): this;
  }

  • • <ColumnName>(column, operator, value): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • operator:
            | FilterOperator
            | "not.in"
            | "not.cs"
            | "not.is"
            | "not.lt"
            | "not.sr"
            | "not.sl"
            | "not.gt"
            | "not.gte"
            | "not.lte"
            | "not.neq"
            | "not.like"
            | "not.fts"
            | "not.eq"
            | "not.ilike"
            | "not.cd"
            | "not.nxl"
            | "not.nxr"
            | "not.adj"
            | "not.ov"
            | "not.plfts"
            | "not.phfts"
            | "not.wfts"
      • value: unknown

      Returns this

    • (column, operator, value): this

    • Parameters

      • column: string
      • operator: string
      • value: unknown

      Returns this

• geojson: (() => PostgrestBuilder<Record<string, unknown>>)

  • • (): PostgrestBuilder<Record<string, unknown>>

    • Return data as an object in GeoJSON format.

      Returns PostgrestBuilder<Record<string, unknown>>

• gt: {
      <ColumnName>(column: ColumnName, value: any): this;
      (column: string, value: unknown): this;
  }

  • • <ColumnName>(column, value): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • value: any

      Returns this

    • (column, value): this

    • Parameters

      • column: string
      • value: unknown

      Returns this

• gte: {
      <ColumnName>(column: ColumnName, value: any): this;
      (column: string, value: unknown): this;
  }

  • • <ColumnName>(column, value): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • value: any

      Returns this

    • (column, value): this

    • Parameters

      • column: string
      • value: unknown

      Returns this

• headers: Record<string, string>

• ilike: {
      <ColumnName>(column: ColumnName, pattern: string): this;
      (column: string, pattern: string): this;
  }

  • • <ColumnName>(column, pattern): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • pattern: string

      Returns this

    • (column, pattern): this

    • Parameters

      • column: string
      • pattern: string

      Returns this

• ilikeAllOf: {
      <ColumnName>(column: ColumnName, patterns: readonly string[]): this;
      (column: string, patterns: readonly string[]): this;
  }

  • • <ColumnName>(column, patterns): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • patterns: readonly string[]

      Returns this

    • (column, patterns): this

    • Parameters

      • column: string
      • patterns: readonly string[]

      Returns this

• ilikeAnyOf: {
      <ColumnName>(column: ColumnName, patterns: readonly string[]): this;
      (column: string, patterns: readonly string[]): this;
  }

  • • <ColumnName>(column, patterns): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • patterns: readonly string[]

      Returns this

    • (column, patterns): this

    • Parameters

      • column: string
      • patterns: readonly string[]

      Returns this

• in: {
      <ColumnName>(column: ColumnName, values: readonly any[]): this;
      (column: string, values: readonly unknown[]): this;
  }

  • • <ColumnName>(column, values): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • values: readonly any[]

      Returns this

    • (column, values): this

    • Parameters

      • column: string
      • values: readonly unknown[]

      Returns this

• is: {
      <ColumnName>(column: ColumnName, value: any): this;
      (column: string, value: null | boolean): this;
  }

  • • <ColumnName>(column, value): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • value: any

      Returns this

    • (column, value): this

    • Parameters

      • column: string
      • value: null | boolean

      Returns this

• isMaybeSingle: boolean

• like: {
      <ColumnName>(column: ColumnName, pattern: string): this;
      (column: string, pattern: string): this;
  }

  • • <ColumnName>(column, pattern): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • pattern: string

      Returns this

    • (column, pattern): this

    • Parameters

      • column: string
      • pattern: string

      Returns this

• likeAllOf: {
      <ColumnName>(column: ColumnName, patterns: readonly string[]): this;
      (column: string, patterns: readonly string[]): this;
  }

  • • <ColumnName>(column, patterns): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • patterns: readonly string[]

      Returns this

    • (column, patterns): this

    • Parameters

      • column: string
      • patterns: readonly string[]

      Returns this

• likeAnyOf: {
      <ColumnName>(column: ColumnName, patterns: readonly string[]): this;
      (column: string, patterns: readonly string[]): this;
  }

  • • <ColumnName>(column, patterns): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • patterns: readonly string[]

      Returns this

    • (column, patterns): this

    • Parameters

      • column: string
      • patterns: readonly string[]

      Returns this

• limit: ((count: number, options?: {
      foreignTable?: string;
      referencedTable?: string;
  }) => this)

  • • (count, options?): this

    • Limit the query result by count.

      Parameters

      • count: number

        The maximum number of rows to return
      • Optionaloptions: {
            foreignTable?: string;
            referencedTable?: string;
        }

        Named parameters

        • OptionalforeignTable?: string

          Deprecated, use options.referencedTable instead

        • OptionalreferencedTable?: string

          Set this to limit rows of referenced tables instead of the parent table

      Returns this

• lt: {
      <ColumnName>(column: ColumnName, value: any): this;
      (column: string, value: unknown): this;
  }

  • • <ColumnName>(column, value): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • value: any

      Returns this

    • (column, value): this

    • Parameters

      • column: string
      • value: unknown

      Returns this

• lte: {
      <ColumnName>(column: ColumnName, value: any): this;
      (column: string, value: unknown): this;
  }

  • • <ColumnName>(column, value): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • value: any

      Returns this

    • (column, value): this

    • Parameters

      • column: string
      • value: unknown

      Returns this

• match: {
      <ColumnName>(query: Record<ColumnName, any>): this;
      (query: Record<string, unknown>): this;
  }

  • • <ColumnName>(query): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • query: Record<ColumnName, any>

      Returns this

    • (query): this

    • Parameters

      • query: Record<string, unknown>

      Returns this

• maybeSingle: (<ResultOne>() => PostgrestBuilder<null | ResultOne>)

  • • <ResultOne>(): PostgrestBuilder<null | ResultOne>

    • Return data as a single object instead of an array of objects.

      Query result must be zero or one row (e.g. using .limit(1)), otherwise this returns an error.

      Type Parameters

      • ResultOne = unknown

      Returns PostgrestBuilder<null | ResultOne>

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

• neq: {
      <ColumnName>(column: ColumnName, value: any): this;
      (column: string, value: unknown): this;
  }

  • • <ColumnName>(column, value): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • value: any

      Returns this

    • (column, value): this

    • Parameters

      • column: string
      • value: unknown

      Returns this

• not: {
      <ColumnName>(column: ColumnName, operator: FilterOperator, value: any): this;
      (column: string, operator: string, value: unknown): this;
  }

  • • <ColumnName>(column, operator, value): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • operator: FilterOperator
      • value: any

      Returns this

    • (column, operator, value): this

    • Parameters

      • column: string
      • operator: string
      • value: unknown

      Returns this

• or: ((filters: string, options?: {
      foreignTable?: string;
      referencedTable?: string;
  }) => this)

  • • (filters, options?): this

    • Match only rows which satisfy at least one of the filters.

      Unlike most filters, filters is used as-is and needs to follow PostgREST syntax. You also need to make sure it's properly sanitized.

      It's currently not possible to do an .or() filter across multiple tables.

      Parameters

      • filters: string

        The filters to use, following PostgREST syntax
      • Optionaloptions: {
            foreignTable?: string;
            referencedTable?: string;
        }

        Named parameters

        • OptionalforeignTable?: string

          Deprecated, use referencedTable instead

        • OptionalreferencedTable?: string

          Set this to filter on referenced tables instead of the parent table

      Returns this

• order: {
      <ColumnName>(column: ColumnName, options?: {
          ascending?: boolean;
          nullsFirst?: boolean;
          referencedTable?: undefined;
      }): this;
      (column: string, options?: {
          ascending?: boolean;
          nullsFirst?: boolean;
          referencedTable?: string;
      }): this;
      <ColumnName>(column: ColumnName, options?: {
          ascending?: boolean;
          foreignTable?: undefined;
          nullsFirst?: boolean;
      }): this;
      (column: string, options?: {
          ascending?: boolean;
          foreignTable?: string;
          nullsFirst?: boolean;
      }): this;
  }

  • • <ColumnName>(column, options?): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • Optionaloptions: {
            ascending?: boolean;
            nullsFirst?: boolean;
            referencedTable?: undefined;
        }

        • Optionalascending?: boolean

        • OptionalnullsFirst?: boolean

        • OptionalreferencedTable?: undefined

      Returns this

    • (column, options?): this

    • Parameters

      • column: string
      • Optionaloptions: {
            ascending?: boolean;
            nullsFirst?: boolean;
            referencedTable?: string;
        }

        • Optionalascending?: boolean

        • OptionalnullsFirst?: boolean

        • OptionalreferencedTable?: string

      Returns this

    • <ColumnName>(column, options?): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • Optionaloptions: {
            ascending?: boolean;
            foreignTable?: undefined;
            nullsFirst?: boolean;
        }

        • Optionalascending?: boolean

        • OptionalforeignTable?: undefined

        • OptionalnullsFirst?: boolean

      Returns this

      Deprecated

      Use options.referencedTable instead of options.foreignTable

    • (column, options?): this

    • Parameters

      • column: string
      • Optionaloptions: {
            ascending?: boolean;
            foreignTable?: string;
            nullsFirst?: boolean;
        }

        • Optionalascending?: boolean

        • OptionalforeignTable?: string

        • OptionalnullsFirst?: boolean

      Returns this

      Deprecated

      Use options.referencedTable instead of options.foreignTable

• overlaps: {
      <ColumnName>(column: ColumnName, value: string | readonly any[]): this;
      (column: string, value: string | readonly unknown[]): this;
  }

  • • <ColumnName>(column, value): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • value: string | readonly any[]

      Returns this

    • (column, value): this

    • Parameters

      • column: string
      • value: string | readonly unknown[]

      Returns this

• range: ((from: number, to: number, options?: {
      foreignTable?: string;
      referencedTable?: string;
  }) => this)

  • • (from, to, options?): this

    • Limit the query result by starting at an offset from and ending at the offset to. Only records within this range are returned. This respects the query order and if there is no order clause the range could behave unexpectedly. The from and to values are 0-based and inclusive: range(1, 3) will include the second, third and fourth rows of the query.

      Parameters

      • from: number

        The starting index from which to limit the result
      • to: number

        The last index to which to limit the result
      • Optionaloptions: {
            foreignTable?: string;
            referencedTable?: string;
        }

        Named parameters

        • OptionalforeignTable?: string

          Deprecated, use options.referencedTable instead

        • OptionalreferencedTable?: string

          Set this to limit rows of referenced tables instead of the parent table

      Returns this

• rangeAdjacent: {
      <ColumnName>(column: ColumnName, range: string): this;
      (column: string, range: string): this;
  }

  • • <ColumnName>(column, range): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • range: string

      Returns this

    • (column, range): this

    • Parameters

      • column: string
      • range: string

      Returns this

• rangeGt: {
      <ColumnName>(column: ColumnName, range: string): this;
      (column: string, range: string): this;
  }

  • • <ColumnName>(column, range): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • range: string

      Returns this

    • (column, range): this

    • Parameters

      • column: string
      • range: string

      Returns this

• rangeGte: {
      <ColumnName>(column: ColumnName, range: string): this;
      (column: string, range: string): this;
  }

  • • <ColumnName>(column, range): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • range: string

      Returns this

    • (column, range): this

    • Parameters

      • column: string
      • range: string

      Returns this

• rangeLt: {
      <ColumnName>(column: ColumnName, range: string): this;
      (column: string, range: string): this;
  }

  • • <ColumnName>(column, range): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • range: string

      Returns this

    • (column, range): this

    • Parameters

      • column: string
      • range: string

      Returns this

• rangeLte: {
      <ColumnName>(column: ColumnName, range: string): this;
      (column: string, range: string): this;
  }

  • • <ColumnName>(column, range): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • range: string

      Returns this

    • (column, range): this

    • Parameters

      • column: string
      • range: string

      Returns this

• returns: (<NewResult>() => PostgrestTransformBuilder<any, any, NewResult, unknown, unknown>)

  • • <NewResult>(): PostgrestTransformBuilder<any, any, NewResult, unknown, unknown>

    • Override the type of the returned data.

      Type Parameters

      • NewResult

        The new result type to override with

      Returns PostgrestTransformBuilder<any, any, NewResult, unknown, unknown>

• rollback: (() => this)

  • • (): this

    • Rollback the query.

      data will still be returned, but the query is not committed.

      Returns this

• schema: undefined | string

• select: (<Query, NewResultOne>(columns?: Query) => PostgrestTransformBuilder<any, any, NewResultOne[], unknown, unknown>)

  • • <Query, NewResultOne>(columns?): PostgrestTransformBuilder<any, any, NewResultOne[], unknown, unknown>

    • Perform a SELECT on the query result.

      By default, .insert(), .update(), .upsert(), and .delete() do not return modified rows. By calling this method, modified rows are returned in data.

      Type Parameters

      • Query extends string = "*"
      • NewResultOne = GetResult<any, any, unknown, unknown, Query>

      Parameters

      • Optionalcolumns: Query

        The columns to retrieve, separated by commas

      Returns PostgrestTransformBuilder<any, any, NewResultOne[], unknown, unknown>

• shouldThrowOnError: boolean

• signal: undefined | AbortSignal

• single: (<ResultOne>() => PostgrestBuilder<ResultOne>)

  • • <ResultOne>(): PostgrestBuilder<ResultOne>

    • Return data as a single object instead of an array of objects.

      Query result must be one row (e.g. using .limit(1)), otherwise this returns an error.

      Type Parameters

      • ResultOne = unknown

      Returns PostgrestBuilder<ResultOne>

• textSearch: {
      <ColumnName>(column: ColumnName, query: string, options?: {
          config?: string;
          type?: "plain" | "phrase" | "websearch";
      }): this;
      (column: string, query: string, options?: {
          config?: string;
          type?: "plain" | "phrase" | "websearch";
      }): this;
  }

  • • <ColumnName>(column, query, options?): this

    • Type Parameters

      • ColumnName extends string

      Parameters

      • column: ColumnName
      • query: string
      • Optionaloptions: {
            config?: string;
            type?: "plain" | "phrase" | "websearch";
        }

        • Optionalconfig?: string

        • Optionaltype?: "plain" | "phrase" | "websearch"

      Returns this

    • (column, query, options?): this

    • Parameters

      • column: string
      • query: string
      • Optionaloptions: {
            config?: string;
            type?: "plain" | "phrase" | "websearch";
        }

        • Optionalconfig?: string

        • Optionaltype?: "plain" | "phrase" | "websearch"

      Returns this

• then: (<TResult1, TResult2>(onfulfilled?: null | ((value: PostgrestSingleResponse<any>) => TResult1 | PromiseLike<TResult1>), onrejected?: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)) => PromiseLike<TResult1 | TResult2>)

  • • <TResult1, TResult2>(onfulfilled?, onrejected?): PromiseLike<TResult1 | TResult2>

    • Attaches callbacks for the resolution and/or rejection of the Promise.

      Type Parameters

      • TResult1 = PostgrestSingleResponse<any>
      • TResult2 = never

      Parameters

      • Optionalonfulfilled: null | ((value: PostgrestSingleResponse<any>) => TResult1 | PromiseLike<TResult1>)

        The callback to execute when the Promise is resolved.
      • Optionalonrejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)

        The callback to execute when the Promise is rejected.

      Returns PromiseLike<TResult1 | TResult2>

      A Promise for the completion of which ever callback is executed.

• throwOnError: (() => this)

  • • (): this

    • 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

      Returns this

• url: URL