Data, as the builder

Change many rows with SQL, as the builder

One UPDATE or DELETE; each row is written through the ordinary path, and the statement is one changeset (changesetId), undone by one revert.

POST/v1/apps/{appId}/sql/execute

Request

curl --request POST \
  --url 'https://studio.gtable.app/v1/apps/<appId>/sql/execute' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "sql": "<string>"
}'

import json
import requests

url = "https://studio.gtable.app/v1/apps/<appId>/sql/execute"
headers = {
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"sql\":\"<string>\"}")

response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())

const response = await fetch("https://studio.gtable.app/v1/apps/<appId>/sql/execute", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "sql": "<string>"
  }),
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://studio.gtable.app/v1/apps/<appId>/sql/execute");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"sql\":\"<string>\"}");
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://studio.gtable.app/v1/apps/<appId>/sql/execute", bytes.NewBuffer([]byte("{\"sql\":\"<string>\"}")))
  req.Header.Set("Authorization", "Bearer <token>")
  req.Header.Set("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://studio.gtable.app/v1/apps/<appId>/sql/execute"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"sql\":\"<string>\"}"))
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://studio.gtable.app/v1/apps/<appId>/sql/execute")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = "{\"sql\":\"<string>\"}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "kind": "update",
    "affected": 123,
    "ids": [
      "<string>"
    ],
    "failures": [
      "<string>"
    ],
    "warnings": [
      {
        "code": "<string>",
        "recordId": "<string>",
        "fieldId": "<string>",
        "fieldName": "<string>",
        "message": "<string>"
      }
    ],
    "dryRun": true,
    "changesetId": "<string>"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "details": {}
  }
}

Up to 500 rows per statement; without a WHERE it needs confirm: true; dryRun counts first. The dialect: SELECT <columns or aggregates> FROM <table> [WHERE …] [GROUP BY …] [ORDER BY …] [LIMIT n OFFSET m]; UPDATE <table> SET col = expr [WHERE …]; DELETE FROM <table> [WHERE …]. One table per statement; field names or ids (double-quote names with spaces); ‘text’, numbers, TRUE, FALSE, NULL, CURRENT_DATE; AND OR NOT, = <> < <= > >=, [NOT] LIKE, [NOT] IN (…), IS [NOT] NULL, [NOT] BETWEEN, CASE WHEN cond THEN v … [ELSE v] END and CASE expr WHEN value THEN v … [ELSE v] END; a select takes its choice’s label (any case) or id; functions LENGTH LOWER UPPER TRIM ABS ROUND COALESCE SUBSTR DATE STRFTIME IFNULL INSTR REPLACE; link columns: col HAS ANY (‘id’, …), col HAS ALL (…), col IS EMPTY. Your text is never executed: it is compiled against your own permissions, and a column you may not read is simply an unknown column.

Requires the records:write scope. Operation apps.sql.execute. MCP tool apps_sql_execute. CLI, once published: gtable apps sql execute.

Path parameters

Name	Type	Required	Description
`appId`	string	yes

Headers

Name	Type	Required	Description
`Idempotency-Key`	string	no	Any unique string. Sending the same key with the same request again returns the first response (marked `Idempotency-Replayed: true`) instead of running it twice. Reusing it for a different request is refused with 409. Kept for 24 hours. Up to 255 characters.

Request body

Field	Type	Required	Description
`sql`	string	yes	Up to 20000 characters.
`confirm`	boolean	no
`dryRun`	boolean	no

Response

application/json

Success

dataobjectrequired

Show child attributes

kindstringrequired

affectedintegerrequired

idsstring[]required

failuresstring[]

warningsobject[]

dryRunbooleanrequired

changesetIdstring

curl --request POST \ --url 'https://studio.gtable.app/v1/apps/<appId>/sql/execute' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "sql": "<string>" }'

{ "data": { "kind": "update", "affected": 123, "ids": [ "<string>" ], "failures": [ "<string>" ], "warnings": [ { "code": "<string>", "recordId": "<string>", "fieldId": "<string>", "fieldName": "<string>", "message": "<string>" } ], "dryRun": true, "changesetId": "<string>" } }

Change many rows with SQL, as the builder

Path parameters

Headers

Request body

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown