0

SQL query

by
Published Apr 8, 2025

Run an SQL query across the database branch.

Script xata Verified

The script

Submitted by hugo697 Bun
Verified 428 days ago
1
//native
2
type Xata = {
3
	apiKey: string
4
	workspaceUrl: string
5
}
6
/**
7
 * SQL query
8
 * Run an SQL query across the database branch.
9
 */
10
export async function main(
11
	auth: Xata,
12
	db_branch_name: string,
13
	body: { statement: string; params?: unknown[] } & {
14
		consistency?: 'strong' | 'eventual'
15
		responseType?: 'json' | 'array'
16
	}
17
) {
18
	const url = new URL(`${auth.workspaceUrl}/db/${db_branch_name}/sql`)
19

20
	const response = await fetch(url, {
21
		method: 'POST',
22
		headers: {
23
			'Content-Type': 'application/json',
24
			Authorization: 'Bearer ' + auth.apiKey
25
		},
26
		body: JSON.stringify(body)
27
	})
28
	if (!response.ok) {
29
		const text = await response.text()
30
		throw new Error(`${response.status} ${text}`)
31
	}
32
	return await response.json()
33
}
34