Branch Migrations [deprecated]
https://{your-workspace-slug}.{region}.xata.sh/db/db_branch_name/migrations
This path allows access to migrations on a given database branch.
Expected parameters
Name | Description | In | Required | Schema |
---|---|---|---|---|
db_branch_name | The DBBranchName matches the pattern | path | ✅ | string |
Get Branch Migration History [Deprecated]
GEThttps://{your-workspace-slug}.{region}.xata.sh/db/db_branch_name/migrations
Request Body Type Definition
type GetBranchMigrationHistory = {
limit?: number;
startFrom?: string;
};
Responses
type GetBranchMigrationHistory = {
startedFrom?: StartedFromMetadata;
migrations?: BranchMigration[];
};
type StartedFromMetadata = {
branchName: BranchName;
dbBranchID: string;
migrationID: string;
};
type BranchMigration = {
id?: string;
parentID?: string;
status: string;
title?: string;
lastGitRevision?: string;
localChanges: boolean;
createdAt?: DateTime;
newTables?: {
[key: string]: Table;
};
removedTables?: string[];
tableMigrations?: {
[key: string]: TableMigration;
};
newTableOrder: string[];
renamedTables?: TableRename[];
};
/**
* @maxLength 255
* @minLength 1
* @pattern [a-zA-Z0-9_\-~]+
*/
type BranchName = string;
/**
* @format date-time
*/
type DateTime = string;
type Table = {
id?: string;
name: TableName;
columns: Column[];
revLinks?: RevLink[];
};
type TableMigration = {
newColumns?: {
[key: string]: Column;
};
removedColumns?: string[];
modifiedColumns?: ColumnMigration[];
newColumnOrder: string[];
};
/**
* @example {"newName":"newName","oldName":"oldName"}
*/
type TableRename = {
/**
* @minLength 1
*/
newName: string;
/**
* @minLength 1
*/
oldName: string;
};
/**
* @maxLength 255
* @minLength 1
* @pattern [a-zA-Z0-9_\-~]+
*/
type TableName = 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 RevLink = {
table: string;
column: string;
};
type ColumnMigration = {
old: Column;
["new"]: Column;
};
type ColumnLink = {
table: string;
};
type ColumnVector = {
/**
* @maximum 10000
* @minimum 2
*/
dimension: number;
};
type ColumnFile = {
defaultPublicAccess?: boolean;
};
type GetBranchMigrationHistory = {
id?: string;
message: string;
};
{
"message": "invalid API key"
}
type GetBranchMigrationHistory = {
id?: string;
message: string;
};
type GetBranchMigrationHistory = void;
type GetBranchMigrationHistory = void;