supabase_flutter library

Flutter integration for Supabase.

Classes

AddPartitionSpecificationUpdate
AddSchemaUpdate
AddSortOrderUpdate
AdminUserAttributes
Attributes for AuthAdminApi.createUser and AuthAdminApi.updateUserById.
AnalyticsBucket
A bucket backed by the Apache Iceberg table format, used for structured analytical data storage.
AppMetadata
Metadata the auth server or an admin controls; the signed-in user cannot modify it.
AssertCreate
AssertCurrentSchemaId
AssertDefaultSortOrderId
AssertDefaultSpecificationId
AssertLastAssignedFieldId
AssertLastAssignedPartitionId
AssertReferenceSnapshotId
AssertTableUuid
AssignUuidUpdate
AsyncJsonCodec
Encodes and decodes JSON asynchronously, so that a large payload does not block the calling isolate for long.
AuthAdminApi
Admin API namespace for managing users, exposed on AuthClient.admin.
AuthAdminPasskeyApi
Admin methods for managing the passkeys of users.
AuthAdminSSOApi
Contains all single sign-on (SAML 2.0) identity provider administration methods.
AuthAsyncStorage
Key-value storage the auth client keeps its session and pkce code verifiers in.
AuthClient
API client to interact with the Supabase Auth server.
AuthClientOptions
Configuration for the auth client used by SupabaseClient.auth.
AuthenticationMethodReferenceEntry
An authentication method reference (AMR) entry.
AuthInitialSession
The first event every new subscriber of AuthClient.onAuthStateChange receives, with the session at that moment or null if there is none.
AuthMFAAdminDeleteFactorResponse
The response of AuthAdminMFAApi.deleteFactor.
AuthMFAAdminListFactorsResponse
The response of AuthAdminMFAApi.listFactors.
AuthMFAAdminUpdateFactorResponse
The response of AuthAdminMFAApi.updateFactor.
AuthMFAApi
API namespace for managing the signed-in user's MFA factors, exposed on AuthClient.mfa.
AuthMFAChallengeResponse
The response of AuthMFAApi.challenge.
AuthMfaChallengeVerified
Emitted after a multi-factor authentication challenge is verified.
AuthMFAEnrollResponse
The response of AuthMFAApi.enroll.
AuthMFAGetAuthenticatorAssuranceLevelResponse
The response of AuthMFAApi.getAuthenticatorAssuranceLevel.
AuthMFAListFactorsResponse
The response of AuthMFAApi.listFactors.
AuthMFARecoveryCodesApi
API namespace for MFA recovery codes, exposed on AuthClient.mfa.recoveryCodes.
AuthMFARecoveryCodesGenerateResponse
The response of AuthMFARecoveryCodesApi.generate and AuthMFARecoveryCodesApi.regenerate.
AuthMFARecoveryCodesStatusResponse
The response of AuthMFARecoveryCodesApi.getStatus.
AuthMFAUnenrollResponse
The response of AuthMFAApi.unenroll.
AuthOAuthApi
API namespace for the OAuth 2.1 authorization server consent flow.
AuthPasskeyApi
API namespace for passkey (WebAuthn) authentication.
AuthPasswordRecovery
Emitted after the user follows a password recovery link or verifies a recovery code.
AuthResponse
Response of AuthClient.signUp and AuthClient.verifyOTP, the two calls that can complete without issuing a session.
AuthSessionUrlResponse
The response of AuthClient.getSessionFromUrl.
AuthSignedIn
Emitted after a successful sign-in.
AuthSignedOut
Emitted after the user signs out.
AuthState
An event emitted on AuthClient.onAuthStateChange.
AuthTokenRefreshed
Emitted after the access token is refreshed.
AuthUserUpdated
Emitted after the user's profile is updated.
BinaryBroadcastPayload
A binary payload, sent with RealtimeChannel.sendBinaryBroadcastMessage or RealtimeChannel.httpSendBinary.
BroadcastMessage
A message sent to a channel with broadcast, emitted by RealtimeChannel.onBroadcast.
BroadcastPayload
The data of a BroadcastMessage, either JSON or raw bytes.
BroadcastPersistence
Stores a broadcast message so that it can be replayed with RealtimeChannelConfig.replay.
Bucket
A storage bucket.
BucketOptions
Options for StorageBucketApi.createBucket and StorageBucketApi.updateBucket.
ByteRange
A range of bytes to download, sent as a Range header.
ByteStream
A stream of chunks of bytes representing a single piece of data.
CommitTableResult
The result of committing updates to a table.
CreateCustomProviderOptions
Parameters for creating a new custom provider.
CreateOAuthClientOptions
Parameters for creating a new OAuth client. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.
CreateSSOProviderOptions
The options to register a single sign-on identity provider with.
CreateTableRequest
Request describing a table to create.
CustomOAuthProvider
Custom OAuth/OIDC provider object returned from the admin API.
DecodedJwt
Decoded JWT structure
DownloadBehavior
Controls download behavior for signed and public URLs.
Factor
An MFA factor enrolled by a user.
FileObject
An object returned by StorageFileApi.remove and StorageFileApi.removeVersions.
FileObjectV2
A file entry returned by the storage v2 object listing API.
FileOptions
Options for an upload to storage.
FileSort
The column and direction that StorageFileApi.list sorts its results by.
FileVersion
A specific version of a file, for StorageFileApi.removeVersions.
FlutterAuthClientOptions
Configuration for the auth client used by Supabase.instance.client.auth, extending AuthClientOptions with deep link handling.
FunctionsClient
Client for invoking Supabase Edge Functions.
FunctionsClientOptions
Configuration for the Edge Functions client used by SupabaseClient.functions.
FunctionsResponse
The response of a successful FunctionsClient.invoke call.
GenerateLinkProperties
The generated link and its associated metadata, part of a GenerateLinkResponse.
GenerateLinkResponse
The response of AuthAdminApi.generateLink.
GetClaimsOptions
Options for getClaims method
GetClaimsResponse
Response from getClaims method
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, one of the nested types StructType, ListType and MapType, or an UnknownType this version of the client does not recognize.
JsonBroadcastPayload
A JSON payload.
JWK
JSON Web Key (JWK) representation.
JWKSet
A JSON Web Key Set (JWKS), as published by Supabase Auth's /.well-known/jwks.json endpoint.
JwtHeader
JWT Header structure
JwtPayload
JWT Payload structure with standard claims
JwtRawParts
Raw encoded parts of a JWT
LifecycleRule
A rule of a bucket's lifecycle policy.
ListBucketsOptions
Filter, sort and pagination options for StorageBucketApi.listBuckets.
ListedFile
A file entry returned by StorageFileApi.list.
ListedFolder
A folder entry returned by StorageFileApi.list when using a delimiter.
ListFilesOptions
Options for StorageFileApi.list.
ListFilesResult
The result of StorageFileApi.list.
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.
ListUsersResponse
Response of AuthAdminApi.listUsers, a page of users together with the pagination metadata the server reports for it.
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.
MemoryAuthAsyncStorage
An AuthAsyncStorage that keeps everything in memory only.
MemoryResumableUploadStorage
A ResumableUploadStorage that keeps the records in memory only, so an upload can be paused and resumed but not continued after a restart.
MultipartFile
A file to be uploaded as part of a MultipartRequest.
NoncurrentVersionExpiration
When the previous versions of an object expire.
OAuthAuthorizationDetailsResponse
Response type representing the details of a pending OAuth authorization request that still requires the user's consent.
OAuthAuthorizationRedirectResponse
Response type returned when the signed-in user has already granted consent to the requesting client.
OAuthAuthorizationResponse
Result returned by AuthOAuthApi.getAuthorizationDetails.
OAuthAuthorizedClient
OAuth client object returned from the OAuth 2.1 server when the client is authorized.
OAuthAuthorizingUser
The signed-in user a pending OAuth authorization request belongs to.
OAuthClient
OAuth client object returned from the OAuth 2.1 server. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.
OAuthConsentResponse
Response type for an OAuth authorization consent decision (approve or deny).
OAuthGrant
An OAuth grant representing a user's authorization of an OAuth client.
OAuthLauncher
Launches the URL used to complete an OAuth, SSO, or identity-linking flow.
OAuthProvider
An OAuth provider identifier.
OAuthResponse
Response of OAuth signin
OIDCDiscoveryDocument
OIDC discovery document fields.
PartitionField
A single field of a PartitionSpecification.
PartitionSpecification
Describes how a table is partitioned.
Passkey
A passkey (WebAuthn credential) registered to a user.
PasskeyAuthenticationOptionsResponse
Response containing the options needed to sign in with a passkey.
PasskeyRegistrationOptionsResponse
Response containing the options needed to register a new passkey.
PhoneEnrollment
Phone enrollment information returned by AuthMFAApi.enroll.
PostgresBox
A rectangle with sides parallel to the axes, the value of a Postgres box column.
PostgresByteaCodec
Converts between the bytes of a bytea column and the text PostgREST carries them as.
PostgresChangeFilter
Creates a filter for realtime postgres change listener.
PostgresChangePayload
Data class that contains the Postgres change event payload.
PostgresCircle
A circle, the value of a Postgres circle column.
PostgresColumn
A PostgreSQL column description used to convert a change payload's raw string values to their Dart-typed form.
PostgresDate
A calendar date without a time of day or a timezone, the value of a Postgres date column.
PostgresInterval
A Postgres interval: a span of months, days and microseconds kept apart, the way Postgres stores it.
PostgresLine
An infinite line a·x + b·y + c = 0, the value of a Postgres line column.
PostgresLineSegment
A finite line segment between two points, the value of a Postgres lseg column.
PostgresLogSequenceNumber
A position in the write-ahead log, the value of a Postgres pg_lsn column.
PostgresMacAddress
A hardware address, the value of a Postgres macaddr column with six bytes or of a macaddr8 column with eight.
PostgresMultirange<Bound extends Object>
A Postgres multirange value, such as an int4multirange or a tstzmultirange: a list of ranges with bounds of type Bound.
PostgresNetworkAddress
An IPv4 or IPv6 host or network address with its netmask, the value of a Postgres inet or cidr column.
PostgresPath
A sequence of connected points, open or closed, the value of a Postgres path column.
PostgresPoint
A point in the plane, the value of a Postgres point column.
PostgresPolygon
A closed shape bounded by straight edges between its points, the value of a Postgres polygon column.
PostgresRange<Bound extends Object>
A Postgres range value, such as an int4range or a tstzrange, with bounds of type Bound.
PostgrestAllColumns<Row>
Every stored column of a table, *, in a select list.
PostgrestBuilder<T>
An executable PostgREST request that resolves to T when awaited.
PostgrestCastTarget<Value extends Object>
A Postgres type to cast to, paired with the Dart type that cast produces so the two cannot disagree.
PostgrestClient
A PostgREST api client written in Dartlang. The goal of this library is to make an "ORM-like" restful interface.
PostgrestClientOptions
Configuration for the PostgREST client used by SupabaseClient.from and SupabaseClient.rpc.
PostgrestColumn<Row, Value extends Object>
A stored NOT NULL column, see PostgrestStoredColumn.
PostgrestColumnExpression<Row, Value extends Object>
A single value of the row in a select list: a stored column, or an expression derived from one.
PostgrestColumnOrdering<Row>
A PostgrestOrdering by a stored column with at most a direction, the only kind a realtime stream can keep in order while it merges changes.
PostgrestComparison<Row>
One operator applied to one column, the shape a consumer that cannot apply a whole tree, such as a realtime stream, reads through PostgrestFilter.comparison.
PostgrestComputedField<Row, Value extends Object>
A computed field of the table whose rows are Row: a function whose only argument is the table's row type, which PostgREST exposes like a column.
PostgrestDerivedExpression<Row, Value extends Object>
A cast or an aggregate applied to another expression, or countAll: select position only, whatever it was applied to.
PostgrestEmbed<Row, Target>
An embedded relation selected as a whole into the parent's select list: some entries of the embedded table, or every column of it.
PostgrestEmbeddedCount<Row>
The number of rows of a to-many relation, created by PostgrestToManyRelation.count.
PostgrestEmbeddedScope<Row>
Filters, sort keys and a row window applied to the rows of one embed, built in the callback of PostgrestTypedTransformBuilder.embedded or PostgrestTypedTransformBuilder.requiring.
PostgrestExplainOptions
The options of a PostgrestResultShape.explain request, see PostgrestTransformBuilder.explain.
PostgrestFilter<Row>
A filter on the rows of a table, built from the operator methods on a PostgrestFilterableExpression and composed with &, | and not:
PostgrestFilterBuilder<T>
A builder for applying filters to a query.
PostgrestHttpTableExecutor
The executor that sends a request to PostgREST.
PostgresTime
A time of day, the value of a Postgres time column, or with an offset the value of a timetz column.
PostgresTimestampCodec
Converts between a timestamp or timestamptz value and the text PostgREST carries it as.
PostgrestIntegerVectorColumn<Row>
A stored NOT NULL int2vector or oidvector column of the table whose rows are Row.
PostgrestJsonColumn<Row>
A stored NOT NULL json or jsonb column of the table whose rows are Row.
PostgrestJsonComputedField<Row>
A computed field returning json or jsonb, whose operands are encoded as JSON like those of a PostgrestJsonColumn.
PostgrestJsonPath<Row, Value extends Object>
A JSON path read from a stored column, at every position the column is.
PostgrestNullableColumn<Row, Value extends Object>
A stored column the database allows to be NULL, see PostgrestStoredColumn.
PostgrestNullableIntegerVectorColumn<Row>
A stored int2vector or oidvector column the database allows to be NULL, see PostgrestIntegerVectorColumn.
PostgrestNullableJsonColumn<Row>
A stored json or jsonb column the database allows to be NULL, see PostgrestJsonColumn.
PostgrestNullableVectorColumn<Row>
A stored pgvector vector or halfvec column the database allows to be NULL, see PostgrestVectorColumn.
PostgrestOrdering<Row>
One sort key for PostgrestTypedTransformBuilder.order: a column expression, optionally with a direction and a null placement.
PostgrestPartialRow<Row>
A row of a select list, as returned by PostgrestTypedQueryBuilder.selectOnly and PostgrestTypedTransformBuilder.selectOnly.
PostgrestQueryBuilder
The query builder class provides a convenient interface to creating request queries.
PostgrestReadable<Row, Output>
Something a value can be read for from a PostgrestPartialRow of Row: a stored column, a derived expression, or a relation.
PostgrestRelation<Row, Target>
A foreign key seen from the table whose rows are Row, pointing at the table whose rows are Target.
PostgrestRequestOptions
How a PostgrestTableRequest is sent, as opposed to what it asks for.
PostgrestResponse<T>
A Postgrest response
PostgrestRpc
Calls Postgres functions, returned by PostgrestClient.rpc.
PostgrestRpcBuilder
Builds a stored procedure call.
PostgrestSelectable<Row>
Anything that can appear in a select list.
PostgrestStoredColumn<Row, Value extends Object>
A stored column of the table whose rows are Row: a PostgrestColumn when the database forbids NULL, a PostgrestNullableColumn when it allows it.
PostgrestTable<Row, Insert, Update>
Describes a database table (or view) together with the Dart types its rows are read as and written with.
PostgrestTableExecutor
Runs the requests of the typed table API and of the typed function calls, PostgrestRpc.rows and PostgrestRpc.value.
PostgrestTableRequest
Everything a typed table builder has collected, ready to be run by a PostgrestTableExecutor.
PostgrestTableResult
What a PostgrestTableExecutor produced for a PostgrestTableRequest.
PostgrestToManyColumn<Row, Value extends Object>
A column of a to-many embedded relation, seen from the parent.
PostgrestToManyEmbed<Row, Target>
A to-many relation selected as a whole, books(id,title).
PostgrestToManyRelation<Row, Target>
A to-many embedded relation (one-to-many or many-to-many) of the table whose rows are Row, pointing at the table whose rows are Target.
PostgrestToOneColumn<Row, Value extends Object>
A column of a to-one embedded relation, seen from the parent.
PostgrestToOneEmbed<Row, Target>
A to-one relation selected as a whole, author(id,name).
PostgrestToOneRelation<Row, Target>
A to-one embedded relation (many-to-one or one-to-one) of the table whose rows are Row, pointing at the table whose rows are Target.
PostgrestTransformBuilder<T>
A builder for shaping the result of a query, such as ordering or limiting it.
PostgrestTypedBuilder<T>
A typed PostgREST request that can be awaited.
PostgrestTypedCountBuilder<Row>
A count of the rows of a table, returned by PostgrestTypedQueryBuilder.count.
PostgrestTypedFilterBuilder<Row, T>
The typed counterpart of PostgrestFilterBuilder.
PostgrestTypedQueryBuilder<Row, Insert, Update>
The typed counterpart of PostgrestQueryBuilder, returned by PostgrestClient.table.
PostgrestTypedTransformBuilder<Row, T>
The typed counterpart of PostgrestTransformBuilder.
PostgrestTypedUnscopedBuilder<Row>
An update or delete that does not say yet which rows it acts on.
PostgrestVectorColumn<Row>
A stored NOT NULL pgvector vector or halfvec column of the table whose rows are Row.
PostgresValue
A value of a Postgres type that has a literal of its own, such as a PostgresDate or a PostgresRange.
PostgresVectorCodec
Converts between the elements of a pgvector vector or halfvec column and the text PostgREST carries them as.
Presence
A single shared state between users with Realtime Presence.
PrimitiveType
A primitive Iceberg type such as int, string, decimal(10,2) or fixed[16].
RawTableUpdate
RealtimeChannel
A subscription to a Realtime topic, created with RealtimeClient.channel.
RealtimeChannelConfig
Configuration for a RealtimeChannel's broadcast, presence, and RLS behavior.
RealtimeClient
Manages a persistent WebSocket connection to the Supabase Realtime server.
RealtimeClientOptions
Options to pass to the RealtimeClient.
RealtimeCloseEvent
Event details for when the connection closed.
RealtimeConnectionStatusChange
A connection status change emitted by RealtimeClient.onStatusChange.
RealtimeConstants
Default values used by RealtimeClient.
RealtimeLifecycleOptions
How the realtime socket follows the app lifecycle.
RealtimeMessage
A message as it travels over the Realtime WebSocket connection.
RealtimePresenceJoinPayload
Payload for PresenceEvent.join callback.
RealtimePresenceLeavePayload
Payload for PresenceEvent.leave callback.
RealtimePresencePayload
Base class for the payloads emitted by the presence streams.
RealtimePresenceSyncPayload
Payload for PresenceEvent.sync callback.
RealtimeSubscribeStatusChange
A subscription status change emitted by RealtimeChannel.onStatusChange.
RealtimeSystemPayload
Payload of a system event emitted by the server.
RegisterTableRequest
Request to register an existing metadata file as a table.
RemovePartitionSpecificationsUpdate
RemovePropertiesUpdate
RemoveSchemasUpdate
RemoveSnapshotReferenceUpdate
RemoveSnapshotsUpdate
ReplayOption
Configuration for broadcast replay feature. Allows replaying broadcast messages from a specific point in time.
ResendResponse
The response of AuthClient.resend.
ResumableUpload
An upload sent in chunks with the tus protocol, that can be paused, resumed, cancelled, and continued after the process restarts.
ResumableUploadOptions
How resumable uploads are chunked, retried and persisted.
ResumableUploadProgress
The state of a ResumableUpload at one point in time.
ResumableUploadRecord
A resumable upload the server knows about, as it is persisted.
ResumableUploadStorage
Where resumable uploads keep the records that let them continue after the process restarts.
SAMLAttribute
How one user attribute is read from the SAML assertion.
SAMLAttributeMapping
Maps SAML assertion attributes to user metadata keys.
SAMLMetadata
Where the SAML 2.0 metadata of a single sign-on identity provider comes from.
SAMLMetadataUrl
SAML metadata the Auth server fetches from url.
SAMLMetadataXml
SAML metadata given inline as an XML document.
SAMLProvider
The SAML 2.0 configuration of a single sign-on identity provider.
Session
A signed-in user's authentication tokens.
SetCurrentSchemaUpdate
SetDefaultSortOrderUpdate
SetDefaultSpecificationUpdate
SetLocationUpdate
SetPropertiesUpdate
SetSnapshotReferenceUpdate
SharedPreferencesAuthAsyncStorage
The AuthAsyncStorage that Supabase.initialize uses unless another one is passed, holding the session and the pkce code verifiers.
SignedUploadUrlResponse
The response of StorageFileApi.createSignedUploadUrl.
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.createSignedUrls.
SignedUrlSuccess
A successful SignedUrlResult: the file was found and a signed URL was generated.
SignInWithOtpResponse
The response of AuthClient.signInWithOtp.
SinglePresenceState
A single client connected through presence.
Snapshot
A snapshot of a table at a point in time.
SnapshotReference
A reference (branch or tag) pointing at a snapshot.
SortField
A single field of a SortOrder.
SortOrder
Describes how a table is sorted when written.
SSOProvider
A single sign-on identity provider registered with Supabase Auth.
StorageClientOptions
Configuration for the storage client used by SupabaseClient.storage.
StorageCredential
Temporary storage credentials vended by the server for a table path prefix.
StorageDownload
A download whose response head has arrived, returned by StorageFileApi.downloadStream.
StorageFileApi
API namespace for managing the objects within a bucket, obtained with SupabaseStorageClient.from.
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.
Supabase
Supabase instance.
SupabaseClient
Creates a Supabase client to interact with your Supabase instance.
SupabaseClientInterceptor
Extends a SupabaseClient from the outside, without changing how the application calls it.
SupabaseQueryBuilder
A PostgrestQueryBuilder that can also stream a table's rows over Realtime with stream.
SupabaseQuerySchema
Used to perform rpc and from operations with a different schema than in SupabaseClient.
SupabaseRetryOptions
Configures how a client retries a request that failed in a way that is worth repeating.
SupabaseStorageClient
Client for Supabase Storage, exposed on SupabaseClient.storage.
SupabaseStreamBuilder
A stream of a table's rows kept up to date over Realtime, created with SupabaseQueryBuilder.stream.
SupabaseStreamFilterBuilder
A SupabaseStreamBuilder that can also filter which rows are streamed, created with SupabaseQueryBuilder.stream.
SupabaseTypedQueryBuilder<Row, Insert, Update>
The typed counterpart of SupabaseQueryBuilder, returned by SupabaseClient.table.
SupabaseTypedStreamBuilder<Row, Element>
The typed counterpart of SupabaseStreamBuilder; emits the rows of the table converted into Element: the Row of SupabaseTypedQueryBuilder.stream, through PostgrestTable.rowFromJson, or the PostgrestPartialRow of SupabaseTypedQueryBuilder.streamOnly.
SupabaseTypedStreamFilterBuilder<Row, Element>
A SupabaseTypedStreamBuilder that can still be filtered with filter.
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.
TOTPEnrollment
TOTP enrollment information returned by AuthMFAApi.enroll.
TraceContext
W3C trace context headers.
TracePropagationOptions
Options controlling W3C trace context propagation onto outgoing Supabase requests.
TransformOptions
Specifies the dimensions and the resize mode of the requesting image.
TypedPostgresChange<Row, Element>
A change to a row of a PostgrestTable, as delivered by TypedPostgresChanges.onTableChanges and TypedPostgresChanges.onTableChangesOnly.
TypedPostgresDelete<Row, Element>
A row deleted from the table.
TypedPostgresInsert<Row, Element>
A row inserted into the table.
TypedPostgresUpdate<Row, Element>
A row of the table that was updated.
UnknownType
A nested type this version of the client does not recognize, kept as the json the server sent so that it is written back unchanged.
UpdateCustomProviderOptions
Parameters for updating an existing custom provider.
UpdateNamespacePropertiesResult
The result of a namespace properties update.
UpdateOAuthClientOptions
Parameters for updating an existing OAuth client. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.
UpdateSSOProviderOptions
The changes to apply to a registered single sign-on identity provider.
UpgradeFormatVersionUpdate
UploadResponse
Response of an upload, update or copy operation, describing where the object was stored.
UrlLauncherOAuthLauncher
The default OAuthLauncher: opens url via url_launcher, forcing an external browser for Google sign-in on Android.
User
A user account in Supabase Auth.
UserAttributes
Attributes for AuthClient.updateUser.
UserIdentity
A third-party identity linked to a User.
UserResponse
Response that contains a user
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.
YAJsonIsolate
Encodes and decodes JSON without blocking the calling isolate for long.

Enums

AccessDelegation
Access delegation mechanisms that can be requested from the server for table read and write operations.
AuthChangeEvent
The kind of change reported on AuthClient.onAuthStateChange.
AuthenticationMethodReference
A method used to verify a user's identity, reported in an AuthenticationMethodReferenceEntry.
AuthenticatorAssuranceLevel
How strongly a session's identity has been verified.
AuthFlowType
The OAuth flow used for sign-in, sign-up, and password recovery.
AuthRedirectType
What a callback URL handed to AuthClient.getSessionFromUrl or a code handed to AuthClient.exchangeCodeForSession completed.
BucketSortColumn
The column that StorageBucketApi.listBuckets can sort its results by.
ChannelResponse
The result of sending a message on a RealtimeChannel, such as a broadcast.
ChannelState
The state of a RealtimeChannel, read through RealtimeChannel.state.
CountOption
Returns count as part of the response when specified.
CustomProviderType
Type of a custom OAuth/OIDC provider managed through the admin API.
DistanceMetric
Distance metric used when comparing vectors during a similarity search.
ErrorCode
A machine-readable identifier for an AuthApiException, returned by the Supabase Auth server as the error_code field.
ExplainFormat
The format of the plan returned by PostgrestTransformBuilder.explain.
FactorStatus
Whether an MFA Factor can be used to satisfy a challenge.
FactorType
The kind of second factor an MFA Factor uses.
FileSortColumn
The column that StorageFileApi.list can sort its results by.
GenerateLinkType
The kind of link AuthAdminApi.generateLink generates.
HttpMethod
An HTTP request method.
LaunchMode
The desired mode to launch a URL.
LifecycleRuleStatus
Whether a LifecycleRule runs.
ListInclusion
Whether a listing includes entries that are not current objects, such as noncurrent versions or delete markers.
NullOrder
Where null values are ordered relative to non null values in a SortField.
OAuthClientGrantType
OAuth client grant types supported by the OAuth 2.1 server. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.
OAuthClientRegistrationType
OAuth client registration type. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.
OAuthClientResponseType
OAuth client response types supported by the OAuth 2.1 server. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.
OAuthClientType
OAuth client type indicating whether the client can keep credentials confidential. Only relevant when the OAuth 2.1 server is enabled in Supabase Auth.
OtpChannel
Messaging channel to use (e.g. whatsapp or sms)
OtpType
The kind of one-time password AuthClient.verifyOTP verifies.
PostgresChangeEvent
The kind of Postgres change a PostgresChangeFilter listens for.
PostgresChangeFilterType
Specifies the type of filter to be applied on realtime Postgres Change listener.
PostgrestFilterOperator
A PostgREST filter operator and the token it is sent as.
PostgrestResultShape
The form a PostgrestTableRequest asks its result back in.
PostgrestTableOperation
The database operation a PostgrestTableRequest performs.
PostgresType
A PostgreSQL column type, as sent in the type field of a column description.
PresenceEvent
The kind of change a presence callback is reporting.
RealtimeConnectionStatus
The status of the WebSocket connection reported by RealtimeClient.onStatusChange.
RealtimeHeartbeatStatus
The lifecycle status of a heartbeat reported to RealtimeClient.onHeartbeat.
RealtimeLogLevel
The verbosity of logging the Realtime server does for a connection, sent as the log_level connection parameter.
RealtimeSubscribeStatus
The status of a RealtimeChannel.subscribe call.
RequestImageFormat
The image format StorageFileApi.createSignedUrl and friends request a transformed image in.
ResizeMode
Specifies how image cropping should be handled when performing image transformations.
ResumableUploadStatus
Where a ResumableUpload is.
SAMLNameIdFormat
Format of the SAML NameID a single sign-on identity provider asserts to identify the user.
SignOutReason
The reason why an AuthChangeEvent.signedOut event was emitted.
SignOutScope
Determines which sessions should be logged out.
SnapshotReferenceType
The kind of reference a SnapshotReference points to.
SocketState
The connection state of a RealtimeClient's underlying socket.
SortDirection
The direction that a sorted result set is ordered in.
TableSnapshotScope
Which snapshots the server should include when loading a table.
TextSearchType
The type of tsquery conversion to use on query.
VectorDataType
Supported data types for vector components.
VersioningStatus
Whether a bucket keeps previous versions of its objects.
Web3Chain
The blockchain used to sign in with a Web3 wallet.

Mixins

PostgrestFilterableExpression<Row, Value extends Object>
A column expression that can also sit on the left of a filter operator.
PostgrestNullableExpression<Row, Value extends Object>
A filterable expression whose value the database allows to be NULL, which is what makes isNull available.
PostgrestOrderableExpression<Row, Value extends Object>
A column expression that can be used as an order key.
SupabaseApiException
Mixed into the exceptions that report a response from a Supabase service.
SupabaseTransportException
Mixed into the exceptions thrown when a request never received a response, because the connection failed or the request timed out.

Extension Types

FunctionsRegion
The region an Edge Function is invoked in.
PostgrestJson
A decoded json or jsonb value: a Map, a List, a String, a num, a bool, or null inside a container.

Extensions

AuthClientPasskey on AuthClient
Passkey (WebAuthn) convenience methods that perform the full ceremony, including the platform prompt (FaceID/TouchID/security key), on top of the server side exposed by AuthClient.passkey.
AuthClientRestoreCredential on AuthClient
Android Restore Credentials ("zero-tap sign-in") on top of Supabase passkeys.
AuthClientSignInProvider on AuthClient
Sign-in methods that open a browser or webview, such as OAuth and SSO.
PostgrestArrayFilters on PostgrestFilterableExpression<Row, List<Element>>
Filters that only apply to array columns.
PostgrestBooleanFilters on PostgrestFilterableExpression<Row, bool>
IS checks that only apply to boolean columns.
PostgrestJsonFilters on PostgrestFilterableExpression<Row, PostgrestJson>
Filters that only apply to json and jsonb columns and JSON paths, typed PostgrestJson. Postgres has these operators for jsonb only.
PostgrestMultirangeFilters on PostgrestFilterableExpression<Row, PostgresMultirange<Bound>>
Filters that only apply to multirange columns, typed PostgresMultirange<Bound>.
PostgrestRangeFilters on PostgrestFilterableExpression<Row, PostgresRange<Bound>>
Filters that only apply to range columns, typed PostgresRange<Bound>.
PostgrestTextFilters on PostgrestFilterableExpression<Row, String>
Filters that only apply to text columns.
PostgrestTypedDelete on PostgrestTypedQueryBuilder<Row, Insert, Update>
The DELETE of a table or view whose rows can be updated.
PostgrestTypedReadOnlyDelete on PostgrestTypedQueryBuilder<Row, Insert, Never>
Blocks the DELETE of a relation whose Update type is Never, such as a view that cannot be updated, the same way Never blocks its writes.
PostgrestTypedRowsBuilder on PostgrestTypedTransformBuilder<Row, List<Element>>
The single-row shapes of a builder that resolves to a list of rows, the full Row of a select() or the PostgrestPartialRow of a selectOnly.
StorageByteStream on Stream<Uint8List>
Helpers that consume a stream of downloaded bytes, such as the StorageDownload returned by StorageFileApi.downloadStream.
TypedPostgresChanges on RealtimeChannel
Listens to the Postgres changes of a PostgrestTable, with the rows decoded into the table's types.

Constants

postgresBytea → const PostgresByteaCodec
The bytea codec, see PostgresByteaCodec.
postgresTimestamp → const PostgresTimestampCodec
The timestamp codec, see PostgresTimestampCodec.
postgresVector → const PostgresVectorCodec
The pgvector codec, see PostgresVectorCodec.

Functions

decodeJwt(String token) → DecodedJwt
Decodes a JWT token without performing validation
defaultPersistSessionKey(String supabaseUrl) → String
The key the user session is persisted under for the project at supabaseUrl.
validateExpiration(int? expiresAt) → void
Validates the expiration time of a JWT

Typedefs

DownloadProgressCallback = void Function(int receivedBytes, int? totalBytes)
Reports the progress of a download body.
Headers = Map<String, String>
HTTP request or response headers.
PostgrestConverter<S, T> = S Function(T data)
Converts a decoded response body to the value a query resolves to.
PostgrestList = List<PostgrestMap>
A list of rows, as decoded from a JSON array response body.
PostgrestListResponse = PostgrestResponse<PostgrestList>
A PostgrestResponse whose data is a PostgrestList.
PostgrestMap = Map<String, dynamic>
A single row, as decoded from a JSON object response body.
PostgrestMapResponse = PostgrestResponse<PostgrestMap>
A PostgrestResponse whose data is a PostgrestMap.
RealtimeDecode = Future<RealtimeMessage> Function(Object frame)
Deserializes a raw incoming WebSocket frame (String or binary) into a message.
RealtimeEncode = Future<Object> Function(RealtimeMessage message)
Serializes an outgoing message into the String or binary frame written to the WebSocket.
RowConverter<Row> = Row Function(Map<String, dynamic> json)
Converts a single decoded PostgREST row into Row.
SupabaseStreamEvent = List<Map<String, dynamic>>
A snapshot of the rows a SupabaseStreamBuilder stream emits.
TimerCalculation = Duration Function(int tries)
Returns the delay before the next retry, given the number of tries so far.
TraceContextProvider = FutureOr<TraceContext?> Function()
Supplies the current W3C trace context for outgoing Supabase requests.
UploadProgressCallback = void Function(int receivedBytes, int? totalBytes)
Reports the progress of an upload body.
WebSocketTransport = WebSocketChannel Function(String url, Map<String, String> headers)
Opens the WebSocket connection used by a RealtimeClient.

Exceptions / Errors

AccessTokenException
Thrown when the accessToken callback a client was created with fails.
AuthApiException
Thrown when the auth service answered with an error.
AuthException
Thrown when an auth operation fails.
AuthInvalidJwtException
Thrown when a JWT could not be parsed or verified, for example by AuthClient.getClaims.
AuthPKCEGrantCodeExchangeException
Thrown when a PKCE flow deep link is missing the code query parameter needed to exchange it for a session.
AuthRetryableApiException
Thrown when the auth service answered with a 5xx status, which is worth retrying.
AuthRetryableException
Thrown when an auth request failed in a way that is worth retrying.
AuthRetryableFetchException
Thrown when a request never reached the auth service, for example on a network failure, or when its response could not be decoded, as when a proxy answers in the service's place.
AuthSessionMissingException
Thrown when required session data is unavailable, such as when no session is active, a required access or refresh token is empty, or a response that should have issued a session came without one.
AuthSessionsNotRevokedException
Thrown by AuthClient.signOut with SignOutScope.global or SignOutScope.others when the server rejected the refresh token needed to revoke the sessions.
AuthUnknownException
Thrown when a response could not be interpreted as an auth error, either because it carried no body or because the body was not JSON.
AuthWeakPasswordException
Thrown when a password fails the project's strength requirements.
FunctionsApiException
Thrown when the Edge Function responded with a non-2xx status code.
FunctionsException
Thrown when invoking an Edge Function fails.
FunctionsFetchException
Thrown when the request to the Edge Function could not be sent, for example because of a network or transport failure, or because the request body could not be encoded.
FunctionsRelayException
Thrown when the Supabase relay returns an error while invoking the Edge Function, indicated by the x-relay-error response header.
IcebergApiException
The Iceberg REST Catalog API answered with an error response.
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.
PostgrestApiException
Thrown when PostgREST answered with an error.
PostgrestException
Thrown when a PostgREST request fails.
PostgrestTransportException
Thrown when a request never received a response from PostgREST, because the connection failed or the request timed out.
RealtimeApiException
Thrown when the broadcast REST endpoint answered with an error.
RealtimeException
Thrown when a realtime operation fails.
RealtimeSubscribeException
Delivered to the stream's error handler when the underlying Realtime channel fails to subscribe and does not retry, for example because the server declined the join.
RealtimeTransportException
Thrown when a request to the broadcast REST endpoint never received a response, because the connection failed or the request timed out.
RequestAbortedException
Thrown when an HTTP request is aborted.
ResumableUploadCancelledException
Thrown by a resumable upload that was cancelled with ResumableUpload.cancel, or because the user signed out.
StorageApiException
Thrown when storage answered with an error.
StorageDownloadTooLargeException
Thrown by collectBytes when the stream carries more than the byte cap the caller allowed.
StorageException
Thrown when a storage operation fails.
StorageTransportException
Thrown when a request never received a response from storage, because the connection failed or the request timed out.
SupabaseException
Base class for the exceptions thrown by the Supabase client packages.