supabase-kt/io.github.jan.supabase/SupabaseClient

SupabaseClient

interface SupabaseClient

The main class to interact with Supabase.

To add functionality, add plugins like Auth or Functions within the SupabaseClientBuilder

Types

object Companion

Properties

abstract val accessToken: AccessTokenProvider?

The custom access token provider used to provide custom access tokens for requests. Configured within the SupabaseClientBuilder

coroutineDispatcher

abstract val coroutineDispatcher: CoroutineDispatcher

The default dispatcher used for launching long running jobs

defaultSerializer

abstract val defaultSerializer: SupabaseSerializer

The default serializer used to serialize and deserialize custom data types.

abstract val httpClient: KtorSupabaseHttpClient

The http client used to interact with the Supabase api

abstract val pluginManager: PluginManager

The plugin manager is used to manage installed plugins

supabaseHttpUrl

abstract val supabaseHttpUrl: String

The supabase url with either a http or https scheme.

abstract val supabaseKey: String

The api key for interacting with the supabase api

abstract val supabaseUrl: String

The base supabase url without any scheme

abstract val useHTTPS: Boolean

Whether supabaseHttpUrl uses https

Functions

abstract suspend fun close()

Releases all resources held by the httpClient and all plugins the pluginManager

fun SupabaseClient.supabaseApi(plugin: MainPlugin<*>): SupabaseApi

Creates a SupabaseApi for the given plugin All requests will be resolved using the MainPlugin.resolveUrl function

fun SupabaseClient.supabaseApi(resolveUrl: (path: String) -> String, parseErrorResponse: suspend (response: HttpResponse) -> RestException? = null): SupabaseApi

Creates a SupabaseApi with the given resolveUrl function All requests will be resolved using this function

fun SupabaseClient.supabaseApi(baseUrl: String, parseErrorResponse: suspend (response: HttpResponse) -> RestException? = null): SupabaseApi

Creates a SupabaseApi with the given baseUrl All requests will be resolved relative to this url