Table Schema

https://{your-workspace-slug}.{region}.xata.sh/db/db_branch_name/tables/table_name/schema

This endpoint enables reading or updating the schema of a given table.

Expected Parameters

Name	Description	In	Required	Schema
`db_branch_name`	The DBBranchName matches the pattern `{db_name}:{branch_name}`.	path	✅	string
`table_name`	The Table name	path	✅	string

Get Table Schema

GET

https://{your-workspace-slug}.{region}.xata.sh/db/db_branch_name/tables/table_name/schema

Status Code	Description	Example Response/Type Definition
200	OK	type GetTableSchema = { columns: Column[]; }; type Column = { name: string; type: "bool" \| "int" \| "float" \| "string" \| "text" \| "email" \| "multiple" \| "link" \| "object" \| "datetime" \| "vector" \| "file[]" \| "file"; link?: ColumnLink; vector?: ColumnVector; file?: ColumnFile; ["file[]"]?: ColumnFile; notNull?: boolean; defaultValue?: string; unique?: boolean; columns?: Column[]; }; type ColumnLink = { table: string; }; type ColumnVector = { /* * @maximum 10000 * @minimum 2 */ dimension: number; }; type ColumnFile = { defaultPublicAccess?: boolean; };
400	Bad Request	`type GetTableSchema = { id?: string; message: string; };`
401	Authentication Error	`{ "message": "invalid API key" }`
404	Example response	`type GetTableSchema = { id?: string; message: string; };`
5XX	Unexpected Error
default	Unexpected Error

Update Table Schema

PUT

https://{your-workspace-slug}.{region}.xata.sh/db/db_branch_name/tables/table_name/schema

Request Body Type Definition

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
type SetTableSchema = {
    columns: Column[];
};

type Column = {
    name: string;
    type: "bool" | "int" | "float" | "string" | "text" | "email" | "multiple" | "link" | "object" | "datetime" | "vector" | "file[]" | "file";
    link?: ColumnLink;
    vector?: ColumnVector;
    file?: ColumnFile;
    ["file[]"]?: ColumnFile;
    notNull?: boolean;
    defaultValue?: string;
    unique?: boolean;
    columns?: Column[];
};

type ColumnLink = {
    table: string;
};

type ColumnVector = {
    /*
     * @maximum 10000
     * @minimum 2
     */
    dimension: number;
};

type ColumnFile = {
    defaultPublicAccess?: boolean;
};

Status Code	Description	Example Response/Type Definition
200	Schema migration response with ID and migration status.	`type SetTableSchema = { /* * @minLength 1 */ migrationID: string; parentMigrationID: string; status: MigrationStatus; }; type MigrationStatus = "completed" \| "pending" \| "failed";`
204	No Content
400	Bad Request	`type SetTableSchema = { id?: string; message: string; };`
401	Authentication Error	`{ "message": "invalid API key" }`
404	Example response	`type SetTableSchema = { id?: string; message: string; };`
409	Example response	`type SetTableSchema = { id?: string; message: string; };`
5XX	Unexpected Error
default	Unexpected Error