Quickstart
1
Get your Database URL
Your Database URL can be found in the Dashboard under Edge Platform > Database > [Select Database] > Access.The HTTP endpoint follows this format:
Note the
/v2/pipeline path — this is the endpoint that accepts SQL requests.2
Get your Access Token
You’ll need an access token to authenticate requests. Generate one from the same Access page in the Dashboard, or see Database Access for details.
3
Execute a query
Send a POST request to the pipeline endpoint with your SQL statement:
Request format
Each request to/v2/pipeline contains an array of requests to execute. A typical request includes an execute statement followed by a close:
Response format
The response contains aresults array with the outcome of each request:
Parameter binding
Use parameter binding to safely pass values to your queries. This helps prevent SQL injection and handles proper escaping.Positional parameters
Use? placeholders and provide values in the args array:
Named parameters
Use:name, $name, or @name placeholders with named_args:
Value types
Thetype field in parameter values must be one of:
| Type | Description |
|---|---|
null | NULL value |
integer | 64-bit signed integer |
float | 64-bit floating point |
text | UTF-8 string |
blob | Binary data (base64 encoded) |
Values are passed as strings in JSON to avoid precision loss, since some JSON
implementations treat all numbers as 64-bit floats.
Multiple statements
You can execute multiple statements in a single request:Interactive sessions
For most use cases, executing statements with aclose request in a single HTTP call is sufficient. The API also supports interactive sessions using a baton, a token returned in responses that allows you to maintain state across multiple HTTP requests. This is useful for advanced scenarios like long-running transactions that span multiple roundtrips.
If you have a use case that requires interactive sessions with batons,
contact us to discuss your requirements.