storage-kt/io.github.jan.supabase.storage/Storage

Storage

interface Storage : MainPlugin<Storage.Config> , CustomSerializationPlugin(source)

Plugin for interacting with the Supabase Storage API

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

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

then you have to interact with the Storage API like this:

val bucket = supabase.storage.from("icons")
val bytes = bucket.downloadAuthenticated("icon.png")

Types

object Companion : SupabasePluginProvider<Storage.Config, Storage>

data class Config(var transferTimeout: Duration = 120.seconds, resumable: Storage.Config.Resumable = Resumable(), var serializer: SupabaseSerializer? = null, var requireValidSession: Boolean = false) : MainConfig, CustomSerializationConfig, AuthDependentPluginConfig

Config for the storage plugin

Properties

abstract val analytics: StorageAnalyticsClient

Access vector storage operations.

abstract val api: AuthenticatedSupabaseApi

The API used for network requests.

abstract val apiVersion: Int

abstract val config: Storage.Config

abstract val logger: SupabaseLogger

abstract val pluginKey: String

abstract val serializer: SupabaseSerializer

abstract val supabaseClient: SupabaseClient

abstract val vectors: StorageVectorsClient

Access analytics storage operations using Iceberg tables.

Functions

open suspend fun close()

abstract suspend fun createBucket(id: String, builder: BucketBuilder.() -> Unit = {})

Creates a new bucket in the storage

abstract suspend fun deleteBucket(bucketId: String)

Deletes a bucket by its bucketId

abstract suspend fun emptyBucket(bucketId: String)

Empties a bucket by its bucketId

open fun from(bucketId: String): BucketApi

Builder function for interacting with a bucket with the given bucketId

abstract operator fun get(bucketId: String): BucketApi

Builder function for interacting with a bucket with the given bucketId

abstract suspend fun getBucket(bucketId: String): Bucket?

Retrieves a bucket by its bucketId

open fun init()

abstract suspend fun listBuckets(filter: StorageListFilter.Buckets.() -> Unit = {}): List<Bucket>

Returns all buckets in the storage

parseErrorResponse

abstract suspend fun parseErrorResponse(response: HttpResponse): RestException

purgeBucketCache

abstract suspend fun purgeBucketCache(id: String, options: PurgeCacheOptions.() -> Unit = {})

Purges the CDN cache for an entire bucket.

open fun resolveUrl(path: String): String

abstract suspend fun updateBucket(id: String, builder: BucketBuilder.() -> Unit = {})

Updates a bucket in the storage