Handler for SQL queries
curl --request POST \
--url https://api.example.com/query/sql \
--header 'Content-Type: application/json' \
--data '
{
"sql": "<string>",
"include_history": true
}
'import requests
url = "https://api.example.com/query/sql"
payload = {
"sql": "<string>",
"include_history": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({sql: '<string>', include_history: true})
};
fetch('https://api.example.com/query/sql', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/query/sql",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'sql' => '<string>',
'include_history' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/query/sql"
payload := strings.NewReader("{\n \"sql\": \"<string>\",\n \"include_history\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/query/sql")
.header("Content-Type", "application/json")
.body("{\n \"sql\": \"<string>\",\n \"include_history\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/query/sql")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"sql\": \"<string>\",\n \"include_history\": true\n}"
response = http.request(request)
puts response.read_body{
"app_id": "<string>",
"collection": "<string>",
"count": 1,
"data": [
"<unknown>"
],
"query": "<string>"
}Data Query
Handler for SQL queries
POST /query/sql
Body: { "sql": "SELECT ... FROM app::collection WHERE ..." }
The SQL query must use the "app::collection" format for table references,
which is equivalent to "schema.table" in standard SQL.
POST
/
query
/
sql
Handler for SQL queries
curl --request POST \
--url https://api.example.com/query/sql \
--header 'Content-Type: application/json' \
--data '
{
"sql": "<string>",
"include_history": true
}
'import requests
url = "https://api.example.com/query/sql"
payload = {
"sql": "<string>",
"include_history": True
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({sql: '<string>', include_history: true})
};
fetch('https://api.example.com/query/sql', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/query/sql",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'sql' => '<string>',
'include_history' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/query/sql"
payload := strings.NewReader("{\n \"sql\": \"<string>\",\n \"include_history\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/query/sql")
.header("Content-Type", "application/json")
.body("{\n \"sql\": \"<string>\",\n \"include_history\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/query/sql")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"sql\": \"<string>\",\n \"include_history\": true\n}"
response = http.request(request)
puts response.read_body{
"app_id": "<string>",
"collection": "<string>",
"count": 1,
"data": [
"<unknown>"
],
"query": "<string>"
}Body
application/json
SQL Query Request
SQL query string Format: SELECT ... FROM app::collection WHERE ... Example: "SELECT name, age FROM myapp::users WHERE age > 18 ORDER BY name LIMIT 10"
Include all versions of records (history)
- true: Return all versions of each record (append-only mode)
- false (default): Return only latest version of each record (deduplicated by user-defined "id" field)
Response
SQL query executed successfully