postgrest-kt/io.github.jan.supabase.postgrest.query/PostgrestRequestBuilder

PostgrestRequestBuilder

abstract class PostgrestRequestBuilder(defaultSchema: String, propertyConversionMethod: PropertyConversionMethod)(source)

A builder for Postgrest requests.

Inheritors

DeleteRequestBuilder

InsertRequestBuilder

RpcRequestBuilder

SelectRequestBuilder

UpdateRequestBuilder

Constructors

PostgrestRequestBuilder

constructor(defaultSchema: String, propertyConversionMethod: PropertyConversionMethod)

Properties

var count: Count?

The Count algorithm to use to count rows in the table or view.

val headers: HeadersBuilder

val params: MutableMap<String, List<String>>

var retry: Boolean

Whether to retry this request on transient errors (network errors, HTTP 503/520). Only applies to idempotent requests (GET, HEAD) — non-idempotent requests are never retried. Set to false to disable retries for this specific request.

var returning: Returning

The Returning option to use.

var schema: String

The database schema

Functions

fun count(count: Count)

Setting count allows to use PostgrestResult.countOrNull to get the total amount of items in the database.

fun csv()

Return data as a string in CSV format.

fun explain(analyze: Boolean = false, verbose: Boolean = false, settings: Boolean = false, buffers: Boolean = false, wal: Boolean = false, format: String = "text")

Return data as the EXPLAIN plan for the query.

inline fun filter(block: PostgrestFilterBuilder.() -> Unit)

Adds a filter to the postgrest request.

Return data as an object in GeoJSON format.

fun limit(count: Long, referencedTable: String? = null)

Limits the result to count rows

Disables automatic retries for this request.

fun order(column: String, order: Order, nullsFirst: Boolean = false, referencedTable: String? = null)

Orders the result by column in the specified order.

fun range(range: LongRange, referencedTable: String? = null)

Limits the result to rows from range.first to range.last

fun range(from: Long, to: Long, referencedTable: String? = null)

Limits the result to rows from from to to

fun select(columns: Columns = Columns.ALL)

Return data after the query has been executed.

fun single()

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

fun stripNulls()

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