Skip to main content
Each coworker has one private SQLite database that no other coworker can read. The workspace has a second database that every coworker in it reads and writes, whichever Box they sit in. These tools reach both, so you can lay out the tables a coworker works from before it ever runs. It is plain SQLite. Column types are TEXT, INTEGER, REAL, BLOB or NUMERIC.

Coworker database

list_tables

Structure of the coworker private database: every table with its columns, types, primary keys and not-null flags.
string
required

db_query

Runs a read-only SELECT and returns the rows. Anything that writes is refused here.
string
required
string
required
A single SELECT, or WITH … SELECT.
array
Values bound to the ? placeholders, in order.
number
Maximum rows returned. Default 100, maximum 1000.
Request arguments
Use ? placeholders with params rather than pasting values into the SQL.

db_execute

Changes the coworker private database: CREATE, ALTER, DROP a table, or INSERT, UPDATE, DELETE rows.
string
required
string
A single statement.
array
Values bound to the ? placeholders in sql, in order.
object[]
Several statements applied atomically in one transaction. Each entry needs sql and may carry params. This is the right way to lay out a whole schema.
Pass either sql or statements. The call fails if you pass neither.
Request arguments

Shared database

The same three operations, on the database every coworker of the workspace shares. Get the spaceId from list_spaces.

list_space_tables

string
required

space_db_query

string
required
string
required
array
number
Default 100, maximum 1000.

space_db_execute

string
required
string
array
object[]
Every coworker of the workspace sees the result immediately. Prefer CREATE TABLE IF NOT EXISTS, extend with ALTER TABLE ADD COLUMN, and do not drop a table the coworkers already fill.