Supabase Flutter

https://supabase.com/docs/reference/dart/
Admin
Supabase Flutter is a client library for Dart and Flutter that enables interaction with Postgres...
Tokens:75,792
Snippets:760
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Start a passkey sign in

Source: https://supabase.com/docs/reference/dart/auth-passkey-startauthentication

Starts a passkey sign in without requiring an existing session. Hand the returned options to the platform's passkey API to obtain an assertion, then verify the result with passkey.verifyAuthentication().

```dart
final PasskeyAuthenticationOptionsResponse authentication =
    await supabase.auth.passkey.startAuthentication();

// Hand authentication.options to the platform passkey API.

```

--------------------------------

### Start a passkey registration with supabase.auth.passkey.startRegistration

Source: https://supabase.com/docs/reference/dart/auth-passkey-startregistration

Starts the registration of a new passkey for a signed-in (non-anonymous) user. Pass the returned options to the platform's passkey API before verifying the registration.

```dart
final PasskeyRegistrationOptionsResponse registration =
    await supabase.auth.passkey.startRegistration(
  friendlyName: 'Work laptop',
);

// Hand registration.options to the platform passkey API.

```

--------------------------------

### signInWithWeb3

Source: https://supabase.com/docs/reference/dart/auth-signinwithweb3

Documentation for the signInWithWeb3 method, including parameters and examples for Ethereum and Solana wallets.

```APIDOC
## signInWithWeb3

### Description
Signs in a user by verifying a message signed with their Web3 wallet. Supports Ethereum (Sign-In with Ethereum) and Solana (Sign-In with Solana), both of which derive from the EIP-4361 standard. Handle the wallet interaction and message signing yourself with the wallet library of your choice, then provide the signed `message` together with its `signature`. On success, it signs the user in and returns a session. On failure, it throws an `AuthException`.

### Method
signInWithWeb3

### Parameters
- **chain** (Web3Chain) - Required - The blockchain used to sign in. One of `Web3Chain.ethereum` or `Web3Chain.solana`.
- **message** (String) - Required - The EIP-4361 message that was signed by the user's wallet.
- **signature** (String) - Required - The signature produced by the wallet. Hex encoded for Ethereum, base64url encoded for Solana.
- **captchaToken** (String) - Optional - The verification token received when the user completes the captcha on the app.

### Request Example
```dart
final response = await supabase.auth.signInWithWeb3(
  chain: Web3Chain.ethereum,
  message: message, // The EIP-4361 message signed by the wallet.
  signature: signature, // Hex encoded signature.
);
final session = response.session;
```

### Response
Returns a session on success. Throws an `AuthException` on failure.

### Response Example
```dart
final session = response.session;
```
```

--------------------------------

### createBucket

Source: https://supabase.com/docs/reference/dart/file-buckets-createbucket

Example of creating a new storage bucket using the Supabase Flutter SDK.

```APIDOC
## createBucket

### Description
Creates a new Storage bucket.

### Method
createBucket

### Parameters
- **id** (String) - Required - A unique identifier for the bucket you are creating.
- **bucketOptions** (Object) - Optional - A parameter to optionally make the bucket public.

### Request Example
```dart
final String bucketId = await supabase
  .storage
  .createBucket('avatars');
```

### Response
Returns the bucket ID as a String.
```

--------------------------------

### supabase.auth.passkey.startRegistration

Source: https://supabase.com/docs/reference/dart/auth-passkey-startregistration

Starts the registration process for a new passkey for the currently signed-in user. Returns passkey registration options to be supplied to the platform passkey API.

```APIDOC
## startRegistration

### Description
Starts the registration of a new passkey for the signed-in user. Requires an authenticated, non-anonymous user session. Pass the returned `options` to the platform's passkey API to create the credential, then call `passkey.verifyRegistration()` with the result.

### Method Signature
```dart
Future<PasskeyRegistrationOptionsResponse> startRegistration({
  String? friendlyName,
})
```

### Parameters
- **friendlyName** (String, optional) - Human-readable name used as a fallback for the WebAuthn `user.name`/`displayName` when omitted by the server. Defaults to `'Passkey'` if not provided.

### Returns
- **PasskeyRegistrationOptionsResponse** - Contains the registration options to be forwarded to the platform passkey API.

### Example
```dart
final PasskeyRegistrationOptionsResponse registration =
    await supabase.auth.passkey.startRegistration(
  friendlyName: 'Work laptop',
);

// Hand registration.options to the platform passkey API.
```
```

--------------------------------

### Getting your data

Source: https://supabase.com/docs/reference/dart/select

Select all columns from the 'instruments' table.

```dart
final data = await supabase
  .from('instruments')
  .select();

```

--------------------------------

### Install supabase via Dart CLI

Source: https://supabase.com/docs/reference/dart/installing

Adds the core supabase package to your Dart project from pub.dev.

```shell
dart pub add supabase

```

--------------------------------

### supabase.auth.passkey.startAuthentication

Source: https://supabase.com/docs/reference/dart/auth-passkey-startauthentication

Starts a passkey sign-in flow. It does not require an existing session and returns options to pass to the platform's passkey API before verifying authentication.

```APIDOC
## supabase.auth.passkey.startAuthentication()

### Description
Starts a passkey sign in. Does not require an existing session. Pass the returned `options` to the platform's passkey API to obtain an assertion, then call `passkey.verifyAuthentication()` with the result.

### Parameters
- **captchaToken** (String, optional) - Captcha token to be used for captcha verification.

### Examples
#### Start a passkey sign in
```dart
final PasskeyAuthenticationOptionsResponse authentication =
    await supabase.auth.passkey.startAuthentication();

// Hand authentication.options to the platform passkey API.
```
```

--------------------------------

### Install supabase_flutter via Flutter CLI

Source: https://supabase.com/docs/reference/dart/installing

Adds the supabase_flutter package to your Flutter project from pub.dev.

```shell
flutter pub add supabase_flutter

```

--------------------------------

### Get the execution plan with analyze and verbose

Source: https://supabase.com/docs/reference/dart/using-modifiers-explain

Executes the query to return actual runtime metrics and includes query identifier and output columns by enabling analyze and verbose.

```dart
final data = await supabase
  .from('instruments')
  .select()
  .explain(analyze:true, verbose:true);

```

--------------------------------

### Get the execution plan

Source: https://supabase.com/docs/reference/dart/using-modifiers-explain

Obtains the Postgres EXPLAIN execution plan for a query. By default, the plan is returned as text without executing the query.

```dart
final data = await supabase
  .from('instruments')
  .select()
  .explain();

```

--------------------------------

### Get an index

Source: https://supabase.com/docs/reference/dart/vector-buckets-getindex

Retrieves metadata for a vector index in a bucket. The example uses the 'embeddings' bucket and the index name 'documents', then prints the index's dimension and distance metric.

```dart
final bucket = supabase.storage.vectors.from('embeddings');

final VectorIndex index = await bucket.getIndex('documents');

print(index.dimension);
print(index.distanceMetric);
```

--------------------------------

### Get an analytics catalog client and create a namespace

Source: https://supabase.com/docs/reference/dart/analytics-buckets-analyticscatalog

Obtain an Iceberg REST Catalog client scoped to a single analytics bucket and use it to create a namespace.

```dart
final catalog = supabase
  .storage
  .analyticsCatalog('my-analytics-bucket');

await catalog.createNamespace(['analytics']);

```

--------------------------------

### Get a page of users

Source: https://supabase.com/docs/reference/dart/auth-admin-listusers

Retrieves the first page of users, defaulting to 50 users per page. The result is a list of User objects.

```dart
// Returns the first 50 users.
final List<User> users = await supabase.auth.admin.listUsers();

```

--------------------------------

### Initialize Supabase in Flutter

Source: https://supabase.com/docs/reference/dart/initializing

Initializes the Supabase client in a Flutter app's `main` function using `Supabase.initialize` and gets a client reference via `Supabase.instance.client`.

```dart
Future<void> main() async {
  await Supabase.initialize(
    url: 'https://xyzcompany.supabase.co',
    publishableKey: 'your-publishable-key',
  );

  runApp(MyApp());
}

// Get a reference your Supabase client
final supabase = Supabase.instance.client;

```

--------------------------------

### enroll

Source: https://supabase.com/docs/reference/dart/auth-mfa-enroll

Starts the enrollment process for a new MFA factor. This method creates an unverified factor and returns the QR code or secret for TOTP factors, or the phone number for phone factors.

```APIDOC
## enroll

### Description
Starts the enrollment process for a new Multi-Factor Authentication (MFA) factor. This method creates a new `unverified` factor. To verify a factor, present the QR code or secret to the user and ask them to add it to their authenticator app. The user has to enter the code from their authenticator app to verify it.

### Method
enroll

### Parameters
- **factorType** (Optional) - Type of factor being enrolled.
- **issuer** (Optional) - Domain which the user is enrolled with.
- **friendlyName** (Optional) - Human readable name assigned to the factor.
- **phone** (Optional) - Phone number to enroll for phone factor type.

### Request Example
```dart
final res = await supabase.auth.mfa.enroll(factorType: FactorType.totp);

final qrCodeUrl = res.totp.qrCode;
```

### Response
- **totp** - Contains QR code and secret for TOTP factor.
- **phone** - Contains phone number for phone factor.

### Response Example
```dart
final res = await supabase.auth.mfa.enroll(factorType: FactorType.phone, phone: '+1234567890');

final phone = res.phone;
```
```

--------------------------------

### Initialize Supabase client in v1

Source: https://supabase.com/docs/reference/dart/upgrade-guide

Legacy initialization passing configuration parameters directly to Supabase.initialize().

```dart
await Supabase.initialize(
  url: supabaseUrl,
  publishableKey: publishableKey,
  authFlowType: AuthFlowType.pkce,
  storageRetryAttempts: 10,
  realtimeClientOptions: const RealtimeClientOptions(
    logLevel: RealtimeLogLevel.info,
  ),
);

```

--------------------------------

### signUp

Source: https://supabase.com/docs/reference/dart/auth-signup

Creates a new user. Requires a password and either an email or phone. Returns an AuthResponse with user and optionally session.

```APIDOC
## signUp

### Description
Creates a new user. By default, the user needs to verify their email address before signing in. If Confirm email is enabled, a user is returned but session is null. If disabled, both user and session are returned. If signUp() is called for an existing confirmed user, behavior depends on Confirm email and Confirm phone settings.

### Method
signUp

### Parameters
- **email** (String) - Optional - User's email address to be used for email authentication.
- **phone** (String) - Optional - User's phone number to be used for phone authentication.
- **password** (String) - Required - Password to be used for authentication.
- **emailRedirectTo** (String) - Optional - The URL to redirect the user to after they confirm their email address.
- **data** (Map) - Optional - The user's metadata to be stored in the user's object.
- **captchaToken** (String) - Optional - The captcha token to be used for captcha verification.
- **channel** (OtpChannel) - Optional - Messaging channel to use (e.g. whatsapp or sms). Defaults to `OtpChannel.sms`.

### Request Example
```dart
final AuthResponse res = await supabase.auth.signUp(
  email: 'example@email.com',
  password: 'example-password',
);
```

### Response
Returns an `AuthResponse` object containing `session` and `user` fields. The `session` is null if Confirm email is enabled. The `user` may be an obfuscated/fake user object if the user already exists and both Confirm email and Confirm phone are enabled.

### Response Example
```dart
final Session? session = res.session;
final User? user = res.user;
```

```

--------------------------------

### Get all channels with getChannels

Source: https://supabase.com/docs/reference/dart/getchannels

Returns all Realtime channels associated with the Supabase client.

```dart
final channels = supabase.getChannels();

```

--------------------------------

### listUsers

Source: https://supabase.com/docs/reference/dart/auth-admin-listusers

Get a list of users. Defaults to return 50 users per page.

```APIDOC
## listUsers

### Description
Get a list of users. Defaults to return 50 users per page.

### Method
listUsers

### Parameters
- **page** (int) - Optional - What page of users to return.
- **perPage** (int) - Optional - How many users to be returned per page. Defaults to 50.

### Request Example
```dart
// Returns the first 50 users.
final List<User> users = await supabase.auth.admin.listUsers();
```

### Response
Returns a list of User objects.

### Response Example
```dart
// Returns the 101th - 200th users.
final List<User> res = await supabase.auth.admin.listUsers(
  page: 2,
  perPage: 100,
);
```
```

--------------------------------

### Sign up with email and password

Source: https://supabase.com/docs/reference/dart/auth-signup

Creates a new user with email and password. By default, the user must verify their email before signing in unless 'Confirm email' is disabled. If 'Confirm email' is enabled, a user is returned but session is null; if disabled, both user and session are returned.

```dart
final AuthResponse res = await supabase.auth.signUp(
  email: 'example@email.com',
  password: 'example-password',
);
final Session? session = res.session;
final User? user = res.user;

```

--------------------------------

### supabase.auth.getUserIdentities()

Source: https://supabase.com/docs/reference/dart/auth-getuseridentities

Gets all the identities linked to a user. The user needs to be signed in to call this method.

```APIDOC
## supabase.auth.getUserIdentities()

### Description
Gets all the identities linked to a user. The user needs to be signed in to call `getUserIdentities()`.

### Example
```dart
final identities = await supabase.auth.getUserIdentities();
```
```

--------------------------------

### Get the signed-in user

Source: https://supabase.com/docs/reference/dart/auth-currentuser

Returns the user data if there is an active session with a signed-in user.

```dart
final User? user = supabase.auth.currentUser;

```

--------------------------------

### Obtain initial session using SupabaseAuth.initialSession (v1)

Source: https://supabase.com/docs/reference/dart/upgrade-guide

Demonstrates obtaining the initial app session via the deprecated `SupabaseAuth.initialSession` property.

```dart
// Use `initialSession` to obtain the initial session when the app starts.
final initialSession = await SupabaseAuth.initialSession;

```

--------------------------------

### Initialize Supabase client with organized options in v2

Source: https://supabase.com/docs/reference/dart/upgrade-guide

Use FlutterAuthClientOptions and StorageClientOptions to organize custom configuration in Supabase.initialize().

```dart
await Supabase.initialize(
  url: 'SUPABASE_URL',
  publishableKey: 'SUPABASE_PUBLISHABLE_KEY',
  authOptions: const FlutterAuthClientOptions(
    authFlowType: AuthFlowType.pkce,
  ),
  realtimeClientOptions: const RealtimeClientOptions(
    logLevel: RealtimeLogLevel.info,
  ),
  storageOptions: const StorageClientOptions(
    retryAttempts: 10,
  ),
);

```

--------------------------------

### listBuckets([options])

Source: https://supabase.com/docs/reference/dart/file-buckets-listbuckets

Retrieves the details of all Storage buckets within an existing product. Supports optional filtering, sorting, and pagination parameters.

```APIDOC
## listBuckets

### Description
Retrieves the details of all Storage buckets within an existing product.

### Permissions Required
- `buckets` permissions: `select`
- `objects` permissions: none

### Parameters
- **options** (`ListBucketsOptions`, optional) - Optionally filter, sort, and paginate the returned buckets. Calling `listBuckets()` without any options returns all buckets.

### Return Value
- Returns `Future<List<Bucket>>` containing the bucket details.

### Examples

#### List buckets
```dart
final List<Bucket> buckets = await supabase
  .storage
  .listBuckets();
```

#### With filter, sort and pagination
```dart
final List<Bucket> buckets = await supabase
  .storage
  .listBuckets(
    const ListBucketsOptions(
      limit: 10,
      offset: 0,
      search: 'avatar',
      sortColumn: BucketSortColumn.createdAt,
      sortOrder: BucketSortOrder.descending,
    ),
  );
```
```

--------------------------------

### list()

Source: https://supabase.com/docs/reference/dart/file-buckets-list

Lists all the files within a bucket. Requires select permissions on objects.

```APIDOC
## list

### Description
Lists all the files within a bucket.

### Policy Permissions Required
- `buckets` permissions: none
- `objects` permissions: `select`

### Parameters
- **path** (Required) - The folder path.
- **searchOptions** (Optional) - Options for the search operations such as limit and offset.

### Dart SDK Example
```dart
final List<FileObject> objects = await supabase
  .storage
  .from('avatars')
  .list();
```
```

--------------------------------

### Querying with count option

Source: https://supabase.com/docs/reference/dart/select

Select the 'name' column and get an exact count of rows using the count option.

```dart
final res = await supabase
    .from('instruments')
    .select('name')
    .count(CountOption.exact);

final data = res.data;
final count = res.count;

```

--------------------------------

### Get bucket

Source: https://supabase.com/docs/reference/dart/file-buckets-getbucket

Retrieves the details of an existing bucket identified by its ID ('avatars'). Requires 'select' permissions on 'buckets'.

```dart
final Bucket bucket = await supabase
  .storage
  .getBucket('avatars');
```

--------------------------------

### listVectors

Source: https://supabase.com/docs/reference/dart/vector-buckets-listvectors

Documentation for the listVectors method in the Flutter Supabase SDK, including examples for basic listing and parallel scanning.

```APIDOC
## listVectors

### Description
Lists vectors in the scoped index with pagination. A full-index scan can be distributed across multiple workers by giving each worker a different `segmentIndex` (0 to `segmentCount - 1`) for the same `segmentCount` (1 to 16).

### Method
listVectors (Flutter SDK method)

### Endpoint
`supabase.storage.vectors.from('embeddings').index('documents').listVectors(...)`

### Parameters
- **maxResults** (int) - Optional - Maximum number of vectors to return.
- **returnMetadata** (bool) - Optional - Whether to return metadata for each vector.
- **segmentCount** (int) - Optional - Number of segments for parallel scan (1 to 16).
- **segmentIndex** (int) - Optional - Index of the segment for this worker (0 to segmentCount - 1).

### Request Example
```dart
final index = supabase.storage.vectors
    .from('embeddings')
    .index('documents');

final VectorList result = await index.listVectors(
  maxResults: 100,
  returnMetadata: true,
);

for (final vector in result.vectors) {
  print(vector.key);
}
```

### Response
Returns a `VectorList` object containing the vectors. Each vector has a `key` property.

### Response Example
```dart
final VectorList result = await index.listVectors(
  maxResults: 100,
  returnMetadata: true,
);

for (final vector in result.vectors) {
  print(vector.key);
}
```
```

--------------------------------

### explain()

Source: https://supabase.com/docs/reference/dart/using-modifiers-explain

Obtains the Postgres EXPLAIN execution plan of a query for debugging slow queries. Works on any query, including rpc() calls or write operations.

```APIDOC
## explain()

### Description
For debugging slow queries, you can get the Postgres `EXPLAIN` execution plan of a query using the `explain()` method. This works on any query, even for `rpc()` or writes.

### Parameters
- **analyze** (bool, optional) - If `true`, the query will be executed and the actual run time will be returned.
- **verbose** (bool, optional) - If `true`, the query identifier will be returned and `data` will include the output columns of the query.
- **settings** (bool, optional) - If `true`, include information on configuration parameters that affect query planning.
- **buffers** (bool, optional) - If `true`, include information on buffer usage.
- **wal** (bool, optional) - If `true`, include information on WAL record generation.
- **format** (ExplainFormat, optional) - The output format of the execution plan. Either `ExplainFormat.text` (default) or `ExplainFormat.json`, in which case the plan is returned as a JSON string.

### Examples

#### Get the execution plan
```dart
final data = await supabase
  .from('instruments')
  .select()
  .explain();
```

#### Get the execution plan with analyze and verbose
```dart
final data = await supabase
  .from('instruments')
  .select()
  .explain(analyze: true, verbose: true);
```
```

--------------------------------

### Get public URL with transform

Source: https://supabase.com/docs/reference/dart/file-buckets-getpublicurl

Transforms the asset before serving it to the client. The transform parameter accepts TransformOptions with width and height.

```dart
final String publicUrl = await supabase
  .storage
  .from('public-bucket')
  .getPublicUrl(
    'avatar1.png',
    transform: TransformOptions(
      width: 200,
      height: 200,
    ),
  );

```

--------------------------------

### supabase.auth.passkey.verifyAuthentication

Source: https://supabase.com/docs/reference/dart/auth-passkey-verifyauthentication

Completes a passkey sign in and returns the new session. On success, the session is persisted and an AuthChangeEvent.signedIn event is fired.

```APIDOC
## supabase.auth.passkey.verifyAuthentication

### Description
Completes a passkey sign in and returns the new session. On success the session is persisted and an `AuthChangeEvent.signedIn` event is fired.

### Parameters
- **challengeId** (Required) - The challenge ID returned by `passkey.startAuthentication()`.
- **credential** (Required) - The assertion produced by the platform's passkey API, serialized in the W3C `AuthenticationResponseJSON` format.

### Usage Example
```dart
final AuthResponse res = await supabase.auth.passkey.verifyAuthentication(
  challengeId: authentication.challengeId,
  credential: credential,
);
final Session? session = res.session;
final User? user = res.user;
```
```

--------------------------------

### supabase.auth.admin.customProviders.getProvider(identifier)

Source: https://supabase.com/docs/reference/dart/custom-provider-admin-getprovider

Gets details of a specific custom provider by its identifier. It returns a CustomOAuthProvider instance representing the provider configuration.

```APIDOC
## supabase.auth.admin.customProviders.getProvider(identifier)

### Description
Gets details of a specific custom provider by its identifier.

### Parameters
- **identifier** (String) - Required - The provider identifier, for example `custom:mycompany`.

### Usage Example
```dart
final CustomOAuthProvider provider =
    await supabase.auth.admin.customProviders.getProvider('custom:mycompany');
```
```

--------------------------------

### Returns a list of identities linked to the user

Source: https://supabase.com/docs/reference/dart/auth-getuseridentities

Gets all identities linked to the user. The user needs to be signed in to call `getUserIdentities()`.

```dart
final identities = await supabase.auth.getUserIdentities();

```

--------------------------------

### Initialize SupabaseClient for Dart projects

Source: https://supabase.com/docs/reference/dart/initializing

Initializes a `SupabaseClient` instance directly with a URL and key for server-side or non-Flutter Dart projects.

```dart
final supabase = SupabaseClient(
  'https://xyzcompany.supabase.co',
  'your-secret-key', // use your secret key for server-side usage
);

```

--------------------------------

### Access session directly on startup in v1

Source: https://supabase.com/docs/reference/dart/upgrade-guide

In v1, Supabase.initialize() awaited session refresh before returning, ensuring the session was valid on launch.

```dart
// Session is valid, no check required
final session = supabase.auth.currentSession;

```

--------------------------------

### Get a custom provider with getProvider

Source: https://supabase.com/docs/reference/dart/custom-provider-admin-getprovider

Retrieves the details of a custom OAuth provider by providing its required identifier string, such as 'custom:mycompany'.

```dart
final CustomOAuthProvider provider =
    await supabase.auth.admin.customProviders.getProvider('custom:mycompany');

```

--------------------------------

### Enroll a TOTP factor

Source: https://supabase.com/docs/reference/dart/auth-mfa-enroll

Starts enrollment for a TOTP factor. The returned response contains a QR code URL that you present to the user for verification.

```dart
final res = await supabase.auth.mfa.enroll(factorType: FactorType.totp);

final qrCodeUrl = res.totp.qrCode;

```

--------------------------------

### Sign in with Apple using sign_in_with_apple and signInWithIdToken in v2

Source: https://supabase.com/docs/reference/dart/upgrade-guide

Use the separate sign_in_with_apple package alongside auth.generateRawNonce() to authenticate with Apple via signInWithIdToken.

```dart
Future<AuthResponse> signInWithApple() async {
  final rawNonce = supabase.auth.generateRawNonce();
  final hashedNonce = sha256.convert(utf8.encode(rawNonce)).toString();

  final credential = await SignInWithApple.getAppleIDCredential(
    scopes: [
      AppleIDAuthorizationScopes.email,
      AppleIDAuthorizationScopes.fullName,
    ],
    nonce: hashedNonce,
  );

  final idToken = credential.identityToken;
  if (idToken == null) {
    throw const AuthException(
        'Could not find ID Token from generated credential.',
    );
  }

  return signInWithIdToken(
    provider: OAuthProvider.apple,
    idToken: idToken,
    nonce: rawNonce,
  );
}

```

--------------------------------

### Create bucket with createBucket

Source: https://supabase.com/docs/reference/dart/file-buckets-createbucket

Creates a new storage bucket with the specified id. Requires the 'insert' permission on 'buckets'. The returned bucketId is a String.

```dart
final String bucketId = await supabase
  .storage
  .createBucket('avatars');

```

--------------------------------

### Get the session data with currentSession

Source: https://supabase.com/docs/reference/dart/auth-currentsession

Synchronously returns whatever session data is currently stored, even if the access token has already expired.

```dart
final Session? session = supabase.auth.currentSession;

```

--------------------------------

### Enroll a phone factor

Source: https://supabase.com/docs/reference/dart/auth-mfa-enroll

Starts enrollment for a phone factor. Provide the phone number as the `phone` parameter; the response contains the phone number used.

```dart
final res = await supabase.auth.mfa.enroll(factorType: FactorType.phone, phone: '+1234567890');

final phone = res.phone;

```

--------------------------------

### List all buckets

Source: https://supabase.com/docs/reference/dart/file-buckets-listbuckets

Retrieves all Storage buckets. Requires `select` permissions on `buckets`.

```dart
final List<Bucket> buckets = await supabase
  .storage
  .listBuckets();

```

--------------------------------

### Get a vector bucket

Source: https://supabase.com/docs/reference/dart/vector-buckets-getbucket

Retrieves the metadata of an existing vector bucket by its name. The method returns a VectorBucket object containing the bucket's metadata.

```dart
final vectors = supabase.storage.vectors;

final VectorBucket bucket = await vectors.getBucket('embeddings');
```

--------------------------------

### Create user with custom metadata using createUser

Source: https://supabase.com/docs/reference/dart/auth-admin-createuser

Creates a new user by providing an email, password, and custom metadata dictionary.

```dart
final res = await supabase.auth.admin.createUser(AdminUserAttributes(
  email: 'user@email.com',
  password: 'password',
  userMetadata: {'name': 'Yoda'},
));
```

--------------------------------

### With select()

Source: https://supabase.com/docs/reference/dart/using-filters-or

Use `.or()` with `.select()` to filter rows. This example selects the 'name' column from 'instruments' where id equals 2 or name equals 'cello'.

```dart
final data = await supabase
  .from('instruments')
  .select('name')
  .or('id.eq.2,name.eq.cello');
```

--------------------------------

### Supabase.initialize()

Source: https://supabase.com/docs/reference/dart/initializing

Initializes the Supabase client static instance for Flutter applications. Provides the main entrypoint to interact with Supabase services.

```APIDOC
## Supabase.initialize()

### Description
Initializes Supabase with the static `initialize()` method of the `Supabase` class. The Supabase client is your entrypoint to the rest of the Supabase functionality.

### Parameters
- **url** - Required - The unique Supabase URL which is supplied when you create a new project in your project dashboard.
- **publishableKey** - Required - The publishable (anon) key supplied when you create a new project in your project dashboard. Use this for client-side apps. The deprecated `anonKey` parameter is still accepted but `publishableKey` takes precedence when both are supplied.
- **headers** - Optional - Custom header to be passed to the Supabase client.
- **httpClient** - Optional - Custom http client to be used by the Supabase client.
- **authOptions** - Optional - Options to change the Auth behaviors.
- **postgrestOptions** - Optional - Options to change the Postgrest behaviors.
- **realtimeClientOptions** - Optional - Options to change the Realtime behaviors.
- **storageOptions** - Optional - Options to change the Storage behaviors.

### Usage Example
```dart
Future<void> main() async {
  await Supabase.initialize(
    url: 'https://xyzcompany.supabase.co',
    publishableKey: 'your-publishable-key',
  );

  runApp(MyApp());
}

// Get a reference your Supabase client
final supabase = Supabase.instance.client;
```
```

--------------------------------

### Create analytics bucket with createAnalyticsBucket

Source: https://supabase.com/docs/reference/dart/analytics-buckets-createanalyticsbucket

Creates an analytics bucket with the given id. Requires the 'insert' permission on buckets. The returned AnalyticsBucket object represents the newly created bucket.

```dart
final AnalyticsBucket bucket = await supabase
  .storage
  .createAnalyticsBucket('warehouse');

```

--------------------------------

### range

Source: https://supabase.com/docs/reference/dart/using-modifiers-range

Limits query results to rows within the specified range, inclusive. Accepts starting and ending indices as well as an optional referenced table parameter.

```APIDOC
## range

### Description
Limits the result to rows within the specified range, inclusive.

### Parameters
- **from** (Required) - The starting index from which to limit the result.
- **to** (Required) - The last index to which to limit the result.
- **referencedTable** (Optional) - Set this to limit rows of referenced tables instead of the parent table.

### Example
```dart
final data = await supabase
  .from('instruments')
  .select('name')
  .range(0, 1);
```
```

--------------------------------

### Verify a passkey sign in with verifyAuthentication

Source: https://supabase.com/docs/reference/dart/auth-passkey-verifyauthentication

Completes a passkey sign in using the challenge ID and assertion credential. On success, the session is persisted and an AuthChangeEvent.signedIn event is fired.

```dart
final AuthResponse res = await supabase.auth.passkey.verifyAuthentication(
  challengeId: authentication.challengeId,
  credential: credential,
);
final Session? session = res.session;
final User? user = res.user;

```

--------------------------------

### Upload file on web with supabase.storage.from().uploadBinary()

Source: https://supabase.com/docs/reference/dart/file-buckets-upload

Uploads binary data as a Uint8List to an existing storage bucket on web platforms.

```dart
final Uint8List avatarFile = file.bytes;
final String fullPath = await supabase.storage.from('avatars').uploadBinary(
      'public/avatar1.png',
      avatarFile,
      fileOptions: const FileOptions(cacheControl: '3600', upsert: false),
    );
```

--------------------------------

### Use `or` on referenced tables

Source: https://supabase.com/docs/reference/dart/using-filters-or

Use `.or()` with `referencedTable` to filter on a referenced table. This example selects from 'orchestral_sections' and filters on the 'instruments' table using `referencedTable: 'instruments'`.

```dart
final data = await supabase
  .from('orchestral_sections')
  .select('''
    name,
    instruments!inner (
      name
    )
  ''')
  .or('section_id.eq.1,name.eq.guzheng', referencedTable: 'instruments' );
```

--------------------------------

### List files in a bucket

Source: https://supabase.com/docs/reference/dart/file-buckets-list

Lists all the files within a specified storage bucket. Requires 'select' permissions on objects.

```dart
final List<FileObject> objects = await supabase
  .storage
  .from('avatars')
  .list();
```

--------------------------------

### Request count and head using FetchOptions (v1)

Source: https://supabase.com/docs/reference/dart/upgrade-guide

Shows the deprecated `FetchOptions` configuration for counting rows and executing head requests.

```dart
// Request with count option
final res = await supabase.from('cities').select(
      'name',
      const FetchOptions(
        count: CountOption.exact,
      ),
    );

final data = res.data;
final count = res.count;

// Request with count and head option
// obtains the count value without fetching the data.
final res = await supabase.from('cities').select(
      'name',
      const FetchOptions(
        count: CountOption.exact,
        head: true,
      ),
    );

final count = res.count;

```

--------------------------------

### Use `or` with `and`

Source: https://supabase.com/docs/reference/dart/using-filters-or

Combine `.or()` with an `and` group inside the filter string. This example selects instruments where id > 3 or (id equals 1 and name equals 'violin').

```dart
final data = await supabase
  .from('instruments')
  .select('name')
  .or('id.gt.3,and(id.eq.1,name.eq.violin)');
```

--------------------------------

### Native Google sign in with signInWithIdToken

Source: https://supabase.com/docs/reference/dart/auth-signinwithidtoken

Performs native Google sign in using google_sign_in and authenticates with Supabase using both idToken and accessToken.

```dart
import 'package:google_sign_in/google_sign_in.dart';
import 'package:supabase_flutter/supabase_flutter.dart';

const webClientId = '<web client ID that you registered on Google Cloud, for example my-web.apps.googleusercontent.com>';

const iosClientId = '<iOS client ID that you registered on Google Cloud, for example my-ios.apps.googleusercontent.com';

final GoogleSignIn googleSignIn = GoogleSignIn(
  clientId: iosClientId,
  serverClientId: webClientId,
);
final googleUser = await googleSignIn.signIn();
final googleAuth = await googleUser!.authentication;
final accessToken = googleAuth.accessToken;
final idToken = googleAuth.idToken;

if (accessToken == null) {
  throw 'No Access Token found.';
}
if (idToken == null) {
  throw 'No ID Token found.';
}

final response = await supabase.auth.signInWithIdToken(
  provider: OAuthProvider.google,
  idToken: idToken,
  accessToken: accessToken,
);
```

--------------------------------

### Sign in with an Ethereum wallet using signInWithWeb3

Source: https://supabase.com/docs/reference/dart/auth-signinwithweb3

Signs in a user with an Ethereum wallet by providing the EIP-4361 message and its hex-encoded signature. The wallet interaction and message signing must be handled externally. On success, returns a session; on failure, throws an AuthException.

```dart
final response = await supabase.auth.signInWithWeb3(
  chain: Web3Chain.ethereum,
  message: message, // The EIP-4361 message signed by the wallet.
  signature: signature, // Hex encoded signature.
);
final session = response.session;

```

--------------------------------

### Get authorization details with getAuthorizationDetails

Source: https://supabase.com/docs/reference/dart/oauth-server-getauthorizationdetails

Retrieves details about a pending OAuth authorization request using the authorization ID from the query parameters. Handles both OAuthAuthorizationRedirectResponse and OAuthAuthorizationDetailsResponse cases.

```dart
final authorizationId =
    Uri.parse(currentUrl).queryParameters['authorization_id']!;

final response =
    await supabase.auth.oauth.getAuthorizationDetails(authorizationId);

switch (response) {
  case OAuthAuthorizationRedirectResponse(:final redirectUrl):
    // The user already consented; forward them without a consent screen.
    break;
  case OAuthAuthorizationDetailsResponse(:final client, :final scope):
    // Render a consent screen for `client` requesting `scope`.
    break;
}

```

--------------------------------

### challengeAndVerify

Source: https://supabase.com/docs/reference/dart/auth-mfa-challengeandverify

Creates a challenge and immediately verifies the given code against it. Requires an enrolled factor. Executes mfa.challenge() and mfa.verify() in a single step.

```APIDOC
## challengeAndVerify

### Description
Helper method which creates a challenge and immediately uses the given code to verify against it thereafter. The verification code is provided by the user by entering a code seen in their authenticator app. An enrolled factor is required before invoking `challengeAndVerify()`. Executes `mfa.challenge()` and `mfa.verify()` in a single step.

### Parameters
- **factorId** (string) - Required - System assigned identifier for authenticator device as returned by enroll
- **code** (string) - Required - The verification code on the user's authenticator app

### Example
Create and verify a challenge for a factor

```dart
final res = await supabase.auth.mfa.challengeAndVerify(
  factorId: '34e770dd-9ff9-416c-87fa-43b31d7ef225',
  code: '123456',
);
```
```

--------------------------------

### supabase.auth.setSession

Source: https://supabase.com/docs/reference/dart/auth-setsession

Takes a refresh token and uses it to get a new session. The refresh token can only be used once due to refresh token rotation unless a reuse interval is configured.

```APIDOC
## setSession

### Description
Takes in a refresh token and uses it to get a new session. The refresh token can only be used once to obtain a new session due to refresh token rotation enabled by default.

### Method Signature
```dart
Future<AuthResponse> setSession(String refreshToken, {String? accessToken})
```

### Parameters
- **refreshToken** (`String`) - Required - Refresh token to use to get a new session.
- **accessToken** (`String`) - Optional - Optional access token to set along with the refresh token.

### Response
Returns a `Future<AuthResponse>` containing the new session details.

### Examples

#### Refresh the session
```dart
final refreshToken = supabase.currentSession?.refreshToken ?? '';
final AuthResponse response = await supabase.auth.setSession(refreshToken);

final session = res.session;
```

#### Set session with access token
```dart
final AuthResponse response = await supabase.auth.setSession(
  refreshToken,
  accessToken: accessToken,
);
```
```

--------------------------------

### DELETE /from/{table}

Source: https://supabase.com/docs/reference/dart/delete

This snippet documents the delete operation on a table or view. It includes examples for deleting single records, multiple records, and fetching deleted records.

```APIDOC
## DELETE /from/{table}

### Description
Perform a DELETE on the table or view. `delete()` should always be combined with Filters to target the item(s) you wish to delete. If you use `delete()` with filters and you have RLS enabled, only rows visible through `SELECT` policies are deleted. Note that by default no rows are visible, so you need at least one `SELECT`/`ALL` policy that makes the rows visible.

### Method
DELETE

### Endpoint
`/from/{table}`

### Parameters
#### Path Parameters
- **table** (string) - Required - The name of the table or view to delete from.

#### Query Parameters
- **Filters** (object) - Required - Filters to target the item(s) to delete. Use methods like `eq`, `inFilter`, `match` to specify conditions.

### Request Example
```dart
await supabase
  .from('countries')
  .delete()
  .eq('id', 1);
```

### Response
#### Success Response (200)
- **data** (array) - The deleted rows if `select()` is used; otherwise empty.

#### Response Example
```dart
final List<Map<String,dynamic>> data = await supabase
  .from('cities')
  .delete()
  .match({ 'id': 666 })
  .select();
```
```

--------------------------------

### Sign in with a passkey using signInWithPasskey

Source: https://supabase.com/docs/reference/dart/auth-signinwithpasskey

Signs in a user using passkeys by providing a PasskeyAuthenticator instance to perform the platform ceremony. On success, the session is persisted and an AuthResponse containing the user and session is returned.

```dart
import 'package:passkeys/authenticator.dart';

final authenticator = PasskeyAuthenticator();

final AuthResponse res = await supabase.auth.signInWithPasskey(authenticator);
final Session? session = res.session;
final User? user = res.user;
```

--------------------------------

### createAnalyticsBucket

Source: https://supabase.com/docs/reference/dart/analytics-buckets-createanalyticsbucket

Creates a new analytics bucket backed by the Apache Iceberg table format. Requires the `insert` permission on `buckets`.

```APIDOC
## createAnalyticsBucket

### Description
Creates a new analytics bucket backed by the Apache Iceberg table format.

### Method
createAnalyticsBucket

### Parameters
- **id** (string) - Required - A unique identifier for the analytics bucket you are creating.

### Request Example
```dart
final AnalyticsBucket bucket = await supabase
  .storage
  .createAnalyticsBucket('warehouse');
```

### Response
Returns an `AnalyticsBucket` object representing the created bucket.

### Permissions
- `buckets` permissions: `insert`
- `objects` permissions: none
```

--------------------------------

### Paginated list of users

Source: https://supabase.com/docs/reference/dart/auth-admin-listusers

Retrieves a specific page of users by specifying the page number and the number of users per page. This example returns users 101 to 200.

```dart
// Returns the 101th - 200th users.
final List<User> res = await supabase.auth.admin.listUsers(
  page: 2,
  perPage: 100,
);

```

--------------------------------

### Sign up with phone number and password (SMS)

Source: https://supabase.com/docs/reference/dart/auth-signup

Signs up a new user using a phone number and password, with SMS as the messaging channel. The channel parameter defaults to OtpChannel.sms if not specified.

```dart
final AuthResponse res = await supabase.auth.signUp(
  phone: '123456789',
  password: 'example-password',
  channel: OtpChannel.sms,
);

```

--------------------------------

### supabase.auth.oauth.getAuthorizationDetails(authorizationId)

Source: https://supabase.com/docs/reference/dart/oauth-server-getauthorizationdetails

Retrieves details about a pending OAuth authorization request so you can render a consent screen. The authorization ID is provided as a query parameter on the redirect URL that starts the flow.

```APIDOC
## getAuthorizationDetails

### Description
Retrieves details about a pending OAuth authorization request so you can render a consent screen. The `authorizationId` is provided as a query parameter on the redirect URL that starts the flow.

### Parameters
- **authorizationId** (String) - Required - The unique identifier of the pending authorization request.

### Returns
Returns a sealed `OAuthAuthorizationResponse` with two variants:
- **OAuthAuthorizationDetailsResponse**: Carries the requesting `client` and requested `scope` for the consent screen.
- **OAuthAuthorizationRedirectResponse**: Returned when the user has already granted consent and carries a `redirectUrl` to forward to.

### Example
```dart
final authorizationId =
    Uri.parse(currentUrl).queryParameters['authorization_id']!;

final response =
    await supabase.auth.oauth.getAuthorizationDetails(authorizationId);

switch (response) {
  case OAuthAuthorizationRedirectResponse(:final redirectUrl):
    // The user already consented; forward them without a consent screen.
    break;
  case OAuthAuthorizationDetailsResponse(:final client, :final scope):
    // Render a consent screen for `client` requesting `scope`.
    break;
}
```
```

--------------------------------

### Verify a passkey registration with verifyRegistration

Source: https://supabase.com/docs/reference/dart/auth-passkey-verifyregistration

Completes the registration of a new passkey using the challenge ID from startRegistration and the platform credential, returning the stored Passkey.

```dart
final Passkey passkey = await supabase.auth.passkey.verifyRegistration(
  challengeId: registration.challengeId,
  credential: credential,
);

```

--------------------------------

### Get vectors by key

Source: https://supabase.com/docs/reference/dart/vector-buckets-getvectors

Retrieves vectors by their keys from a specified index. Set returnData and returnMetadata to include embeddings and metadata in the result. Keys that do not exist are omitted from the returned list.

```dart
final index = supabase.storage.vectors
    .from('embeddings')
    .index('documents');

final List<VectorMatch> vectors = await index.getVectors(
  keys: ['doc-1', 'doc-2'],
  returnData: true,
  returnMetadata: true,
);

for (final vector in vectors) {
  print('${vector.key}: ${vector.metadata}');
}

```

--------------------------------

### Get the AAL details of a session

Source: https://supabase.com/docs/reference/dart/auth-mfa-getauthenticatorassurancelevel

Retrieves the Authenticator Assurance Level (AAL) details for the current session, including current level, next level, and current authentication methods.

```dart
final res = supabase.auth.mfa.getAuthenticatorAssuranceLevel();
final currentLevel = res.currentLevel;
final nextLevel = res.nextLevel;
final currentAuthenticationMethods = res.currentAuthenticationMethods;

```

--------------------------------

### Sign in with Apple using built-in method in v1

Source: https://supabase.com/docs/reference/dart/upgrade-guide

Legacy signInWithApple method built directly into the client library.

```dart
await supabase.auth.signInWithApple();

```

--------------------------------

### Get the session data with getSession

Source: https://supabase.com/docs/reference/dart/auth-currentsession

Asynchronously retrieves a valid session, automatically refreshing an expired token on demand. Returns null if there is no session and throws an AuthException if refresh fails.

```dart
final session = await supabase.auth.getSession();

```

--------------------------------

### from

Source: https://supabase.com/docs/reference/dart/vector-buckets-from

Scopes vector storage operations to a single vector bucket and returns a StorageVectorBucketApi instance.

```APIDOC
## from

### Description
Scopes vector storage operations to a single vector bucket and returns a StorageVectorBucketApi instance.

### Method
from

### Endpoint
supabase.storage.vectors.from(bucketName)

### Parameters
#### Path Parameters
- **bucketName** (string) - Required - The name of the vector bucket to scope operations to.

### Request Example
```dart
final bucket = supabase.storage.vectors.from('embeddings');
```

### Response
#### Success Response
Returns a StorageVectorBucketApi instance for the specified bucket.

#### Response Example
```dart
final bucket = supabase.storage.vectors.from('embeddings');
```
```
Tokens:
Raw