Python: Call a Postgres function

You can call Postgres functions as Remote Procedure Calls, logic in your database that you can execute from anywhere. Functions are useful when the logic rarely changes—like for password resets and updates.

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

Parameters

• fn

  (Required)

  The stored procedure call to be executed.

• params

  (Optional)

  Parameters passed into the stored procedure call.

• get

  (Optional)

  When set to `true`, `data` will not be returned. Useful if you only need the count.

• head

  (Optional)

  When set to `true`, the function will be called with read-only access mode.

• count

  (Optional)

  Count algorithm to use to count rows returned by the function. Only applicable for [set-returning functions](https://www.postgresql.org/docs/current/functions-srf.html). `"exact"`: Exact but slow count algorithm. Performs a `COUNT(*)` under the hood. `"planned"`: Approximated but fast count algorithm. Uses the Postgres statistics under the hood. `"estimated"`: Uses exact count for low numbers and planned count for high numbers.

Examples

Call a Postgres function without arguments

response = supabase.rpc("hello_world").execute()

Call a Postgres function with arguments

response = supabase.rpc("echo", \{ "say": "👋" \}).execute()

Bulk processing

response = supabase.rpc("add_one_each", \{"arr": [1, 2, 3]\}).execute()

Call a Postgres function with filters

response = supabase.rpc("list_stored_countries").eq("id", 1).single().execute()

Call a read-only Postgres function

response = supabase.rpc('hello_world', get=True).execute()