postgrest-kt/io.github.jan.supabase.postgrest.query.request/UpsertRequestBuilder

UpsertRequestBuilder

class UpsertRequestBuilder(defaultSchema: String, propertyConversionMethod: PropertyConversionMethod) : InsertRequestBuilder(source)

Request builder for PostgrestQueryBuilder.upsert

Constructors

constructor(defaultSchema: String, propertyConversionMethod: PropertyConversionMethod)

Properties

count

var count: Count?

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

defaultToNull

var defaultToNull: Boolean

Make missing fields default to null. Otherwise, use the default value for the column. This only applies when inserting new rows, not when merging with existing rows under

headers

val headers: HeadersBuilder

ignoreDuplicates

var ignoreDuplicates: Boolean

If true, duplicate rows are ignored. If false, duplicate rows are merged with existing rows.

onConflict

var onConflict: String?

Comma-separated UNIQUE column(s) to specify how duplicate rows are determined. Two rows are duplicates if all the onConflict columns are equal.

params

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

retry

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.

returning

var returning: Returning

The Returning option to use.

schema

var schema: String

The database schema

Functions

count

fun count(count: Count)

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

csv

fun csv()

Return data as a string in CSV format.

dryRun

fun dryRun()

Executes the query but rolls back the transaction instead of committing it.

explain

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.

filter