Postgrest

Plugin to interact with the supabase Postgrest API

To use it you need to install it to the SupabaseClient:

val supabase = createSupabaseClient(supabaseUrl, supabaseKey) {
   install(Postgrest)
}

then you can use it like this:

val product = supabase.postgrest["products"].select {
   Product::id eq 2
}.decodeSingle<Product>()

Types

data class Config(var defaultSchema: String = "public", var propertyConversionMethod: PropertyConversionMethod = PropertyConversionMethod.CAMEL_CASE_TO_SNAKE_CASE) : MainConfig, CustomSerializationConfig

Config for the Postgrest plugin

abstract val apiVersion: Int

open suspend fun close()

Creates a new PostgrestQueryBuilder for the given table

Creates a new PostgrestQueryBuilder for the given schema and table

Creates a new PostgrestQueryBuilder for the given schema and table

open operator fun get(schema: String, table: String): PostgrestQueryBuilder

Creates a new PostgrestQueryBuilder for the given table

open fun init()

abstract suspend fun parseErrorResponse(response: HttpResponse): RestException

abstract suspend fun rpc(function: String, request: RpcRequestBuilder.() -> Unit = {}): PostgrestResult

abstract suspend fun rpc(function: String, parameters: JsonObject, request: RpcRequestBuilder.() -> Unit = {}): PostgrestResult

Executes a database function

inline suspend fun <T : Any> Postgrest.rpc(function: String, parameters: T, noinline request: RpcRequestBuilder.() -> Unit = {}): PostgrestResult

Executes a database function