Query

Execute a SQL query against a Supabase database using stored procedures.

This task executes SQL queries against a Supabase database using the RPC (Remote Procedure Call) functionality. You need to create a stored procedure in your Supabase database first, then call it using this task.

yaml
type: "io.kestra.plugin.supabase.Query"

Examples

Execute a simple query using a stored procedure.

yaml
id: supabase_query
namespace: company.team

tasks:
  - id: query_users
    type: io.kestra.plugin.supabase.Query
    url: https://your-project.supabase.com
    apiKey: "{{ secret('SUPABASE_API_KEY') }}"
    functionName: get_users
    parameters:
      limit: 10
      offset: 0

Execute a parameterized query.

yaml
id: supabase_parameterized_query
namespace: company.team

tasks:
  - id: query_user_by_id
    type: io.kestra.plugin.supabase.Query
    url: https://your-project.supabase.com
    apiKey: "{{ secret('SUPABASE_API_KEY') }}"
    functionName: get_user_by_id
    parameters:
      user_id: 123

Properties

apiKey *string

The Supabase API key

The API key for authenticating with Supabase -- use the anon key for client-side operations or the service_role key for server-side operations with elevated privileges.

functionName *string

The name of the stored procedure to execute

The name of the stored procedure (function) in your Supabase database to execute

url *string

The Supabase project URL

The URL of your Supabase project (e.g., https://your-project.supabase.com)

options HttpConfiguration

Default

{
  "followRedirects": "true",
  "allowFailed": "false",
  "defaultCharset": "UTF-8"
}

parameters object

Parameters to pass to the stored procedure

A map of parameters to pass to the stored procedure

schema string

Default public

The schema to use

The database schema to use for operations -- defaults to 'public'.

Outputs

code integer

The HTTP status code of the response

headers object

SubType array

The headers of the response

rawResponse string

The raw response body

rows array

SubType object

The result rows from the query

size integer

The number of rows returned

uri string

Format uri

The URI of the executed request

Definitions

io.kestra.core.http.client.configurations.TimeoutConfiguration

connectTimeout string

Format duration

The time allowed to establish a connection to the server before failing.

readIdleTimeout string

Default PT5M

Format duration

The time allowed for a read connection to remain idle before closing it.

io.kestra.core.http.client.configurations.BasicAuthConfiguration

type *object

password string

The password for HTTP basic authentication.

username string

The username for HTTP basic authentication.

java.nio.charset.Charset

io.kestra.core.http.client.configurations.HttpConfiguration

allowFailed booleanstring

Default false

If true, allow a failed response code (response code >= 400)

allowedResponseCodes array

SubType integer

List of response code allowed for this request

auth BasicAuthConfiguration BearerAuthConfiguration

The authentification to use.

defaultCharset Charsetstring

Default UTF-8

The default charset for the request.

followRedirects booleanstring

Default true

Whether redirects should be followed automatically.

logs array

SubType string

Possible Values

REQUEST_HEADERSREQUEST_BODYRESPONSE_HEADERSRESPONSE_BODY

The enabled log.

proxy ProxyConfiguration

The proxy configuration.

ssl SslOptions

The SSL request options

timeout TimeoutConfiguration

The timeout configuration.

io.kestra.core.http.client.configurations.ProxyConfiguration

address string

The address of the proxy server.

password string

The password for proxy authentication.

port integerstring

The port of the proxy server.

type string

Default DIRECT

Possible Values

DIRECTHTTPSOCKS

The type of proxy to use.

username string

The username for proxy authentication.

io.kestra.core.http.client.configurations.SslOptions

insecureTrustAllCertificates booleanstring

Whether to disable checking of the remote SSL certificate.

Only applies if no trust store is configured. Note: This makes the SSL connection insecure and should only be used for testing. If you are using a self-signed certificate, set up a trust store instead.

io.kestra.core.http.client.configurations.BearerAuthConfiguration

type *object

token string

The token for bearer token authentication.

​Query

Query