Athena
Function_name

RPC compatibility (POST JSON body)

Body is either a plain JSON object of named arguments for `function_name`, or a full `GatewayRpcRequest`-shaped wrapper (`function`, `schema`, `args`, `filters`, etc.).

POST
/rpc/{function_name}

Path Parameters

function_name*string

Header Parameters

X-Athena-Client*string
apikey?string
x-api-key?string

Request Body

application/json

function*string

Function name (or schema.function when schema is public)

function_name?string

Alias of function accepted in JSON

schema?string
Default"public"
args?
select?string

Comma-separated columns for SELECT over RPC result

filters?array<>
count?string

Set to exact to include an exact row count

limit?integer
Formatint64
offset?integer
Formatint64
order?

Response Body

application/json

curl -X POST "https://athena-cluster.com/rpc/string" \  -H "X-Athena-Client: string" \  -H "Content-Type: application/json" \  -d '{    "function": "string"  }'
{
  "data": [
    {}
  ],
  "count": 0
}
Empty
Empty
Empty

RPC compatibility (GET, query-string args) GET

Same execution as `POST /gateway/rpc` with `function` taken from the path. Query keys: `schema`, `select`, `count`, `limit`, `offset`, `order` (`column` or `column.desc`). Other keys are either RPC arguments or filters written as `column=op.value` (e.g. `status=eq.active`). Arrays use `{a,b}` in the value portion.

Delete rows using PostgREST-style filters DELETE

Filters are mandatory. Use the same query syntax as GET and include `Prefer: return=minimal` for HTTP 204 responses.