Execute Sql | Labric | Documentation

Execute a read-only SQL query.

Runs the query against the organization’s read replica, so it cannot mutate data. Only SELECT statements are accepted. Supports positional parameters via a params list. Use the schema tool to discover tables first, and reference each column by its sql_column_name — foreign keys carry an _id suffix in SQL (e.g. a ‘sample’ reference is the ‘sample_id’ column).

Execute a read-only SQL query. Runs the query against the organization's read replica, so it cannot mutate data. Only SELECT statements are accepted. Supports positional parameters via a params list. Use the schema tool to discover tables first, and reference each column by its sql_column_name — foreign keys carry an _id suffix in SQL (e.g. a 'sample' reference is the 'sample_id' column).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

querystringRequired

paramslist of any or nullOptional

Response

columnslist of strings

datalist of lists of any

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error

503

Service Unavailable Error

$	curl -X POST https://platform.labric.co/api/v1/tools/query \
>	-H "Authorization: Bearer <api_key>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"query": "SELECT id, username, email FROM users WHERE active = true ORDER BY created_at DESC LIMIT 5"
>	}'

1	{
2	"columns": [
3	"id",
4	"username",
5	"email"
6	],
7	"data": [
8	[
9	101,
10	"jdoe",
11	"jdoe@example.com"
12	],
13	[
14	102,
15	"asmith",
16	"asmith@example.com"
17	],
18	[
19	103,
20	"mbrown",
21	"mbrown@example.com"
22	],
23	[
24	104,
25	"ljones",
26	"ljones@example.com"
27	],
28	[
29	105,
30	"kwilson",
31	"kwilson@example.com"
32	]
33	]
34	}