storage_client library
Dart client library for Supabase Storage.
Classes
- AddPartitionSpecUpdate
- AddSchemaUpdate
- AddSortOrderUpdate
- AnalyticsBucket
- A bucket backed by the Apache Iceberg table format, used for structured analytical data storage.
- AssertCreate
- AssertCurrentSchemaId
- AssertDefaultSortOrderId
- AssertDefaultSpecId
- AssertLastAssignedFieldId
- AssertLastAssignedPartitionId
- AssertReferenceSnapshotId
- AssertTableUuid
- AssignUuidUpdate
- Bucket
- BucketOptions
- public The visibility of the bucket. Public buckets don't require an authorization token to download objects, but still require a valid token for all other operations. By default, buckets are private.
- CommitTableResult
- The result of committing updates to a table.
- CreateTableRequest
- Request describing a table to create.
- DownloadBehavior
- Controls download behavior for signed and public URLs.
- FileObject
- FileObjectV2
- FileOptions
- FileSort
- The column and direction that StorageFileApi.listPaginated sorts its results by.
- IcebergRestCatalog
- Client for the Apache Iceberg REST Catalog exposed by Supabase Storage under an analytics bucket. It manages namespaces and tables within a warehouse (an analytics bucket).
- IcebergType
- A type in the Iceberg type system. Either a PrimitiveType represented by a type string, or one of the nested types StructType, ListType and MapType.
- ListBucketsOptions
-
Filter, sort and pagination options for
StorageBucketApi.listBuckets. - ListNamespacesOptions
- Options for listing namespaces.
- ListNamespacesResult
- The result of listing namespaces.
- ListTablesOptions
- Options for listing tables.
- ListTablesResult
- The result of listing tables in a namespace.
- ListType
- A list type whose elements are of type element.
- LoadTableOptions
- Options for loading a table.
- LoadTableResult
- The full result of loading, creating or registering a table, including the server provided configuration, vended storage credentials and the response ETag.
- MapType
- A map type with keys of type key and values of type value.
- PaginatedFile
- A file entry returned by StorageFileApi.listPaginated.
- PaginatedFolder
- A folder entry returned by StorageFileApi.listPaginated when using a delimiter.
- PaginatedListResult
- The result of StorageFileApi.listPaginated.
- PaginatedSearchOptions
- Options for StorageFileApi.listPaginated.
- PartitionField
- A single field of a PartitionSpec.
- PartitionSpec
- Describes how a table is partitioned.
- PrimitiveType
-
A primitive Iceberg type such as
int,string,decimal(10,2)orfixed[16]. - RawTableUpdate
- RegisterTableRequest
- Request to register an existing metadata file as a table.
- RemovePartitionSpecsUpdate
- RemovePropertiesUpdate
- RemoveSchemasUpdate
- RemoveSnapshotReferenceUpdate
- RemoveSnapshotsUpdate
- SearchOptions
- SetCurrentSchemaUpdate
- SetDefaultSortOrderUpdate
- SetDefaultSpecUpdate
- SetLocationUpdate
- SetPropertiesUpdate
- SetSnapshotReferenceUpdate
- SignedUploadURLResponse
- SignedUrl
- SignedUrlFailure
- A failed SignedUrlResult: the path could not be signed (e.g. the file does not exist).
- SignedUrlResult
- Represents a per-item result from StorageFileApi.createSignedUrlsResult.
- SignedUrlSuccess
- A successful SignedUrlResult: the file was found and a signed URL was generated.
- Snapshot
- A snapshot of a table at a point in time.
- SnapshotReference
- A reference (branch or tag) pointing at a snapshot.
- SortBy
- SortField
- A single field of a SortOrder.
- SortOrder
- Describes how a table is sorted when written.
- StorageCredential
- Temporary storage credentials vended by the server for a table path prefix.
- StorageFileApi
- StorageRetryController
- StorageVectorBucketApi
- Index operations scoped to a single vector bucket.
- StorageVectorIndexApi
- Vector data operations scoped to a single index within a bucket.
- StructType
- A nested struct type containing fields.
- SupabaseStorageClient
- SupabaseVectorsClient
-
Client for the Storage Vectors API, reachable through
supabase.storage.vectors. - TableField
- A field within a StructType or a TableSchema.
- TableIdentifier
- Identifies a table by its namespace and name.
- TableMetadata
- Metadata describing the current state of a table, returned when loading or committing to a table.
- TableRequirement
- A precondition that must hold for a table commit to be applied. The server rejects the commit if any requirement is not met.
- TableSchema
- The schema of a table, a struct of fields.
- TableUpdate
- A single change applied to a table as part of a commit. The common data definition updates are modelled as dedicated subclasses. Updates that are not modelled (for example snapshot, statistics and encryption key updates) can be sent with TableUpdate.raw.
- TransformOptions
- Specifies the dimensions and the resize mode of the requesting image.
- UpdateNamespacePropertiesResult
- The result of a namespace properties update.
- UpgradeFormatVersionUpdate
- Vector
- A single vector to insert or update through StorageVectorIndexApi.putVectors.
- VectorBucket
- Metadata describing a vector bucket.
- VectorBucketEncryption
- Encryption settings attached to a vector bucket.
- VectorBucketList
- The result of SupabaseVectorsClient.listBuckets.
- VectorIndex
- Metadata describing a vector index within a bucket.
- VectorIndexList
- The result of StorageVectorBucketApi.listIndexes.
- VectorList
- The result of StorageVectorIndexApi.listVectors.
- VectorMatch
- A vector returned from a get, list or query operation.
- VectorQueryResult
- The result of StorageVectorIndexApi.queryVectors.
Enums
- AccessDelegation
- Access delegation mechanisms that can be requested from the server for table read and write operations.
- BucketSortColumn
-
The column that
StorageBucketApi.listBucketscan sort its results by. - BucketSortOrder
-
The direction that
StorageBucketApi.listBucketssorts its results in. - DistanceMetric
- Distance metric used when comparing vectors during a similarity search.
- FileSortColumn
- The column that StorageFileApi.listPaginated can sort its results by.
- FileSortOrder
- The direction that StorageFileApi.listPaginated sorts its results in.
- LoadTableSnapshots
- Which snapshots the server should include when loading a table.
- NullOrder
- Where null values are ordered relative to non null values in a SortField.
- RequestImageFormat
- ResizeMode
- Specifies how image cropping should be handled when performing image transformations.
- SnapshotReferenceType
- The kind of reference a SnapshotReference points to.
- SortDirection
- The direction used when sorting a SortField.
- VectorDataType
- Supported data types for vector components.
Exceptions / Errors
- IcebergAuthenticationTimeoutException
- Authentication timed out and the request should be retried with fresh credentials (HTTP 419).
- IcebergCommitStateUnknownException
- A table commit was sent but its outcome is unknown, so retrying it could duplicate data.
- IcebergConflictException
- The request conflicts with the current state, for example the resource already exists or a commit lost a race (HTTP 409).
- IcebergException
- Error thrown by IcebergRestCatalog operations when the Iceberg REST Catalog API returns an error response or a request fails at the network level.
- IcebergNetworkException
- A request failed at the network level, before any response was received.
- IcebergNotFoundException
- The requested namespace or table does not exist (HTTP 404).
- IcebergServerException
- The server failed to handle the request (HTTP 5xx).
- IcebergUnknownException
- Any Iceberg failure that does not fit a more specific subtype.
- StorageException