Supabase Python Client

https://supabase.com/docs/reference/python
Admin
Supabase Python Client is a library for interacting with Postgres databases, managing...
Tokens:147,090
Snippets:1,577
Trust Score:10
Update:1 month ago
Show doc for...
Tokens:
Raw
### Get the execution plan with analyze and verbose

Source: https://supabase.com/llms/python.txt

Use the explain() method with analyze=True and verbose=True to get a detailed execution plan.

```python
response = (
    supabase.table("planets")
    .select("*")
    .explain(analyze=True, verbose=True)
    .execute()
)
```

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

### Install supabase-py via conda

Source: https://supabase.com/llms/python.txt

Use conda to install the supabase-py library from the conda-forge channel.

```sh
conda install -c conda-forge supabase
```

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

### Install supabase-py via pip

Source: https://supabase.com/docs/reference/python/auth-admin-deleteuser

Use pip to install the supabase-py library for Python versions greater than 3.8.

```bash
pip install supabase
```

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

### Order query results

Source: https://supabase.com/docs/reference/python/auth-admin-deleteuser

Example of ordering query results from the 'planets' table in descending order.

```python
1
response = (
2
    supabase.table("planets")
3
    .select("*")
4
    .order("name", desc=True)
5
    .execute()
6
)
```

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

### Sign up with an email and password

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

Use the sign_up method to create a new user with email and password credentials.

```python
response = supabase.auth.sign_up(
    {
        "email": "email@example.com",
        "password": "password",
    }
)
```

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

### range(start, end, foreign_table=None)

Source: https://supabase.com/docs/reference/python/auth-admin-deleteuser

Limits the query result by starting at an offset and ending at an offset.

```APIDOC
## .range(start, end, foreign_table=None)

### Description
Limit the query result by starting at an offset (`start`) and ending at the offset (`end`). The values are 0-based and inclusive.

### Parameters
- **start** (number) - Required - The starting index from which to limit the result.
- **end** (number) - Required - The last index to which to limit the result.
- **foreign_table** (string) - Optional - Set this to limit rows of foreign tables instead of the parent table.

### Example
```python
response = (
    supabase.table("planets")
    .select("name")
    .range(0, 1)
    .execute()
)
```
```

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

### Sign up with an email and password

Source: https://supabase.com/docs/reference/python/auth-admin-deleteuser

Use the sign_up method to register a new user with an email and password.

```python
1
response = supabase.auth.sign_up(
2
    {
3
        "email": "email@example.com",
4
        "password": "password",
5
    }
6
)
```

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

### range(start, end, foreign_table=None)

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

Limits the query result by starting at an offset and ending at an offset.

```APIDOC
## .range(start, end, foreign_table=None)

### Description
Limit the query result by starting at an offset (start) and ending at the offset (end). The values are 0-based and inclusive.

### Parameters
- **start** (number) - Required - The starting index from which to limit the result.
- **end** (number) - Required - The last index to which to limit the result.
- **foreign_table** (string) - Optional - Set this to limit rows of foreign tables instead of the parent table.

### Example
```python
response = (
    supabase.table("planets")
    .select("name")
    .range(0, 1)
    .execute()
)
```
```

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

### create_client(supabase_url, supabase_key, options=None)

Source: https://supabase.com/docs/reference/python/auth-admin-deleteuser

Initializes a new Supabase client, which serves as the entrypoint for interacting with Supabase services.

```APIDOC
## create_client(supabase_url, supabase_key, options=None)

### Description
Initializes a new Supabase client to interact with your project.

### Parameters
- **supabase_url** (string) - Required - The unique Supabase URL.
- **supabase_key** (string) - Required - The unique Supabase Key.
- **options** (ClientOptions) - Optional - Options to change Auth behaviors.

### Example
```python
import os
from supabase import create_client, Client

url: str = os.environ.get("SUPABASE_URL")
key: str = os.environ.get("SUPABASE_KEY")
supabase: Client = create_client(url, key)
```
```

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

### Initialize Supabase Client

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

Initializes the Supabase client using the URL and key from environment variables.

```python
import os
from supabase import create_client, Client

url: str = os.environ.get("SUPABASE_URL")
key: str = os.environ.get("SUPABASE_KEY")
supabase: Client = create_client(url, key)
```

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

### Initialize Supabase Client

Source: https://supabase.com/docs/reference/python/auth-admin-deleteuser

Initializes a new Supabase client using the create_client() method with environment variables for the URL and key.

```python
1
import os
2
from supabase import create_client, Client
3
4
url: str = os.environ.get("SUPABASE_URL")
5
key: str = os.environ.get("SUPABASE_KEY")
6
supabase: Client = create_client(url, key)
```

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

### get(keys)

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

Retrieves vectors from an index by their keys.

```APIDOC
## get(keys)

### Description
Retrieves vectors by their keys. This is an alpha feature.

### Parameters
- **bucket_name** (string) - Required - The name of the vector bucket.
- **index_name** (string) - Required - The name of the index.
- **keys** (list[string]) - Required - List of vector keys to retrieve.
- **return_data** (bool) - Optional - Whether to return vector data. Defaults to true.
- **return_metadata** (bool) - Optional - Whether to return metadata. Defaults to true.

### Usage Example
```python
response = supabase.storage.vectors().from_("vectors-bucket").index("my-index").get("vector-1")
```
```

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

### create_client(supabase_url, supabase_key, options)

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

Initializes a new Supabase client, which serves as the entrypoint for interacting with the Supabase ecosystem.

```APIDOC
## create_client(supabase_url, supabase_key, options)

### Description
Initializes a new Supabase client to interact with your Supabase project.

### Parameters
- **supabase_url** (string) - Required - The unique Supabase URL supplied in your project dashboard.
- **supabase_key** (string) - Required - The unique Supabase Key supplied in your project dashboard.
- **options** (ClientOptions) - Optional - Options to change the Auth behaviors.

### Example
```python
import os
from supabase import create_client, Client

url: str = os.environ.get("SUPABASE_URL")
key: str = os.environ.get("SUPABASE_KEY")
supabase: Client = create_client(url, key)
```
```

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

### sign_up()

Source: https://supabase.com/llms/python.txt

Registers a new user with the provided credentials. Depending on project configuration, this may require email verification.

```APIDOC
## sign_up(credentials)

### Description
Creates a new user account using email or phone number. The method returns a user object and optionally a session depending on email confirmation settings.

### Parameters
- **credentials** (dict) - Required - A dictionary containing authentication details:
  - **email** (str) - Optional - User email address.
  - **phone** (str) - Optional - User phone number.
  - **password** (str) - Required - User password.
  - **options** (dict) - Optional - Additional configuration:
    - **data** (dict) - Optional - Custom user metadata.
    - **channel** (str) - Optional - Communication channel (e.g., 'whatsapp').
    - **email_redirect_to** (str) - Optional - URL to redirect to after email confirmation.

### Usage Example
```python
response = supabase.auth.sign_up({
    "email": "email@example.com",
    "password": "password",
    "options": {"data": {"first_name": "John"}}
})
```
```

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

### get()

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

Retrieves vectors by their keys from a specific index.

```APIDOC
## get(keys)

### Description
Retrieves vectors by their keys from a specified index.

### Parameters
- **bucket_name** (string) - Required - The name of the vector bucket.
- **index_name** (string) - Required - The name of the index.
- **keys** (list[string]) - Required - List of vector keys to retrieve.
- **return_data** (bool) - Optional - Whether to return vector data. Defaults to true.
- **return_metadata** (bool) - Optional - Whether to return metadata. Defaults to true.

### Example
```python
response = supabase.storage.vectors().from_("vectors-bucket").index("my-index").get("vector-1")
```
```

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

### Initialize Supabase Client with Timeout Options

Source: https://supabase.com/llms/python.txt

Initializes the client with custom timeout settings for Postgrest and storage, and a specific schema.

```python
import os
from supabase import create_client, Client
from supabase.client import ClientOptions

url: str = os.environ.get("SUPABASE_URL")
key: str = os.environ.get("SUPABASE_KEY")
supabase: Client = create_client(
    url,
    key,
    options=ClientOptions(
        postgrest_client_timeout=10,
        storage_client_timeout=10,
        schema="public",
    )
)
```

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

### get()

Source: https://supabase.com/docs/reference/python/auth-admin-oauth-updateclient

Retrieves vectors by their keys from a specific index.

```APIDOC
## get()

### Description
Retrieves vectors by their keys.

### Parameters
- **bucket_name** (string) - Required - The name of the vector bucket.
- **index_name** (string) - Required - The name of the index.
- **keys** (list[string]) - Required - List of vector keys to retrieve.
- **return_data** (bool) - Optional - Whether to return vector data. Defaults to true.
- **return_metadata** (bool) - Optional - Whether to return metadata. Defaults to true.

### Example
```python
response = supabase.storage.vectors().from_("vectors-bucket").index("my-index").get("vector-1")
```
```

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

### create_client()

Source: https://supabase.com/docs/reference/python/auth-admin-generatelink

Initializes a new Supabase client to interact with your project.

```APIDOC
## create_client(supabase_url, supabase_key, options)

### Description
Initializes a new Supabase client, which serves as the entrypoint for interacting with Supabase functionality.

### Parameters
- **supabase_url** (string) - Required - The unique Supabase URL.
- **supabase_key** (string) - Required - The unique Supabase Key.
- **options** (ClientOptions) - Optional - Options to change Auth behaviors.

### Example
```python
import os
from supabase import create_client, Client

url: str = os.environ.get("SUPABASE_URL")
key: str = os.environ.get("SUPABASE_KEY")
supabase: Client = create_client(url, key)
```
```

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

### or_() with and()

Source: https://supabase.com/llms/python.txt

Example of combining or_() with and() logic in a query.

```python
response = (
    supabase.table("planets")
    .select("name")
    .or_("id.gt.3,and(id.eq.1,name.eq.Mercury)")
    .execute()
)
```

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

### create_client(supabase_url, supabase_key, options)

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

Initializes a new Supabase client to interact with the Supabase ecosystem.

```APIDOC
## create_client(supabase_url, supabase_key, options)

### Description
Initializes a new Supabase client, which serves as the entrypoint for interacting with Supabase functionality.

### Parameters
- **supabase_url** (string) - Required - The unique Supabase URL from your project dashboard.
- **supabase_key** (string) - Required - The unique Supabase Key from your project dashboard.
- **options** (ClientOptions) - Optional - Options to change Auth behaviors.

### Example
```python
import os
from supabase import create_client, Client

url: str = os.environ.get("SUPABASE_URL")
key: str = os.environ.get("SUPABASE_KEY")
supabase: Client = create_client(url, key)
```
```

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

### range()

Source: https://supabase.com/llms/python.txt

Limits the query result by starting at an offset and ending at an offset.

```APIDOC
## range(start, end, foreign_table=None)

### Description
Limits the query result by starting at an offset (`start`) and ending at the offset (`end`). The values are 0-based and inclusive.

### Parameters
- **start** (int) - Required - The starting index.
- **end** (int) - Required - The ending index.
- **foreign_table** (str) - Optional - The name of the foreign table to apply the range to.
```

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

### create_client(supabase_url, supabase_key, options)

Source: https://supabase.com/docs/reference/python/auth-admin-oauth-updateclient

Initializes a new Supabase client, which serves as the primary entry point for interacting with Supabase services.

```APIDOC
## create_client(supabase_url, supabase_key, options)

### Description
Initializes a new Supabase client instance.

### Parameters
- **supabase_url** (string) - Required - The unique Supabase URL.
- **supabase_key** (string) - Required - The unique Supabase Key.
- **options** (ClientOptions) - Optional - Configuration for Auth behaviors.

### Example
```python
import os
from supabase import create_client, Client

url: str = os.environ.get("SUPABASE_URL")
key: str = os.environ.get("SUPABASE_KEY")
supabase: Client = create_client(url, key)
```
```

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

### Use or_ with select

Source: https://supabase.com/docs/reference/python/eq

Example of applying the or_ filter to a select query.

```python
response = (
    supabase.table("planets")
    .select("name")
    .or_("id.eq.2,name.eq.Mars")
    .execute()
)
```

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

### range() with select()

Source: https://supabase.com/llms/python.txt

Limits the query result by starting at an offset and ending at an offset, inclusive.

```python
response = (
    supabase.table("planets")
    .select("name")
    .range(0, 1)
    .execute()
)
```

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

### supabase.auth.sign_up()

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

Signs up a new user with email and password credentials.

```APIDOC
## supabase.auth.sign_up(credentials)

### Description
Creates a new user account using email and password credentials. Depending on project settings, this may require email confirmation.

### Parameters
- **credentials** (SignUpWithPasswordCredentials) - Required - The user credentials including email and password.

### Request Example
```python
response = supabase.auth.sign_up(
    {
        "email": "email@example.com",
        "password": "password",
    }
)
```
```

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

### range(start, end, foreign_table=None)

Source: https://supabase.com/docs/reference/python/auth-admin-oauth-updateclient

Limits the query result by a 0-based inclusive range.

```APIDOC
## .range(start, end, foreign_table=None)

### Description
Limits the query result by starting at an offset (start) and ending at the offset (end). Both values are 0-based and inclusive.

### Parameters
- **start** (number) - Required - The starting index.
- **end** (number) - Required - The last index.
- **foreign_table** (string) - Optional - Set this to limit rows of foreign tables instead of the parent table.
```

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

### Get vector index

Source: https://supabase.com/docs/reference/python/auth-admin-deleteuser

Retrieves the details of a specific vector index. This is an alpha feature.

```python
1
response = supabase.storage.vectors().from_("vectors-bucket").get_index("my-index")
```

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

### supabase.auth.sign_up()

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

Creates a new user with the provided credentials. Depending on project settings, this may require email confirmation.

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

### Description
Creates a new user account using email or phone credentials. By default, users may need to verify their email address before signing in.

### Parameters
- **credentials** (SignUpWithPasswordCredentials) - Required - The user credentials including email or phone and password.

### Request Example
```python
response = supabase.auth.sign_up(
    {
        "email": "email@example.com",
        "password": "password",
    }
)
```
```

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

### Create a bucket

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

Creates a new Storage bucket with specified configuration options. Requires insert permissions on the buckets table.

```python
response = (
    supabase.storage
    .create_bucket(
        "avatars",
        options={
            "public": False,
            "allowed_mime_types": ["image/png"],
            "file_size_limit": 1024,
        }
    )
)
```

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

### Get Authenticator Assurance Level

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

Retrieves the current AAL details for the active session.

```python
1
response = supabase.auth.mfa.get_authenticator_assurance_level()
```

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

### create_client()

Source: https://supabase.com/docs/reference/python/admin-api

Initializes a new Supabase client to interact with the Supabase ecosystem.

```APIDOC
## create_client(supabase_url, supabase_key, options)

### Description
Initializes a new Supabase client, which serves as the entrypoint for interacting with Supabase functionality.

### Parameters
- **supabase_url** (string) - Required - The unique Supabase URL supplied in your project dashboard.
- **supabase_key** (string) - Required - The unique Supabase Key supplied in your project dashboard.
- **options** (ClientOptions) - Optional - Options to change Auth behaviors.

### Example
```python
import os
from supabase import create_client, Client

url: str = os.environ.get("SUPABASE_URL")
key: str = os.environ.get("SUPABASE_KEY")
supabase: Client = create_client(url, key)
```
```

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

### Filter planets table

Source: https://supabase.com/docs/reference/python/admin-api

Example of filtering the planets table using the 'in' operator.

```python
response = (
    supabase.table("planets")
    .select("*")
    .filter("name", "in", '("Mars","Tatooine")')
    .execute()
)
```

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

### Negate filters with select

Source: https://supabase.com/docs/reference/python/eq

Example of using the not_ operator in conjunction with a select query.

```python
response = (
    supabase.table("planets")
    .select("*")
    .not_.is_("name", "null")
    .execute()
)
```

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

### list(path, options)

Source: https://supabase.com/docs/reference/python/insert

Lists all the files within a bucket.

```APIDOC
## list(path, options)

### Description
Lists all the files within a bucket. Requires 'select' permission on the objects table.

### Parameters
- **path** (string) - Optional - The folder path.
- **options** (SearchOptions) - Optional - Search and pagination options.

### Example
```python
response = (
    supabase.storage
    .from_("avatars")
    .list(
        "folder",
        {
            "limit": 100,
            "offset": 0,
            "sortBy": {"column": "name", "order": "desc"},
        }
    )
)
```
```

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

### Get Public URL with transformations

Source: https://supabase.com/llms/python.txt

Retrieves the public URL for an asset with specified image transformations.

```python
response = (
    supabase.storage
    .from_("avatars")
    .get_public_url(
        "folder/avatar1.jpg",
        {"transform": {"width": 100, "height": 100}}
    )
)
```

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

### supabase.auth.sign_up()

Source: https://supabase.com/docs/reference/python/auth-admin-deleteuser

Registers a new user using email and password credentials.

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

### Description
Signs up a new user with an email and password. Depending on project settings, this may require email confirmation.

### Parameters
- **credentials** (SignUpWithPasswordCredentials) - Required - The user credentials including email and password.

### Request Example
```python
response = supabase.auth.sign_up(
    {
        "email": "email@example.com",
        "password": "password",
    }
)
```
```

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

### Exclude rows with select() and not_()

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

Example of using the not_() filter in conjunction with a select() query.

```python
1
response = (
2
    supabase.table("planets")
3
    .select("*")
4
    .not_.is_("name", "null")
5
    .execute()
6
)
```

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

### create_bucket()

Source: https://supabase.com/llms/python.txt

Creates a new Storage bucket.

```APIDOC
## create_bucket(id, options)

### Description
Creates a new Storage bucket.

### Parameters
- **id** (string) - Required - The unique identifier for the new bucket.
- **options** (dict) - Optional - Configuration options including public status, allowed mime types, and file size limit.

### Usage
```python
response = supabase.storage.create_bucket(
    "avatars",
    options={
        "public": False,
        "allowed_mime_types": ["image/png"],
        "file_size_limit": 1024,
    }
)
```
```

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

### create_bucket(id, options)

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

Creates a new Storage bucket.

```APIDOC
## create_bucket(id, options)

### Description
Creates a new Storage bucket.

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

### Example
```python
response = (
    supabase.storage
    .create_bucket(
        "avatars",
        options={
            "public": False,
            "allowed_mime_types": ["image/png"],
            "file_size_limit": 1024,
        }
    )
)
```
```

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

### create_bucket(id, options)

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

Creates a new Storage bucket.

```APIDOC
## create_bucket(id, options)

### Description
Creates a new Storage bucket.

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

### Example
```python
response = supabase.storage.create_bucket(
    "avatars",
    options={
        "public": False,
        "allowed_mime_types": ["image/png"],
        "file_size_limit": 1024,
    }
)
```
```

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

### Filter on a foreign table

Source: https://supabase.com/docs/reference/python/auth-admin-deleteuser

Example of filtering rows from the 'planets' table using the filter() method.

```python
1
response = (
2
    supabase.table("planets")
3
    .select("*")
4
    .filter("name", "in", '("Mars","Tatooine")')
5
    .execute()
6
)
```

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

### Get Public URL with download trigger

Source: https://supabase.com/llms/python.txt

Retrieves the public URL for an asset configured to trigger a download.

```python
response = (
    supabase.storage
    .from_("avatars")
    .get_public_url(
        "folder/avatar1.jpg",
        {"download": True}
    )
)
```

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

### create_bucket(id, options)

Source: https://supabase.com/docs/reference/python/auth-admin-deleteuser

Creates a new Storage bucket.

```APIDOC
## create_bucket(id, options)

### Description
Creates a new Storage bucket.

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

### Example
```python
response = (
    supabase.storage
    .create_bucket(
        "avatars",
        options={
            "public": False,
            "allowed_mime_types": ["image/png"],
            "file_size_limit": 1024,
        }
    )
)
```

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

### Call read-only Postgres function

Source: https://supabase.com/llms/python.txt

Executes a read-only Postgres function by setting the get parameter to True.

```python
response = (
    supabase.rpc("hello_world", get=True)
    .execute()
)
```

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

### supabase.auth.sign_up

Source: https://supabase.com/docs/reference/python/auth-admin-oauth-updateclient

Signs up a new user with email and password. By default, users may need to verify their email address depending on project settings.

```APIDOC
## supabase.auth.sign_up(credentials)

### Description
Creates a new user account using the provided credentials. Depending on project configuration, this may require email confirmation.

### Parameters
- **credentials** (SignUpWithPasswordCredentials) - Required - The user credentials including email/phone and password.

### Request Example
```python
response = supabase.auth.sign_up(
    {
        "email": "email@example.com",
        "password": "password",
    }
)
```
```

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

### Sign up with a phone number and password (whatsapp)

Source: https://supabase.com/llms/python.txt

Registers a new user using a phone number and password via WhatsApp.

```python
response = supabase.auth.sign_up(
    {
        "phone": "123456789",
        "password": "password",
        "options": {"channel": "whatsapp"},
    }
)
```

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

### or_() on referenced tables

Source: https://supabase.com/llms/python.txt

Example of using the or_() filter on a referenced table by specifying the reference_table parameter.

```python
response = (
    supabase.table("orchestral_sections")
    .select("name, instruments!inner(name)")
    .or_("section_id.eq.1,name.eq.guqin", reference_table="instruments")
    .execute()
)
```

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

### Match at least one filter with select()

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

Example of using the or_() filter within a select() query.

```python
1
response = (
2
    supabase.table("planets")
3
    .select("name")
4
    .or_("id.eq.2,name.eq.Mars")
5
    .execute()
6
)
```

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

### acreate_client

Source: https://supabase.com/docs/reference/python/auth-admin-oauth-updateclient

Initializes a new asynchronous Supabase client.

```APIDOC
## acreate_client(url, key)

### Description
Initializes a new Supabase client using the asynchronous client. Required for Realtime operations.

### Parameters
- **url** (string) - Required - The Supabase project URL.
- **key** (string) - Required - The Supabase API key.

### Example
```python
async def create_supabase():
  supabase: AsyncClient = await acreate_client(url, key)
  return supabase
```
```

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

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

Source: https://supabase.com/llms/python.txt

Registers a new user using a phone number and password via SMS.

```python
response = supabase.auth.sign_up(
    {
        "phone": "123456789",
        "password": "password",
    }
)
```

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

### Get the execution plan

Source: https://supabase.com/docs/reference/python/auth-admin-deleteuser

Retrieves the Postgres EXPLAIN execution plan for a query. This method is useful for debugging slow queries.

```python
response = (
    supabase.table("planets")
    .select("*")
    .explain()
    .execute()
)
```

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

### .explain()

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

Retrieves the Postgres EXPLAIN execution plan for a query to assist with performance debugging.

```APIDOC
## .explain()

### Description
Returns the Postgres EXPLAIN execution plan of a query. This can be used on any query, including rpc() or write operations.

### Parameters
- **wal** (boolean) - Optional - If true, include information on WAL record generation.
- **verbose** (boolean) - Optional - If true, the query identifier will be returned and data will include the output columns of the query.
- **settings** (boolean) - Optional - If true, include information on configuration parameters that affect query planning.
- **format** ("text" | "json") - Optional - The format of the output, defaults to "text".
- **buffers** (boolean) - Optional - If true, include information on buffer usage.
- **analyze** (boolean) - Optional - If true, the query will be executed and the actual run time will be returned.

### Usage
```python
response = (
    supabase.table("planets")
    .select("*")
    .explain()
    .execute()
)
```
```

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

### Get OAuth client

Source: https://supabase.com/docs/reference/python/auth-admin-deleteuser

Retrieves details of an OAuth client by its ID. Requires the secret key and that the OAuth 2.1 server is enabled.

```python
1
response = supabase.auth.admin.oauth.get_client("client-id")
```

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

### Create a bucket

Source: https://supabase.com/docs/reference/python/auth-admin-deleteuser

Creates a new Storage bucket with specified options such as public access, allowed MIME types, and file size limits. Requires 'insert' permissions on the 'buckets' table.

```python
1
response = (
2
    supabase.storage
3
    .create_bucket(
4
        "avatars",
5
        options={
6
            "public": False,
7
            "allowed_mime_types": ["image/png"],
8
            "file_size_limit": 1024,
9
        }
10
    )
11
)
```

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

### Get Authenticator Assurance Level

Source: https://supabase.com/docs/reference/python/auth-admin-deleteuser

Retrieves the current AAL details for the active session, indicating whether the user is at aal1 or aal2.

```python
response = supabase.auth.mfa.get_authenticator_assurance_level()
```

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

### Get signed-in user

Source: https://supabase.com/docs/reference/python/auth-admin-deleteuser

Fetches the user object from the database, validating the JWT on the server. If no JWT is provided, it uses the token from the current session.

```python
response = supabase.auth.get_user()
```

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

### acreate_client

Source: https://supabase.com/docs/reference/python/auth-admin-deleteuser

Initializes a new asynchronous Supabase client for use with Realtime.

```APIDOC
## acreate_client(url, key)

### Description
Initializes a new asynchronous Supabase client. Realtime in Python only works with the asynchronous client.

### Parameters
- **url** (string) - Required - The Supabase project URL.
- **key** (string) - Required - The Supabase API key.

### Request Example
```python
async def create_supabase():
  supabase: AsyncClient = await acreate_client(url, key)
  return supabase
```
```

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

### Sign up with a redirect URL

Source: https://supabase.com/llms/python.txt

Registers a new user and specifies a custom redirect URL for email confirmation.

```python
response = supabase.auth.sign_up(
    {
        "email": "hello1@example.com",
        "password": "password",
        "options": {
            "email_redirect_to": "https://example.com/welcome",
        },
    }
)
```

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

### Get the signed-in user with a custom access token jwt

Source: https://supabase.com/llms/python.txt

Fetches the user object from the database using a provided custom access token JWT.

```python
response = supabase.auth.get_user(jwt)
```

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

### .explain()

Source: https://supabase.com/docs/reference/python/auth-admin-oauth-updateclient

Retrieves the Postgres EXPLAIN execution plan for a query, useful for debugging slow queries.

```APIDOC
## .explain()

### Description
Returns the Postgres EXPLAIN execution plan of a query. This method works on any query, including rpc() or write operations.

### Parameters
- **wal** (boolean) - Optional - If true, include information on WAL record generation.
- **verbose** (boolean) - Optional - If true, the query identifier will be returned and data will include the output columns of the query.
- **settings** (boolean) - Optional - If true, include information on configuration parameters that affect query planning.
- **format** ("text" | "json") - Optional - The format of the output, defaults to "text".
- **buffers** (boolean) - Optional - If true, include information on buffer usage.
- **analyze** (boolean) - Optional - If true, the query will be executed and the actual run time will be returned.

### Usage
```python
response = (
    supabase.table("planets")
    .select("*")
    .explain()
    .execute()
)
```
```

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

### Get OAuth client

Source: https://supabase.com/docs/reference/python/auth-admin-oauth-updateclient

Retrieves details of an OAuth client by its ID. This is an alpha feature requiring the secret key and OAuth 2.1 server enablement.

```python
response = supabase.auth.admin.oauth.get_client("client-id")
```

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

### .explain()

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

Retrieves the Postgres EXPLAIN execution plan for a query, useful for debugging slow queries.

```APIDOC
## .explain()

### Description
Get the Postgres EXPLAIN execution plan of a query. This works on any query, including rpc() or write operations.

### Parameters
- **wal** (boolean) - Optional - If true, include information on WAL record generation.
- **verbose** (boolean) - Optional - If true, the query identifier will be returned and data will include the output columns of the query.
- **settings** (boolean) - Optional - If true, include information on configuration parameters that affect query planning.
- **format** ("text" | "json") - Optional - The format of the output, defaults to "text".
- **buffers** (boolean) - Optional - If true, include information on buffer usage.
- **analyze** (boolean) - Optional - If true, the query will be executed and the actual run time will be returned.

### Usage
```python
response = (
    supabase.table("planets")
    .select("*")
    .explain()
    .execute()
)
```
```

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

### Get user claims from verified JWT

Source: https://supabase.com/docs/reference/python/auth-admin-deleteuser

Extracts JWT claims by verifying the token against the server's JWKS endpoint. This is faster than get_user as it avoids redundant Auth server requests.

```python
response = supabase.auth.get_claims()
```

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

### Create a Postgres function

Source: https://supabase.com/docs/reference/python/auth-admin-deleteuser

Defines a simple SQL function named 'hello_world' that returns the text 'Hello world'.

```sql
create or replace function hello_world() returns text as $$
  select 'Hello world';
$$ language sql;
```

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

### supabase.storage.create_bucket(id, options)

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

Creates a new Storage bucket.

```APIDOC
## supabase.storage.create_bucket(id, options)

### Description
Creates a new Storage bucket.

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

### Example
```python
response = supabase.storage.create_bucket(
    "avatars",
    options={
        "public": False,
        "allowed_mime_types": ["image/png"],
        "file_size_limit": 1024,
    }
)
```
```

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

### Create server-side auth admin client

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

Initializes a Supabase client with a secret key for administrative tasks. This must be performed on a trusted server to avoid exposing the secret key.

```python
1
from supabase import create_client
2
from supabase.lib.client_options import ClientOptions
3
4
supabase = create_client(
5
    supabase_url,
6
    secret_key,
7
    options=ClientOptions(
8
        auto_refresh_token=False,
9
        persist_session=False,
10
    )
11
)
12
13
# Access auth admin api
14
admin_auth_client = supabase.auth.admin
```

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

### admin.oauth.create_client()

Source: https://supabase.com/llms/python.txt

Creates a new OAuth client.

```APIDOC
## admin.oauth.create_client()

### Description
Creates a new OAuth client. Requires a secret key and must be called server-side.

### Parameters
- **client_data** (dict) - Required - Dictionary containing client configuration such as 'name' and 'redirect_uris'.

### Example
```python
response = supabase.auth.admin.oauth.create_client({"name": "My OAuth Client", "redirect_uris": ["https://example.com/callback"]})
```
```

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

### Create server-side auth client

Source: https://supabase.com/docs/reference/python/auth-admin-deleteuser

Initializes a Supabase client with a secret key for administrative tasks. This must be performed on a trusted server to keep the secret key secure.

```python
from supabase import create_client
from supabase.lib.client_options import ClientOptions

supabase = create_client(
    supabase_url,
    secret_key,
    options=ClientOptions(
        auto_refresh_token=False,
        persist_session=False,
    )
)

# Access auth admin api
admin_auth_client = supabase.auth.admin
```

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

### Initialize asynchronous Supabase client

Source: https://supabase.com/docs/reference/python/auth-admin-deleteuser

Initializes an asynchronous client using acreate_client, which is required for Realtime functionality in Python.

```python
import os
import asyncio
from supabase import acreate_client, AsyncClient

url: str = os.environ.get("SUPABASE_URL")
key: str = os.environ.get("SUPABASE_KEY")

async def create_supabase():
  supabase: AsyncClient = await acreate_client(url, key)
  return supabase
```

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

### explain()

Source: https://supabase.com/docs/reference/python/auth-admin-deleteuser

Retrieves the Postgres EXPLAIN execution plan for a query, useful for debugging slow queries.

```APIDOC
## .explain()

### Description
Retrieves the Postgres EXPLAIN execution plan for a query. This method works on any query, including rpc() or write operations.

### Parameters
- **wal** (boolean) - Optional - If true, include information on WAL record generation.
- **verbose** (boolean) - Optional - If true, the query identifier will be returned and data will include the output columns of the query.
- **settings** (boolean) - Optional - If true, include information on configuration parameters that affect query planning.
- **format** ("text" | "json") - Optional - The format of the output, defaults to "text".
- **buffers** (boolean) - Optional - If true, include information on buffer usage.
- **analyze** (boolean) - Optional - If true, the query will be executed and the actual run time will be returned.

### Usage
```python
response = (
    supabase.table("planets")
    .select("*")
    .explain()
    .execute()
)
```
```

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

### Sign up with additional user metadata

Source: https://supabase.com/llms/python.txt

Registers a new user while including custom metadata in the user object.

```python
response = supabase.auth.sign_up(
    {
        "email": "email@example.com",
        "password": "password",
        "options": {"data": {"first_name": "John", "age": 27}},
    }
)
```

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

### acreate_client

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

Initializes a new asynchronous Supabase client required for Realtime features.

```APIDOC
## acreate_client(url, key)

### Description
Initializes a new asynchronous Supabase client. Realtime in Python only works with the asynchronous client.

### Parameters
- **url** (string) - Required - The Supabase project URL.
- **key** (string) - Required - The Supabase API key.

### Example
```python
import os
import asyncio
from supabase import acreate_client, AsyncClient

url: str = os.environ.get("SUPABASE_URL")
key: str = os.environ.get("SUPABASE_KEY")

async def create_supabase():
  supabase: AsyncClient = await acreate_client(url, key)
  return supabase
```
```

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

### supabase.storage.from_(bucket_id).list(path, options)

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

Lists all the files within a bucket.

```APIDOC
## supabase.storage.from_(bucket_id).list(path, options)

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

### Parameters
- **path** (string) - Optional - The folder path.
- **options** (SearchOptions) - Optional - Search and pagination options.

### Example
```python
response = (
    supabase.storage
    .from_("avatars")
    .list(
        "folder",
        {
            "limit": 100,
            "offset": 0,
            "sortBy": {"column": "name", "order": "desc"},
        }
    )
)
```
```

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

### acreate_client

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

Initializes a new asynchronous Supabase client for use with Realtime features.

```APIDOC
## acreate_client(url, key)

### Description
Initializes a new Supabase client using the asynchronous client. Required for Realtime functionality.

### Parameters
- **url** (string) - Required - The Supabase project URL.
- **key** (string) - Required - The Supabase API key.

### Example
```python
import os
import asyncio
from supabase import acreate_client, AsyncClient

url: str = os.environ.get("SUPABASE_URL")
key: str = os.environ.get("SUPABASE_KEY")

async def create_supabase():
  supabase: AsyncClient = await acreate_client(url, key)
  return supabase
```
```

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

### from_.list()

Source: https://supabase.com/llms/python.txt

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

```APIDOC
## from_.list(path: str, options: dict = None)

### Description
Lists all files within a bucket, with optional support for pagination, sorting, and searching.

### Parameters
- **path** (str) - The folder path to list files from.
- **options** (dict) - Optional parameters including limit, offset, sortBy, and search.

### Example
```python
response = supabase.storage.from_("avatars").list("folder", {"limit": 100})
```
```

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

### Sign in with email and password

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

Authenticates an existing user using their email and password credentials.

```python
response = supabase.auth.sign_in_with_password(
    {
        "email": "email@example.com",
        "password": "example-password",
    }
)
```

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

### Sign in with email and password

Source: https://supabase.com/docs/reference/python/auth-admin-deleteuser

Authenticates an existing user using their email and password credentials.

```python
1
response = supabase.auth.sign_in_with_password(
2
    {
3
        "email": "email@example.com",
4
        "password": "example-password",
5
    }
6
)
```

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

### supabase.storage.analytics().create()

Source: https://supabase.com/docs/reference/python/auth-admin-deleteuser

Creates a new Analytics bucket.

```APIDOC
## supabase.storage.analytics().create(bucket_name)

### Description
Creates a new Analytics bucket. This is an alpha feature and may change in the future.

### Parameters
- **bucket_name** (string) - Required - The name of the analytics bucket to create.

### Example
```python
response = supabase.storage.analytics().create("analytics-bucket")
```
```

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

### supabase.storage.from_().list()

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

Lists all the files within a bucket.

```APIDOC
## list(path, options)

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

### Parameters
- **path** (string) - Optional - The folder path.
- **options** (SearchOptions) - Optional - Search and pagination options.

### Example
```python
response = (
    supabase.storage
    .from_("avatars")
    .list(
        "folder",
        {
            "limit": 100,
            "offset": 0,
            "sortBy": {"column": "name", "order": "desc"},
        }
    )
)
```
```

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

### supabase.storage.from_().list()

Source: https://supabase.com/docs/reference/python/auth-admin-deleteuser

Lists all the files within a bucket.

```APIDOC
## supabase.storage.from_().list()

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

### Parameters
- **path** (string) - Optional - The folder path.
- **options** (SearchOptions) - Optional - Search and pagination options.

### Example
```python
response = (
    supabase.storage
    .from_("avatars")
    .list(
        "folder",
        {
            "limit": 100,
            "offset": 0,
            "sortBy": {"column": "name", "order": "desc"},
        }
    )
)
```
```

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

### Download file with transformations

Source: https://supabase.com/llms/python.txt

Downloads a file from a private bucket with specified image transformations like width, height, and quality.

```python
with open("./myfolder/avatar1.png", "wb+") as f:
    response = (
        supabase.storage
        .from_("avatars")
        .download(
            "folder/avatar1.png",
            {"transform": {"width": 100, "height": 100, "quality": 80}},
        )
    )
    f.write(response)
```

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

### Create a user with custom metadata

Source: https://supabase.com/docs/reference/python/auth-admin-deleteuser

Creates a new user with specified email, password, and custom metadata. The email and phone confirmation status can be set via parameters.

```python
response = supabase.auth.admin.create_user(
    {
        "email": "user@email.com",
        "password": "password",
        "user_metadata": {"name": "Yoda"},
    }
)
```

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

### sign_in_with_password()

Source: https://supabase.com/llms/python.txt

Signs in an existing user using either email and password or phone and password.

```APIDOC
## sign_in_with_password(credentials)

### Description
Authenticates a user with email/password or phone/password credentials.

### Parameters
- **credentials** (dict) - Required - A dictionary containing 'password' and either 'email' or 'phone'.
```

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

### from_.download()

Source: https://supabase.com/llms/python.txt

Downloads a file from a private bucket. Requires select permissions on the objects table.

```APIDOC
## from_.download(path: str, options: dict = None)

### Description
Downloads a file from a private bucket. For public buckets, use get_public_url instead.

### Parameters
- **path** (str) - The path of the file to download.
- **options** (dict) - Optional transformation settings (e.g., width, height, quality).

### Example
```python
response = supabase.storage.from_("avatars").download("folder/avatar1.png")
```
```
Tokens:
Raw