Execute SQL

Run a SQL statement against the actor's SQLite database.

SQL executes directly against actor storage. Use bind parameters for values.

POST https://api.rivet.dev/gateway/{actor}/inspector/database/execute

Examples

curl -X POST "https://api.rivet.dev/gateway/$ACTOR_ID/inspector/database/execute" \
  -H "Authorization: Bearer $INSPECTOR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "sql": "SELECT * FROM users WHERE id = ?",
    "args": [
      "user-123"
    ]
  }'

const endpoint = "https://api.rivet.dev";
const response = await fetch(
	`${endpoint}/gateway/${process.env.ACTOR_ID}/inspector/database/execute`,
	{
		method: "POST",
		headers: {
			Authorization: `Bearer ${process.env.INSPECTOR_TOKEN}`,
			"Content-Type": "application/json",
		},
		body: JSON.stringify({
			sql: "SELECT * FROM users WHERE id = ?",
			args: ["user-123"],
		}),
	},
);
console.log(await response.json());
export {};

Authentication

Inspector endpoints do not accept namespace tokens. Send the actor’s inspector token as a bearer token in the Authorization header. Each actor generates its own inspector token on first start and stores it in its KV storage under the single byte 0x03. Read it through the control plane with GET /actors/{actor_id}/kv/keys/Aw==?namespace={namespace} using a namespace token; the response value is the token, base64-encoded. The dashboard does this for you.

Path Parameters

Headers

Request Body

Content type: application/json.

Responses

200

Rows returned by the statement.

{
  "rows": [
    {}
  ]
}

401

The inspector token is missing or invalid.