Supabase Swift

https://supabase.com/docs/reference/swift/
Admin
Supabase Swift is a client library for building iOS and macOS applications with Supabase, enabling...
Tokens:364,554
Snippets:6,779
Trust Score:9.8
Update:2 months ago
Show doc for...
Tokens:
Raw
### supabase.auth.startAutoRefresh()

Source: https://supabase.com/docs/reference/swift/auth-exchangecodeforsession

Starts the automatic session refresh process for non-browser environments.

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

### Description
Starts the automatic session refresh process.

### Method
`supabase.auth.startAutoRefresh()`
```

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

### Get passkey authentication options

Source: https://supabase.com/docs/reference/swift/auth-exchangecodeforsession

Fetches W3C PublicKeyCredentialRequestOptions to initiate passkey authentication. The returned options must be passed to the platform authenticator.

```swift
// @_spi(Experimental) import Supabase
let options: PasskeyAuthenticationOptions = try await supabase.auth.getPasskeyAuthenticationOptions()
// Hand options.options to the platform authenticator.
```

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

### Initialize Supabase Client

Source: https://supabase.com/docs/reference/swift/auth-exchangecodeforsession

The entry point for interacting with Supabase services using your project URL and API key.

```swift
import Supabase

let client = SupabaseClient(supabaseURL: URL(string: "https://xyzcompany.supabase.co")!, supabaseKey: "your-publishable-key")
```

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

### Filter Chaining Examples

Source: https://supabase.com/docs/reference/swift/auth-admin-updateuserbyid

Demonstrates the correct order of operations when chaining filters with select, and an incorrect example showing filter application before selection.

```swift
try await supabase
  .from("cities")
  .select("name, country_id")
  .eq("name", value: "The Shire")    // Correct
```

```swift
try await supabase
  .from("citites")
  .eq("name", value: "The Shire")    // Incorrect
  .select("name, country_id")
```

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

### Create a bucket

Source: https://supabase.com/docs/reference/swift/auth-admin-inviteuserbyemail

Creates a new storage bucket with optional configuration settings.

```APIDOC
## Create a bucket

### Description
Creates a new bucket. Requires 'insert' permissions on the 'buckets' table.

### Method
`supabase.storage.createBucket(id: String, options: BucketOptions)`

### Parameters
- **id** (String) - The unique identifier for the new bucket.
- **options** (BucketOptions) - Configuration including isPublic, allowedMimeTypes, and fileSizeLimit.
```

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

### Sign up with email and password

Source: https://supabase.com/docs/reference/swift/auth-exchangecodeforsession

Perform a user sign-up using an email address and password.

```swift
1
try await supabase.auth.signUp(
2
  email: "example@email.com",
3
  password: "example-password"
4
)
```

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

### Start auto-refresh session

Source: https://supabase.com/docs/reference/swift/auth-exchangecodeforsession

Initiates the automatic session refresh process for non-browser environments.

```swift
supabase.auth.startAutoRefresh()
```

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

### Initialize Supabase Auth client

Source: https://supabase.com/docs/reference/swift/auth-exchangecodeforsession

Create the Supabase client instance to access the auth namespace.

```swift
1
let supabase = SupabaseClient(supabaseURL: URL(string: "https://xyzcompany.supabase.co")!, supabaseKey: "your-publishable-key")
2
let auth = supabase.auth
```

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

### Manage session auto-refresh

Source: https://supabase.com/docs/reference/swift/auth-getclaims

Methods to start or stop the automatic session refresh process in non-browser environments.

```swift
supabase.auth.startAutoRefresh()
```

```swift
supabase.auth.stopAutoRefresh()
```

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

### Install Supabase via Swift Package Manager

Source: https://supabase.com/docs/reference/swift/auth-exchangecodeforsession

Add the Supabase dependency to your Package.swift file to include the library in your project.

```swift
let package = Package(
    ...
    dependencies: [
        ...
        .package(
            url: "https://github.com/supabase/supabase-swift.git",
            from: "2.0.0"
        ),
    ],
    targets: [
        .target(
            name: "YourTargetName",
            dependencies: [
                .product(
                    name: "Supabase", // Auth, Realtime, Postgrest, Functions, or Storage
                    package: "supabase-swift"
                ),
            ]
        )
    ]
)
```

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

### signUp(email:password:data:redirectTo:captchaToken:)

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

Creates a new user with an email and password. You can optionally provide additional user metadata and a redirect URL.

```APIDOC
## signUp(email:password:data:redirectTo:captchaToken:)

### Description
Creates a new user with an email and password. One of email or phone must be provided.

### Parameters
- **email** (String) - Optional - One of email or phone must be provided.
- **phone** (String) - Optional - One of email or phone must be provided.
- **password** (String) - Required
- **data** (JSONObject) - Optional - A custom data object to store additional user metadata.
- **redirectTo** (URL) - Optional - Only for email signups. The redirect URL embedded in the email link.
- **captchaToken** (String) - Optional

### Request Example
```swift
try await supabase.auth.signUp(
  email: "example@email.com",
  password: "example-password"
)
```
```

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

### Get Authenticator Assurance Level

Source: https://supabase.com/docs/reference/swift/auth-exchangecodeforsession

Retrieves the current AAL, the next required level, and the authentication methods currently in use.

```swift
let aal = try await supabase.auth.mfa.getAuthenticatorAssuranceLevel()
let currentLevel = aal.currentLevel
let nextLevel = aal.nextLevel
let currentAuthenticationMethods = aal.currentAuthenticationMethods
```

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

### Create a bucket

Source: https://supabase.com/docs/reference/swift/undefined

Creates a new storage bucket with specified options.

```APIDOC
## Create a bucket

### Description
Creates a new bucket. Requires `insert` permission on the `buckets` table.

### Method
`createBucket(id: String, options: BucketOptions)`

### Parameters
- **id** (String) - Required - The ID for the new bucket.
- **options** (BucketOptions) - Optional - Configuration for the bucket including `isPublic`, `allowedMimeTypes`, and `fileSizeLimit`.

### Example
```swift
try await supabase.storage.createBucket(
  "avatars",
  options: BucketOptions(
    isPublic: false,
    allowedMimeTypes: ["image/png"],
    fileSizeLimit: 1024
  )
)
```
```

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

### Get query execution plan

Source: https://supabase.com/docs/reference/swift/auth-exchangecodeforsession

Retrieves the Postgres EXPLAIN execution plan for debugging. Requires specific project configuration to enable.

```swift
try await supabase
  .from("instruments")
  .select()
  .explain()
  .execute()
  .value
```

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

### SupabaseClient Initialization

Source: https://supabase.com/docs/reference/swift/auth-getuser

Initializes the Supabase client using the project URL and public API key.

```APIDOC
## SupabaseClient Initialization

### Description
Initializes the Supabase client to serve as the entrypoint for interacting with Supabase services.

### Method
Initializer

### Parameters
- **supabaseURL** (URL) - Required - The project URL found in Project Settings → API Settings.
- **supabaseKey** (String) - Required - The project API key found in Project Settings → API Settings.

### Request Example
let client = SupabaseClient(supabaseURL: URL(string: "https://xyzcompany.supabase.co")!, supabaseKey: "your-publishable-key")
```

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

### Create a bucket

Source: https://supabase.com/docs/reference/swift/removeallchannels

Creates a new storage bucket.

```APIDOC
## Create a bucket

### Description
Creates a new storage bucket with optional configuration. Requires `insert` permissions on the `buckets` table.

### Method
`createBucket(id: String, options: BucketOptions)`

### Parameters
- **id** (String) - Required - The ID of the bucket to create.
- **options** (BucketOptions) - Optional - Configuration options including `isPublic`, `allowedMimeTypes`, and `fileSizeLimit`.
```

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

### Get passkey registration options

Source: https://supabase.com/docs/reference/swift/auth-exchangecodeforsession

Fetches credential creation options required to register a new passkey. These options must be passed to the platform authenticator.

```swift
1
// @_spi(Experimental) import Supabase
2
let options: PasskeyRegistrationOptions = try await supabase.auth.getPasskeyRegistrationOptions()
3
// Hand options.options to the platform authenticator.
```

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

### createBucket(id: String, options: BucketOptions?)

Source: https://supabase.com/docs/reference/swift/auth-exchangecodeforsession

Creates a new storage bucket.

```APIDOC
## createBucket(id: String, options: BucketOptions?)

### Description
Creates a new storage bucket with optional configuration.

### Parameters
- **id** (String) - Required - The unique identifier for the new bucket.
- **options** (BucketOptions) - Optional - Configuration options including isPublic, allowedMimeTypes, and fileSizeLimit.

### Usage
```swift
try await supabase.storage.createBucket("avatars", options: BucketOptions(isPublic: false, allowedMimeTypes: ["image/png"], fileSizeLimit: 1024))
```
```
Tokens:
Raw