RPC Call

POST 
/v1/rdb/rest/rpc/:function_name

Call stored procedures or custom functions in PostgreSQL (powered by PostgREST RPC). Supports passing parameters and returns function execution results.

Request

Path Parameters

function_name stringrequired

Stored procedure or function name

Query Parameters

select string

Return fields, supports * or specified field list, used to filter columns returned by the function

limit integer

Limit return count (effective when function returns a set)

offset integer

Offset, used for pagination (effective when function returns a set)

order string

Sort field, format is field.asc or field.desc (effective when function returns a set)

Header Parameters

Prefer string
Preference settings:
• params=single-object passes the request body as a single JSON parameter to the function
• count=exact returns exact count

application/json

Body

object

Responses

200

Call successful

application/json

Schema

Schema

oneOf

MOD1

Array [

object

]

MOD2

object

MOD3

string

Example (from schema)

[
  null
]

400

Request error, such as function not found or parameter error

application/json

Schema

Schema

code string

Error code

details stringnullable

Error details

hint stringnullable

Error hint

message string

Error message

Example (from schema)

{
  "code": "PGRST106",
  "details": null,
  "hint": "Only the following schemas are exposed: public",
  "message": "Invalid schema: undefined"
}

401

Authentication failed

application/json

Schema

Schema

code string

Error code

details stringnullable

Error details

hint stringnullable

Error hint

message string

Error message

Example (from schema)

{
  "code": "PGRST106",
  "details": null,
  "hint": "Only the following schemas are exposed: public",
  "message": "Invalid schema: undefined"
}

404

Function does not exist

application/json

Schema

Schema

code string

Error code

details stringnullable

Error details

hint stringnullable

Error hint

message string

Error message

Example (from schema)

{
  "code": "PGRST106",
  "details": null,
  "hint": "Only the following schemas are exposed: public",
  "message": "Invalid schema: undefined"
}

Loading...