Update Branch schema

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

Update the branch schema with migration operations

Expected parameters

NameDescriptionInRequiredSchema
db_branch_name

The DBBranchName matches the pattern {db_name}:{branch_name}.

pathstring

Update Branch Schema

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

Request Body Type Definition

type UpdateBranchSchema = Migration;
 
/**
 * Branch schema migration.
 */
type Migration = {
    parentID?: string;
    operations: MigrationOp[];
};
 
/**
 * Branch schema migration operations.
 */
type MigrationOp = MigrationTableOp | MigrationColumnOp;
 
type MigrationTableOp = {
    addTable: TableOpAdd;
} | {
    removeTable: TableOpRemove;
} | {
    renameTable: TableOpRename;
};
 
type MigrationColumnOp = {
    addColumn: ColumnOpAdd;
} | {
    removeColumn: ColumnOpRemove;
} | {
    renameColumn: ColumnOpRename;
};
 
type TableOpAdd = {
    table: string;
};
 
type TableOpRemove = {
    table: string;
};
 
type TableOpRename = {
    oldName: string;
    newName: string;
};
 
type ColumnOpAdd = {
    table: string;
    column: Column;
};
 
type ColumnOpRemove = {
    table: string;
    column: string;
};
 
type ColumnOpRename = {
    table: string;
    oldName: string;
    newName: string;
};
 
type Column = {
    name: string;
    type: "bool" | "int" | "float" | "string" | "text" | "email" | "multiple" | "link" | "object" | "datetime" | "vector" | "file[]" | "file" | "json";
    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;
};

Responses

type UpdateBranchSchema = {
    /**
     * @minLength 1
     */
    migrationID: string;
    parentMigrationID: string;
    status: MigrationStatus;
};
 
type MigrationStatus = "completed" | "pending" | "failed";