@xata.io/client 0.21.6 → 0.22.0

package/dist/index.d.ts

@@ -215,6 +215,18 @@ type ListDatabasesResponse = {
      */
     databases: DatabaseMetadata[];
 };
+/**
+ * @maxLength 255
+ * @minLength 1
+ * @pattern [a-zA-Z0-9_\-~]+
+ */
+type DBName$1 = string;
+/**
+ * @maxLength 255
+ * @minLength 1
+ * @pattern [a-zA-Z0-9_\-~]+
+ */
+type BranchName$1 = string;
 /**
  * @example {"repository":"github.com/my/repository","branch":"feature-login","stage":"testing","labels":["epic-100"]}
  * @x-go-type xata.BranchMetadata
@@ -231,38 +243,22 @@ type BranchMetadata$1 = {
     stage?: string;
     labels?: string[];
 };
-/**
- * @maxLength 255
- * @minLength 1
- * @pattern [a-zA-Z0-9_\-~]+
- */
-type BranchName$1 = string;
-/**
- * @maxLength 255
- * @minLength 1
- * @pattern [a-zA-Z0-9_\-~]+
- */
-type DBName$1 = string;
 type MigrationStatus$1 = 'completed' | 'pending' | 'failed';
+type Region = {
+    id: string;
+};
 type ListRegionsResponse = {
     /**
      * A list of regions where databases can be created
      */
     regions: Region[];
 };
-type Region = {
-    id: string;
-};
 
 /**
  * Generated by @openapi-codegen
  *
  * @version 1.0
  */
-type SimpleError$1 = {
-    id?: string;
-    message: string;
-};
 type BadRequestError$1 = {
     id?: string;
     message: string;
@@ -274,6 +270,10 @@ type AuthError$1 = {
     id?: string;
     message: string;
 };
+type SimpleError$1 = {
+    id?: string;
+    message: string;
+};
 
 /**
  * Generated by @openapi-codegen
@@ -809,6 +809,12 @@ type CreateDatabaseError = ErrorWrapper$1<{
 } | {
     status: 401;
     payload: AuthError$1;
+} | {
+    status: 422;
+    payload: SimpleError$1;
+} | {
+    status: 423;
+    payload: SimpleError$1;
 }>;
 type CreateDatabaseResponse = {
     /**
@@ -959,20 +965,39 @@ declare const listRegions: (variables: ListRegionsVariables, signal?: AbortSigna
  *
  * @version 1.0
  */
-type ListBranchesResponse = {
-    databaseName: string;
-    branches: Branch[];
-};
-type ListGitBranchesResponse = {
-    mapping: {
-        gitBranch: string;
-        xataBranch: string;
-    }[];
-};
+/**
+ * @maxLength 255
+ * @minLength 1
+ * @pattern [a-zA-Z0-9_\-~]+
+ */
+type DBName = string;
+/**
+ * @format date-time
+ * @x-go-type string
+ */
+type DateTime = string;
 type Branch = {
     name: string;
     createdAt: DateTime;
 };
+type ListBranchesResponse = {
+    databaseName: string;
+    branches: Branch[];
+};
+/**
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+ *
+ * @maxLength 511
+ * @minLength 1
+ * @pattern [a-zA-Z0-9_\-~]+:[a-zA-Z0-9_\-~]+
+ */
+type DBBranchName = string;
+/**
+ * @maxLength 255
+ * @minLength 1
+ * @pattern [a-zA-Z0-9_\-~]+
+ */
+type BranchName = string;
 /**
  * @example {"repository":"github.com/my/repository","branch":"feature-login","stage":"testing","labels":["epic-100"]}
  * @x-go-type xata.BranchMetadata
@@ -989,39 +1014,19 @@ type BranchMetadata = {
     stage?: string;
     labels?: string[];
 };
-type DBBranch = {
-    databaseName: DBName;
-    branchName: BranchName;
-    createdAt: DateTime;
-    id: string;
-    version: number;
-    lastMigrationID: string;
-    metadata?: BranchMetadata;
-    startedFrom?: StartedFromMetadata;
-    schema: Schema;
-};
 type StartedFromMetadata = {
     branchName: BranchName;
     dbBranchID: string;
     migrationID: string;
 };
 /**
- * @x-go-type xata.Schema
+ * @maxLength 255
+ * @minLength 1
+ * @pattern [a-zA-Z0-9_\-~]+
  */
-type Schema = {
-    tables: Table[];
-    tablesOrder?: string[];
-};
-type SchemaEditScript = {
-    sourceMigrationID?: string;
-    targetMigrationID?: string;
-    operations: MigrationOp[];
-};
-type Table = {
-    id?: string;
-    name: TableName;
-    columns: Column[];
-    revLinks?: RevLink[];
+type TableName = string;
+type ColumnLink = {
+    table: string;
 };
 type Column = {
     name: string;
@@ -1032,43 +1037,35 @@ type Column = {
     unique?: boolean;
     columns?: Column[];
 };
-type ColumnLink = {
-    table: string;
-};
 type RevLink = {
     linkID: string;
     table: string;
 };
+type Table = {
+    id?: string;
+    name: TableName;
+    columns: Column[];
+    revLinks?: RevLink[];
+};
 /**
- * @maxLength 255
- * @minLength 1
- * @pattern [a-zA-Z0-9_\-~]+
- */
-type BranchName = string;
-/**
- * @maxLength 255
- * @minLength 1
- * @pattern [a-zA-Z0-9_\-~]+
- */
-type DBName = string;
-/**
- * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
- *
- * @maxLength 511
- * @minLength 1
- * @pattern [a-zA-Z0-9_\-~]+:[a-zA-Z0-9_\-~]+
- */
-type DBBranchName = string;
-/**
- * @maxLength 255
- * @minLength 1
- * @pattern [a-zA-Z0-9_\-~]+
- */
-type TableName = string;
-/**
- * @pattern [a-zA-Z0-9_\-~\.]+
+ * @x-go-type xata.Schema
  */
-type ColumnName = string;
+type Schema = {
+    tables: Table[];
+    tablesOrder?: string[];
+};
+type DBBranch = {
+    databaseName: DBName;
+    branchName: BranchName;
+    createdAt: DateTime;
+    id: string;
+    version: number;
+    lastMigrationID: string;
+    metadata?: BranchMetadata;
+    startedFrom?: StartedFromMetadata;
+    schema: Schema;
+};
+type MigrationStatus = 'completed' | 'pending' | 'failed';
 type MetricsDatapoint = {
     timestamp: string;
     value: number;
@@ -1077,6 +1074,37 @@ type MetricsLatency = {
     p50?: MetricsDatapoint[];
     p90?: MetricsDatapoint[];
 };
+type ListGitBranchesResponse = {
+    mapping: {
+        gitBranch: string;
+        xataBranch: string;
+    }[];
+};
+type ColumnMigration = {
+    old: Column;
+    ['new']: Column;
+};
+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;
+};
 type BranchMigration = {
     id?: string;
     parentID?: string;
@@ -1095,78 +1123,109 @@ type BranchMigration = {
     newTableOrder: string[];
     renamedTables?: TableRename[];
 };
-type TableMigration = {
-    newColumns?: {
-        [key: string]: Column;
-    };
-    removedColumns?: string[];
-    modifiedColumns?: ColumnMigration[];
-    newColumnOrder: string[];
-};
-type ColumnMigration = {
-    old: Column;
-    ['new']: Column;
-};
-type Commit = {
-    title?: string;
-    message?: string;
-    id: string;
-    parentID?: string;
-    mergeParentID?: string;
-    status: MigrationStatus;
-    createdAt: DateTime;
-    modifiedAt?: DateTime;
-    operations: MigrationOp[];
-};
-type MigrationStatus = 'completed' | 'pending' | 'failed';
 /**
- * Branch schema migration.
+ * @minProperties 1
  */
-type Migration = {
-    parentID?: string;
-    operations: MigrationOp[];
+type FilterExpression = {
+    $exists?: string;
+    $existsNot?: string;
+    $any?: FilterList;
+    $all?: FilterList;
+    $none?: FilterList;
+    $not?: FilterList;
+} & {
+    [key: string]: FilterColumn;
 };
+type FilterList = FilterExpression | FilterExpression[];
+type FilterValue = number | string | boolean;
+type FilterPredicate = FilterValue | FilterPredicate[] | FilterPredicateOp | FilterPredicateRangeOp;
+type FilterRangeValue = number | string;
 /**
- * Branch schema migration operations.
+ * @maxProperties 1
+ * @minProperties 1
  */
-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 FilterPredicateOp = {
+    $any?: FilterPredicate[];
+    $all?: FilterPredicate[];
+    $none?: FilterPredicate | FilterPredicate[];
+    $not?: FilterPredicate | FilterPredicate[];
+    $is?: FilterValue | FilterValue[];
+    $isNot?: FilterValue | FilterValue[];
+    $lt?: FilterRangeValue;
+    $le?: FilterRangeValue;
+    $gt?: FilterRangeValue;
+    $ge?: FilterRangeValue;
+    $contains?: string;
+    $startsWith?: string;
+    $endsWith?: string;
+    $pattern?: string;
 };
-type ColumnOpAdd = {
-    table: string;
-    column: Column;
+/**
+ * @maxProperties 2
+ * @minProperties 2
+ */
+type FilterPredicateRangeOp = {
+    $lt?: FilterRangeValue;
+    $le?: FilterRangeValue;
+    $gt?: FilterRangeValue;
+    $ge?: FilterRangeValue;
 };
-type ColumnOpRemove = {
-    table: string;
-    column: string;
+/**
+ * @maxProperties 1
+ * @minProperties 1
+ */
+type FilterColumnIncludes = {
+    $includes?: FilterPredicate;
+    $includesAny?: FilterPredicate;
+    $includesAll?: FilterPredicate;
+    $includesNone?: FilterPredicate;
 };
-type ColumnOpRename = {
-    table: string;
-    oldName: string;
-    newName: string;
+type FilterColumn = FilterColumnIncludes | FilterPredicate | FilterList;
+type SortOrder = 'asc' | 'desc';
+type SortExpression = string[] | {
+    [key: string]: SortOrder;
+} | {
+    [key: string]: SortOrder;
+}[];
+/**
+ * Pagination settings.
+ */
+type PageConfig = {
+    /**
+     * Query the next page that follow the cursor.
+     */
+    after?: string;
+    /**
+     * Query the previous page before the cursor.
+     */
+    before?: string;
+    /**
+     * Query the first page from the cursor.
+     */
+    start?: string;
+    /**
+     * Query the last page from the cursor.
+     */
+    end?: string;
+    /**
+     * Set page size. If the size is missing it is read from the cursor. If no cursor is given Xata will choose the default page size.
+     *
+     * @default 20
+     */
+    size?: number;
+    /**
+     * Use offset to skip entries. To skip pages set offset to a multiple of size.
+     *
+     * @default 0
+     */
+    offset?: number;
 };
+/**
+ * @example name
+ * @example email
+ * @example created_at
+ */
+type ColumnsProjection = string[];
 /**
  * The migration request number.
  *
@@ -1210,330 +1269,316 @@ type MigrationRequest = {
      */
     target?: string;
 };
-type SortExpression = string[] | {
-    [key: string]: SortOrder;
+/**
+ * Records metadata
+ */
+type RecordsMetadata = {
+    page: {
+        /**
+         * last record id
+         */
+        cursor: string;
+        /**
+         * true if more records can be fetch
+         */
+        more: boolean;
+    };
+};
+type TableOpAdd = {
+    table: string;
+};
+type TableOpRemove = {
+    table: string;
+};
+type TableOpRename = {
+    oldName: string;
+    newName: string;
+};
+type MigrationTableOp = {
+    addTable: TableOpAdd;
 } | {
-    [key: string]: SortOrder;
-}[];
-type SortOrder = 'asc' | 'desc';
+    removeTable: TableOpRemove;
+} | {
+    renameTable: TableOpRename;
+};
+type ColumnOpAdd = {
+    table: string;
+    column: Column;
+};
+type ColumnOpRemove = {
+    table: string;
+    column: string;
+};
+type ColumnOpRename = {
+    table: string;
+    oldName: string;
+    newName: string;
+};
+type MigrationColumnOp = {
+    addColumn: ColumnOpAdd;
+} | {
+    removeColumn: ColumnOpRemove;
+} | {
+    renameColumn: ColumnOpRename;
+};
 /**
- * Maximum [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance) for the search terms. The Levenshtein
- * distance is the number of one character changes needed to make two strings equal. The default is 1, meaning that single
- * character typos per word are tollerated by search. You can set it to 0 to remove the typo tollerance or set it to 2
- * to allow two typos in a word.
- *
- * @default 1
- * @maximum 2
- * @minimum 0
+ * Branch schema migration operations.
  */
-type FuzzinessExpression = number;
+type MigrationOp = MigrationTableOp | MigrationColumnOp;
+type Commit = {
+    title?: string;
+    message?: string;
+    id: string;
+    parentID?: string;
+    mergeParentID?: string;
+    status: MigrationStatus;
+    createdAt: DateTime;
+    modifiedAt?: DateTime;
+    operations: MigrationOp[];
+};
+type SchemaEditScript = {
+    sourceMigrationID?: string;
+    targetMigrationID?: string;
+    operations: MigrationOp[];
+};
 /**
- * If the prefix type is set to "disabled" (the default), the search only matches full words. If the prefix type is set to "phrase", the search will return results that match prefixes of the search phrase.
+ * Branch schema migration.
  */
-type PrefixExpression = 'phrase' | 'disabled';
+type Migration = {
+    parentID?: string;
+    operations: MigrationOp[];
+};
 /**
- * The target expression is used to filter the search results by the target columns.
+ * @pattern [a-zA-Z0-9_\-~\.]+
  */
-type TargetExpression = (string | {
+type ColumnName = string;
+/**
+ * Insert operation
+ */
+type TransactionInsertOp = {
     /**
-     * The name of the column.
+     * The table name
      */
-    column: string;
+    table: string;
     /**
-     * The weight of the column.
+     * The record to insert. The `id` field is optional; when specified, it will be used as the ID for the record.
+     */
+    record: {
+        [key: string]: any;
+    };
+    /**
+     * The version of the record you expect to be overwriting. Only valid with an
+     * explicit ID is also set in the `record` key.
+     */
+    ifVersion?: number;
+    /**
+     * createOnly is used to change how Xata acts when an explicit ID is set in the `record` key.
      *
-     * @default 1
-     * @maximum 10
-     * @minimum 1
+     * If `createOnly` is set to `true`, Xata will only attempt to insert the record. If there's a conflict, Xata
+     * will cancel the transaction.
+     *
+     * If `createOnly` is set to `false`, Xata will attempt to insert the record. If there's no
+     * conflict, the record is inserted. If there is a conflict, Xata will replace the record.
      */
-    weight?: number;
-})[];
-/**
- * @minProperties 1
- */
-type FilterExpression = {
-    $exists?: string;
-    $existsNot?: string;
-    $any?: FilterList;
-    $all?: FilterList;
-    $none?: FilterList;
-    $not?: FilterList;
-} & {
-    [key: string]: FilterColumn;
+    createOnly?: boolean;
 };
 /**
- * The description of the summaries you wish to receive. Set each key to be the field name
- * you'd like for the summary. These names must not collide with other columns you've
- * requested from `columns`; including implicit requests like `settings.*`.
- *
- * The value for each key needs to be an object. This object should contain one key and one
- * value only. In this object, the key should be set to the summary function you wish to use
- * and the value set to the column name to be summarized.
- *
- * The column being summarized cannot be an internal column (id, xata.*), nor the base of
- * an object, i.e. if `settings` is an object with `dark_mode` as a field, you may summarize
- * `settings.dark_mode` but not `settings` nor `settings.*`.
- *
- * @example {"all_users":{"count":"*"}}
- * @example {"total_created":{"count":"created_at"}}
- * @example {"min_cost":{"min":"cost"}}
- * @example {"max_happiness":{"max":"happiness"}}
- * @example {"total_revenue":{"sum":"revenue"}}
- * @example {"average_speed":{"average":"speed"}}
- * @x-go-type xbquery.SummaryList
+ * @pattern [a-zA-Z0-9_-~:]+
  */
-type SummaryExpressionList = {
-    [key: string]: SummaryExpression;
-};
+type RecordID = string;
 /**
- * A summary expression is the description of a single summary operation. It consists of a single
- * key representing the operation, and a value representing the column to be operated on.
- *
- * The column being summarized cannot be an internal column (id, xata.*), nor the base of
- * an object, i.e. if `settings` is an object with `dark_mode` as a field, you may summarize
- * `settings.dark_mode` but not `settings` nor `settings.*`.
- *
- * We currently support several aggregation functions. Not all functions can be run on all column
- * types.
- *
- *   - `count` is used to count the number of records in each group. Use `{"count": "*"}` to count
- *     all columns present, otherwise `{"count": "<column_path>"}` to count the number of non-null
- *     values are present at column path.
- *
- *     Count can be used on any column type, and always returns an int.
- *
- *   - `min` calculates the minimum value in each group. `min` is compatible with most types;
- *     string, multiple, text, email, int, float, and datetime. It returns a value of the same
- *     type as operated on. This means that `{"lowest_latency": {"min": "latency"}}` where
- *     `latency` is an int, will always return an int.
- *
- *   - `max` calculates the maximum value in each group. `max` shares the same compatibility as
- *     `min`.
- *
- *   - `sum` adds up all values in a group. `sum` can be run on `int` and `float` types, and will
- *     return a value of the same type as requested.
- *
- *   - `average` averages all values in a group. `average` can be run on `int` and `float` types, and
- *     always returns a float.
- *
- * @example {"count":"deleted_at"}
- * @x-go-type xbquery.Summary
+ * Update operation
  */
-type SummaryExpression = Record<string, any>;
+type TransactionUpdateOp = {
+    /**
+     * The table name
+     */
+    table: string;
+    id: RecordID;
+    /**
+     * The fields of the record you'd like to update
+     */
+    fields: {
+        [key: string]: any;
+    };
+    /**
+     * The version of the record you expect to be updating
+     */
+    ifVersion?: number;
+    /**
+     * Xata will insert this record if it cannot be found.
+     */
+    upsert?: boolean;
+};
 /**
- * The description of the aggregations you wish to receive.
- *
- * @example {"totalCount":{"count":"*"},"dailyActiveUsers":{"dateHistogram":{"column":"date","interval":"1d"},"aggs":{"uniqueUsers":{"uniqueCount":{"column":"userID"}}}}}
+ * A delete operation. The transaction will continue if no record matches the ID.
  */
-type AggExpressionMap = {
-    [key: string]: AggExpression;
+type TransactionDeleteOp = {
+    /**
+     * The table name
+     */
+    table: string;
+    id: RecordID;
 };
 /**
- * The description of a single aggregation operation. It is an object with only one key-value pair.
- * The key represents the aggreagtion type, while the value is an object with the configuration of
- * the aggreagtion.
- *
- * @x-go-type xata.AggExpression
+ * A transaction operation
  */
-type AggExpression = {
-    count?: CountAgg;
-} | {
-    sum?: SumAgg;
-} | {
-    max?: MaxAgg;
-} | {
-    min?: MinAgg;
-} | {
-    average?: AverageAgg;
-} | {
-    uniqueCount?: UniqueCountAgg;
-} | {
-    dateHistogram?: DateHistogramAgg;
+type TransactionOperation$1 = {
+    insert: TransactionInsertOp;
 } | {
-    topValues?: TopValuesAgg;
+    update: TransactionUpdateOp;
 } | {
-    numericHistogram?: NumericHistogramAgg;
+    ['delete']: TransactionDeleteOp;
 };
 /**
- * Count the number of records with an optional filter.
- */
-type CountAgg = {
-    filter?: FilterExpression;
-} | '*';
-/**
- * The sum of the numeric values in a particular column.
+ * A result from an insert operation.
  */
-type SumAgg = {
+type TransactionResultInsert = {
     /**
-     * The column on which to compute the sum. Must be a numeric type.
+     * The type of operation who's result is being returned.
      */
-    column: string;
+    operation: 'insert';
+    /**
+     * The number of affected rows
+     */
+    rows: number;
+    id: RecordID;
 };
 /**
- * The max of the numeric values in a particular column.
+ * A result from an update operation.
  */
-type MaxAgg = {
+type TransactionResultUpdate = {
     /**
-     * The column on which to compute the max. Must be a numeric type.
+     * The type of operation who's result is being returned.
      */
-    column: string;
+    operation: 'update';
+    /**
+     * The number of updated rows
+     */
+    rows: number;
+    id: RecordID;
 };
 /**
- * The min of the numeric values in a particular column.
+ * A result from a delete operation.
  */
-type MinAgg = {
+type TransactionResultDelete = {
     /**
-     * The column on which to compute the min. Must be a numeric type.
+     * The type of operation who's result is being returned.
      */
-    column: string;
+    operation: 'delete';
+    /**
+     * The number of deleted rows
+     */
+    rows: number;
 };
 /**
- * The average of the numeric values in a particular column.
+ * An ordered array of results from the submitted operations.
  */
-type AverageAgg = {
-    /**
-     * The column on which to compute the average. Must be a numeric type.
-     */
-    column: string;
+type TransactionSuccess = {
+    results: (TransactionResultInsert | TransactionResultUpdate | TransactionResultDelete)[];
 };
 /**
- * Count the number of distinct values in a particular column.
+ * An error message from a failing transaction operation
  */
-type UniqueCountAgg = {
+type TransactionError = {
     /**
-     * The column from where to count the unique values.
+     * The index of the failing operation
      */
-    column: string;
+    index: number;
     /**
-     * The threshold under which the unique count is exact. If the number of unique
-     * values in the column is higher than this threshold, the results are approximative.
-     * Maximum value is 40,000, default value is 3000.
+     * The error message
      */
-    precisionThreshold?: number;
+    message: string;
 };
 /**
- * Split data into buckets by a datetime column. Accepts sub-aggregations for each bucket.
+ * An array of errors, with indicides, from the transaction.
  */
-type DateHistogramAgg = {
+type TransactionFailure = {
     /**
-     * The column to use for bucketing. Must be of type datetime.
+     * The request ID.
      */
-    column: string;
+    id: string;
     /**
-     * The fixed interval to use when bucketing.
-     * It is fromatted as number + units, for example: `5d`, `20m`, `10s`.
-     *
-     * @pattern ^(\d+)(d|h|m|s|ms)$
+     * An array of errors from the submitted operations.
      */
-    interval?: string;
+    errors: TransactionError[];
+};
+/**
+ * Xata Table Record Metadata
+ */
+type RecordMeta = {
+    id: RecordID;
+    xata: {
+        /**
+         * The record's version. Can be used for optimistic concurrency control.
+         */
+        version: number;
+        /**
+         * The record's table name. APIs that return records from multiple tables will set this field accordingly.
+         */
+        table?: string;
+        /**
+         * Highlights of the record. This is used by the search APIs to indicate which fields and parts of the fields have matched the search.
+         */
+        highlight?: {
+            [key: string]: string[] | {
+                [key: string]: any;
+            };
+        };
+        /**
+         * The record's relevancy score. This is returned by the search APIs.
+         */
+        score?: number;
+        /**
+         * Encoding/Decoding errors
+         */
+        warnings?: string[];
+    };
+};
+/**
+ * The target expression is used to filter the search results by the target columns.
+ */
+type TargetExpression = (string | {
     /**
-     * The calendar-aware interval to use when bucketing. Possible values are: `minute`,
-     * `hour`, `day`, `week`, `month`, `quarter`, `year`.
+     * The name of the column.
      */
-    calendarInterval?: 'minute' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year';
+    column: string;
     /**
-     * The timezone to use for bucketing. By default, UTC is assumed.
-     * The accepted format is as an ISO 8601 UTC offset. For example: `+01:00` or
-     * `-08:00`.
+     * The weight of the column.
      *
-     * @pattern ^[+-][01]\d:[0-5]\d$
+     * @default 1
+     * @maximum 10
+     * @minimum 1
      */
-    timezone?: string;
-    aggs?: AggExpressionMap;
-};
+    weight?: number;
+})[];
 /**
- * Split data into buckets by the unique values in a column. Accepts sub-aggregations for each bucket.
- * The top values as ordered by the number of records (`$count`) are returned.
+ * Boost records with a particular value for a column.
  */
-type TopValuesAgg = {
+type ValueBooster$1 = {
     /**
-     * The column to use for bucketing. Accepted types are `string`, `email`, `int`, `float`, or `bool`.
+     * The column in which to look for the value.
      */
     column: string;
-    aggs?: AggExpressionMap;
     /**
-     * The maximum number of unique values to return.
-     *
-     * @default 10
-     * @maximum 1000
+     * The exact value to boost.
      */
-    size?: number;
+    value: string | number | boolean;
+    /**
+     * The factor with which to multiply the score of the record.
+     */
+    factor: number;
+    /**
+     * Only apply this booster to the records for which the provided filter matches.
+     */
+    ifMatchesFilter?: FilterExpression;
 };
 /**
- * Split data into buckets by dynamic numeric ranges. Accepts sub-aggregations for each bucket.
+ * Boost records based on the value of a numeric column.
  */
-type NumericHistogramAgg = {
+type NumericBooster$1 = {
     /**
-     * The column to use for bucketing. Must be of numeric type.
-     */
-    column: string;
-    /**
-     * The numeric interval to use for bucketing. The resulting buckets will be ranges
-     * with this value as size.
-     *
-     * @minimum 0
-     */
-    interval: number;
-    /**
-     * By default the bucket keys start with 0 and then continue in `interval` steps. The bucket
-     * boundaries can be shiftend by using the offset option. For example, if the `interval` is 100,
-     * but you prefer the bucket boundaries to be `[50, 150), [150, 250), etc.`, you can set `offset`
-     * to 50.
-     *
-     * @default 0
-     */
-    offset?: number;
-    aggs?: AggExpressionMap;
-};
-type HighlightExpression = {
-    /**
-     * Set to `false` to disable highlighting. By default it is `true`.
-     */
-    enabled?: boolean;
-    /**
-     * Set to `false` to disable HTML encoding in highlight snippets. By default it is `true`.
-     */
-    encodeHTML?: boolean;
-};
-/**
- * Booster Expression
- *
- * @x-go-type xata.BoosterExpression
- */
-type BoosterExpression = {
-    valueBooster?: ValueBooster$1;
-} | {
-    numericBooster?: NumericBooster$1;
-} | {
-    dateBooster?: DateBooster$1;
-};
-/**
- * Boost records with a particular value for a column.
- */
-type ValueBooster$1 = {
-    /**
-     * The column in which to look for the value.
-     */
-    column: string;
-    /**
-     * The exact value to boost.
-     */
-    value: string | number | boolean;
-    /**
-     * The factor with which to multiply the score of the record.
-     */
-    factor: number;
-    /**
-     * Only apply this booster to the records for which the provided filter matches.
-     */
-    ifMatchesFilter?: FilterExpression;
-};
-/**
- * Boost records based on the value of a numeric column.
- */
-type NumericBooster$1 = {
-    /**
-     * The column in which to look for the value.
+     * The column in which to look for the value.
      */
     column: string;
     /**
@@ -1589,83 +1634,42 @@ type DateBooster$1 = {
      */
     ifMatchesFilter?: FilterExpression;
 };
-type FilterList = FilterExpression | FilterExpression[];
-type FilterColumn = FilterColumnIncludes | FilterPredicate | FilterList;
-/**
- * @maxProperties 1
- * @minProperties 1
- */
-type FilterColumnIncludes = {
-    $includes?: FilterPredicate;
-    $includesAny?: FilterPredicate;
-    $includesAll?: FilterPredicate;
-    $includesNone?: FilterPredicate;
-};
-type FilterPredicate = FilterValue | FilterPredicate[] | FilterPredicateOp | FilterPredicateRangeOp;
 /**
- * @maxProperties 1
- * @minProperties 1
+ * Booster Expression
+ *
+ * @x-go-type xata.BoosterExpression
  */
-type FilterPredicateOp = {
-    $any?: FilterPredicate[];
-    $all?: FilterPredicate[];
-    $none?: FilterPredicate | FilterPredicate[];
-    $not?: FilterPredicate | FilterPredicate[];
-    $is?: FilterValue | FilterValue[];
-    $isNot?: FilterValue | FilterValue[];
-    $lt?: FilterRangeValue;
-    $le?: FilterRangeValue;
-    $gt?: FilterRangeValue;
-    $ge?: FilterRangeValue;
-    $contains?: string;
-    $startsWith?: string;
-    $endsWith?: string;
-    $pattern?: string;
+type BoosterExpression = {
+    valueBooster?: ValueBooster$1;
+} | {
+    numericBooster?: NumericBooster$1;
+} | {
+    dateBooster?: DateBooster$1;
 };
 /**
- * @maxProperties 2
- * @minProperties 2
+ * Maximum [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance) for the search terms. The Levenshtein
+ * distance is the number of one character changes needed to make two strings equal. The default is 1, meaning that single
+ * character typos per word are tollerated by search. You can set it to 0 to remove the typo tollerance or set it to 2
+ * to allow two typos in a word.
+ *
+ * @default 1
+ * @maximum 2
+ * @minimum 0
  */
-type FilterPredicateRangeOp = {
-    $lt?: FilterRangeValue;
-    $le?: FilterRangeValue;
-    $gt?: FilterRangeValue;
-    $ge?: FilterRangeValue;
-};
-type FilterRangeValue = number | string;
-type FilterValue = number | string | boolean;
+type FuzzinessExpression = number;
 /**
- * Pagination settings.
+ * If the prefix type is set to "disabled" (the default), the search only matches full words. If the prefix type is set to "phrase", the search will return results that match prefixes of the search phrase.
  */
-type PageConfig = {
-    /**
-     * Query the next page that follow the cursor.
-     */
-    after?: string;
-    /**
-     * Query the previous page before the cursor.
-     */
-    before?: string;
-    /**
-     * Query the first page from the cursor.
-     */
-    start?: string;
-    /**
-     * Query the last page from the cursor.
-     */
-    end?: string;
+type PrefixExpression = 'phrase' | 'disabled';
+type HighlightExpression = {
     /**
-     * Set page size. If the size is missing it is read from the cursor. If no cursor is given Xata will choose the default page size.
-     *
-     * @default 20
+     * Set to `false` to disable highlighting. By default it is `true`.
      */
-    size?: number;
+    enabled?: boolean;
     /**
-     * Use offset to skip entries. To skip pages set offset to a multiple of size.
-     *
-     * @default 0
+     * Set to `false` to disable HTML encoding in highlight snippets. By default it is `true`.
      */
-    offset?: number;
+    encodeHTML?: boolean;
 };
 /**
  * Pagination settings for the search endpoints.
@@ -1687,218 +1691,232 @@ type SearchPageConfig = {
     offset?: number;
 };
 /**
- * @example name
- * @example email
- * @example created_at
+ * A summary expression is the description of a single summary operation. It consists of a single
+ * key representing the operation, and a value representing the column to be operated on.
+ *
+ * The column being summarized cannot be an internal column (id, xata.*), nor the base of
+ * an object, i.e. if `settings` is an object with `dark_mode` as a field, you may summarize
+ * `settings.dark_mode` but not `settings` nor `settings.*`.
+ *
+ * We currently support several aggregation functions. Not all functions can be run on all column
+ * types.
+ *
+ *   - `count` is used to count the number of records in each group. Use `{"count": "*"}` to count
+ *     all columns present, otherwise `{"count": "<column_path>"}` to count the number of non-null
+ *     values are present at column path.
+ *
+ *     Count can be used on any column type, and always returns an int.
+ *
+ *   - `min` calculates the minimum value in each group. `min` is compatible with most types;
+ *     string, multiple, text, email, int, float, and datetime. It returns a value of the same
+ *     type as operated on. This means that `{"lowest_latency": {"min": "latency"}}` where
+ *     `latency` is an int, will always return an int.
+ *
+ *   - `max` calculates the maximum value in each group. `max` shares the same compatibility as
+ *     `min`.
+ *
+ *   - `sum` adds up all values in a group. `sum` can be run on `int` and `float` types, and will
+ *     return a value of the same type as requested.
+ *
+ *   - `average` averages all values in a group. `average` can be run on `int` and `float` types, and
+ *     always returns a float.
+ *
+ * @example {"count":"deleted_at"}
+ * @x-go-type xbquery.Summary
  */
-type ColumnsProjection = string[];
+type SummaryExpression = Record<string, any>;
 /**
- * Xata Table Record Metadata
+ * The description of the summaries you wish to receive. Set each key to be the field name
+ * you'd like for the summary. These names must not collide with other columns you've
+ * requested from `columns`; including implicit requests like `settings.*`.
+ *
+ * The value for each key needs to be an object. This object should contain one key and one
+ * value only. In this object, the key should be set to the summary function you wish to use
+ * and the value set to the column name to be summarized.
+ *
+ * The column being summarized cannot be an internal column (id, xata.*), nor the base of
+ * an object, i.e. if `settings` is an object with `dark_mode` as a field, you may summarize
+ * `settings.dark_mode` but not `settings` nor `settings.*`.
+ *
+ * @example {"all_users":{"count":"*"},"total_created":{"count":"created_at"},"min_cost":{"min":"cost"},"max_happiness":{"max":"happiness"},"total_revenue":{"sum":"revenue"},"average_speed":{"average":"speed"}}
+ * @x-go-type xbquery.SummaryList
  */
-type RecordMeta = {
-    id: RecordID;
-    xata: {
-        /**
-         * The record's version. Can be used for optimistic concurrency control.
-         */
-        version: number;
-        /**
-         * The record's table name. APIs that return records from multiple tables will set this field accordingly.
-         */
-        table?: string;
-        /**
-         * Highlights of the record. This is used by the search APIs to indicate which fields and parts of the fields have matched the search.
-         */
-        highlight?: {
-            [key: string]: string[] | {
-                [key: string]: any;
-            };
-        };
-        /**
-         * The record's relevancy score. This is returned by the search APIs.
-         */
-        score?: number;
-        /**
-         * Encoding/Decoding errors
-         */
-        warnings?: string[];
-    };
+type SummaryExpressionList = {
+    [key: string]: SummaryExpression;
 };
 /**
- * @pattern [a-zA-Z0-9_-~:]+
+ * Count the number of records with an optional filter.
  */
-type RecordID = string;
+type CountAgg = {
+    filter?: FilterExpression;
+} | '*';
 /**
- * @example {"newName":"newName","oldName":"oldName"}
+ * The sum of the numeric values in a particular column.
  */
-type TableRename = {
-    /**
-     * @minLength 1
-     */
-    newName: string;
+type SumAgg = {
     /**
-     * @minLength 1
+     * The column on which to compute the sum. Must be a numeric type.
      */
-    oldName: string;
+    column: string;
 };
 /**
- * Records metadata
+ * The max of the numeric values in a particular column.
  */
-type RecordsMetadata = {
-    page: {
-        /**
-         * last record id
-         */
-        cursor: string;
-        /**
-         * true if more records can be fetch
-         */
-        more: boolean;
-    };
-};
-type AggResponse$1 = (number | null) | {
-    values: ({
-        $key: string | number;
-        $count: number;
-    } & {
-        [key: string]: AggResponse$1;
-    })[];
+type MaxAgg = {
+    /**
+     * The column on which to compute the max. Must be a numeric type.
+     */
+    column: string;
 };
 /**
- * A transaction operation
+ * The min of the numeric values in a particular column.
  */
-type TransactionOperation$1 = {
-    insert: TransactionInsertOp;
-} | {
-    update: TransactionUpdateOp;
-} | {
-    ['delete']: TransactionDeleteOp;
+type MinAgg = {
+    /**
+     * The column on which to compute the min. Must be a numeric type.
+     */
+    column: string;
 };
 /**
- * Insert operation
+ * The average of the numeric values in a particular column.
  */
-type TransactionInsertOp = {
-    /**
-     * The table name
-     */
-    table: string;
-    /**
-     * The record to insert. The `id` field is optional; when specified, it will be used as the ID for the record.
-     */
-    record: {
-        [key: string]: any;
-    };
-    /**
-     * The version of the record you expect to be overwriting. Only valid with an
-     * explicit ID is also set in the `record` key.
-     */
-    ifVersion?: number;
+type AverageAgg = {
     /**
-     * createOnly is used to change how Xata acts when an explicit ID is set in the `record` key.
-     *
-     * If `createOnly` is set to `true`, Xata will only attempt to insert the record. If there's a conflict, Xata
-     * will cancel the transaction.
-     *
-     * If `createOnly` is set to `false`, Xata will attempt to insert the record. If there's no
-     * conflict, the record is inserted. If there is a conflict, Xata will replace the record.
+     * The column on which to compute the average. Must be a numeric type.
      */
-    createOnly?: boolean;
+    column: string;
 };
 /**
- * Update operation
+ * Count the number of distinct values in a particular column.
  */
-type TransactionUpdateOp = {
-    /**
-     * The table name
-     */
-    table: string;
-    id: RecordID;
-    /**
-     * The fields of the record you'd like to update
-     */
-    fields: {
-        [key: string]: any;
-    };
+type UniqueCountAgg = {
     /**
-     * The version of the record you expect to be updating
+     * The column from where to count the unique values.
      */
-    ifVersion?: number;
+    column: string;
     /**
-     * Xata will insert this record if it cannot be found.
+     * The threshold under which the unique count is exact. If the number of unique
+     * values in the column is higher than this threshold, the results are approximative.
+     * Maximum value is 40,000, default value is 3000.
      */
-    upsert?: boolean;
+    precisionThreshold?: number;
 };
 /**
- * A delete operation. The transaction will continue if no record matches the ID.
+ * The description of the aggregations you wish to receive.
+ *
+ * @example {"totalCount":{"count":"*"},"dailyActiveUsers":{"dateHistogram":{"column":"date","interval":"1d","aggs":{"uniqueUsers":{"uniqueCount":{"column":"userID"}}}}}}
  */
-type TransactionDeleteOp = {
-    /**
-     * The table name
-     */
-    table: string;
-    id: RecordID;
+type AggExpressionMap = {
+    [key: string]: AggExpression;
 };
 /**
- * A result from an insert operation.
+ * Split data into buckets by a datetime column. Accepts sub-aggregations for each bucket.
  */
-type TransactionResultInsert = {
+type DateHistogramAgg = {
     /**
-     * The type of operation who's result is being returned.
+     * The column to use for bucketing. Must be of type datetime.
      */
-    operation: 'insert';
+    column: string;
     /**
-     * The number of affected rows
+     * The fixed interval to use when bucketing.
+     * It is fromatted as number + units, for example: `5d`, `20m`, `10s`.
+     *
+     * @pattern ^(\d+)(d|h|m|s|ms)$
      */
-    rows: number;
-    id: RecordID;
-};
-/**
- * A result from an update operation.
- */
-type TransactionResultUpdate = {
+    interval?: string;
     /**
-     * The type of operation who's result is being returned.
+     * The calendar-aware interval to use when bucketing. Possible values are: `minute`,
+     * `hour`, `day`, `week`, `month`, `quarter`, `year`.
      */
-    operation: 'update';
+    calendarInterval?: 'minute' | 'hour' | 'day' | 'week' | 'month' | 'quarter' | 'year';
     /**
-     * The number of updated rows
+     * The timezone to use for bucketing. By default, UTC is assumed.
+     * The accepted format is as an ISO 8601 UTC offset. For example: `+01:00` or
+     * `-08:00`.
+     *
+     * @pattern ^[+-][01]\d:[0-5]\d$
      */
-    rows: number;
-    id: RecordID;
+    timezone?: string;
+    aggs?: AggExpressionMap;
 };
 /**
- * A result from a delete operation.
+ * Split data into buckets by the unique values in a column. Accepts sub-aggregations for each bucket.
+ * The top values as ordered by the number of records (`$count`) are returned.
  */
-type TransactionResultDelete = {
+type TopValuesAgg = {
     /**
-     * The type of operation who's result is being returned.
+     * The column to use for bucketing. Accepted types are `string`, `email`, `int`, `float`, or `bool`.
      */
-    operation: 'delete';
+    column: string;
+    aggs?: AggExpressionMap;
     /**
-     * The number of deleted rows
+     * The maximum number of unique values to return.
+     *
+     * @default 10
+     * @maximum 1000
      */
-    rows: number;
+    size?: number;
 };
 /**
- * An error message from a failing transaction operation
- *
- * @x-go-type xata.ErrTxOp
+ * Split data into buckets by dynamic numeric ranges. Accepts sub-aggregations for each bucket.
  */
-type TransactionError = {
+type NumericHistogramAgg = {
     /**
-     * The index of the failing operation
+     * The column to use for bucketing. Must be of numeric type.
      */
-    index?: number;
+    column: string;
     /**
-     * The error message
+     * The numeric interval to use for bucketing. The resulting buckets will be ranges
+     * with this value as size.
+     *
+     * @minimum 0
      */
-    message: string;
+    interval: number;
+    /**
+     * By default the bucket keys start with 0 and then continue in `interval` steps. The bucket
+     * boundaries can be shiftend by using the offset option. For example, if the `interval` is 100,
+     * but you prefer the bucket boundaries to be `[50, 150), [150, 250), etc.`, you can set `offset`
+     * to 50.
+     *
+     * @default 0
+     */
+    offset?: number;
+    aggs?: AggExpressionMap;
 };
 /**
- * @format date-time
- * @x-go-type string
+ * The description of a single aggregation operation. It is an object with only one key-value pair.
+ * The key represents the aggregation type, while the value is an object with the configuration of
+ * the aggregation.
+ *
+ * @x-go-type xata.AggExpression
  */
-type DateTime = string;
+type AggExpression = {
+    count?: CountAgg;
+} | {
+    sum?: SumAgg;
+} | {
+    max?: MaxAgg;
+} | {
+    min?: MinAgg;
+} | {
+    average?: AverageAgg;
+} | {
+    uniqueCount?: UniqueCountAgg;
+} | {
+    dateHistogram?: DateHistogramAgg;
+} | {
+    topValues?: TopValuesAgg;
+} | {
+    numericHistogram?: NumericHistogramAgg;
+};
+type AggResponse$1 = (number | null) | {
+    values: ({
+        $key: string | number;
+        $count: number;
+    } & {
+        [key: string]: AggResponse$1;
+    })[];
+};
 /**
  * Xata Table Record Metadata
  */
@@ -1912,26 +1930,33 @@ type XataRecord$1 = RecordMeta & {
  * @version 1.0
  */
 
-type SimpleError = {
+type BadRequestError = {
     id?: string;
     message: string;
 };
-type BulkError = {
-    errors: {
-        message?: string;
-        status?: number;
-    }[];
+/**
+ * @example {"message":"invalid API key"}
+ */
+type AuthError = {
+    id?: string;
+    message: string;
 };
-type BulkInsertResponse = {
-    recordIDs: string[];
-} | {
-    records: XataRecord$1[];
+type SimpleError = {
+    id?: string;
+    message: string;
 };
 type BranchMigrationPlan = {
     version: number;
     migration: BranchMigration;
 };
-type RecordResponse = XataRecord$1;
+type SchemaUpdateResponse = {
+    /**
+     * @minLength 1
+     */
+    migrationID: string;
+    parentMigrationID: string;
+    status: MigrationStatus;
+};
 type SchemaCompareResponse = {
     source: Schema;
     target: Schema;
@@ -1943,62 +1968,37 @@ type RecordUpdateResponse = XataRecord$1 | {
         version: number;
     };
 };
+type RecordResponse = XataRecord$1;
+type BulkInsertResponse = {
+    recordIDs: string[];
+} | {
+    records: XataRecord$1[];
+};
+type BulkError = {
+    errors: {
+        message?: string;
+        status?: number;
+    }[];
+};
 type QueryResponse = {
     records: XataRecord$1[];
     meta: RecordsMetadata;
 };
-type SchemaUpdateResponse = {
-    /**
-     * @minLength 1
-     */
-    migrationID: string;
-    parentMigrationID: string;
-    status: MigrationStatus;
+type SearchResponse = {
+    records: XataRecord$1[];
+    warning?: string;
 };
 type SummarizeResponse = {
     summaries: Record<string, any>[];
 };
 /**
- * @example {"aggs":{"dailyUniqueUsers":{"values":[{"key":"2022-02-22T22:22:22Z","uniqueUsers":134},{"key":"2022-02-23T22:22:22Z","uniqueUsers":90}]}}}
+ * @example {"aggs":{"dailyUniqueUsers":{"values":[{"$count":321,"$key":"2022-02-22T22:22:22Z","uniqueUsers":134},{"$count":202,"$key":"2022-02-23T22:22:22Z","uniqueUsers":90}]}}}
  */
 type AggResponse = {
     aggs?: {
         [key: string]: AggResponse$1;
     };
 };
-type SearchResponse = {
-    records: XataRecord$1[];
-    warning?: string;
-};
-/**
- * @x-go-type TxSuccess
- */
-type TransactionSuccess = {
-    /**
-     * An ordered array of results from the submitted operations that were executed
-     */
-    results: (TransactionResultInsert | TransactionResultUpdate | TransactionResultDelete)[];
-};
-/**
- * @x-go-type TxFailure
- */
-type TransactionFailure = {
-    /**
-     * An array of errors from the submitted operations.
-     */
-    errors: TransactionError[];
-};
-type BadRequestError = {
-    id?: string;
-    message: string;
-};
-/**
- * @example {"message":"invalid API key"}
- */
-type AuthError = {
-    id?: string;
-    message: string;
-};
 
 type DataPlaneFetcherExtraProps = {
     apiUrl: string;
@@ -2092,6 +2092,9 @@ type CreateBranchError = ErrorWrapper<{
 } | {
     status: 404;
     payload: SimpleError;
+} | {
+    status: 423;
+    payload: SimpleError;
 }>;
 type CreateBranchResponse = {
     /**
@@ -2131,6 +2134,9 @@ type DeleteBranchError = ErrorWrapper<{
 } | {
     status: 404;
     payload: SimpleError;
+} | {
+    status: 409;
+    payload: SimpleError;
 }>;
 type DeleteBranchResponse = {
     status: MigrationStatus;
@@ -2504,32 +2510,6 @@ type ExecuteBranchMigrationPlanVariables = {
  * Apply a migration plan to the branch
  */
 declare const executeBranchMigrationPlan: (variables: ExecuteBranchMigrationPlanVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
-type BranchTransactionPathParams = {
-    /**
-     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
-     */
-    dbBranchName: DBBranchName;
-    workspace: string;
-    region: string;
-};
-type BranchTransactionError = ErrorWrapper<{
-    status: 400;
-    payload: TransactionFailure;
-} | {
-    status: 401;
-    payload: AuthError;
-} | {
-    status: 404;
-    payload: SimpleError;
-}>;
-type BranchTransactionRequestBody = {
-    operations: TransactionOperation$1[];
-};
-type BranchTransactionVariables = {
-    body: BranchTransactionRequestBody;
-    pathParams: BranchTransactionPathParams;
-} & DataPlaneFetcherExtraProps;
-declare const branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal) => Promise<TransactionSuccess>;
 type QueryMigrationRequestsPathParams = {
     /**
      * The Database Name
@@ -3089,6 +3069,9 @@ type UpdateTableError = ErrorWrapper<{
 } | {
     status: 404;
     payload: SimpleError;
+} | {
+    status: 422;
+    payload: SimpleError;
 }>;
 type UpdateTableRequestBody = {
     /**
@@ -3347,6 +3330,32 @@ type DeleteColumnVariables = {
  * Deletes the specified column. To refer to sub-objects, the column name can contain dots. For example `address.country`.
  */
 declare const deleteColumn: (variables: DeleteColumnVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
+type BranchTransactionPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
+    dbBranchName: DBBranchName;
+    workspace: string;
+    region: string;
+};
+type BranchTransactionError = ErrorWrapper<{
+    status: 400;
+    payload: TransactionFailure;
+} | {
+    status: 401;
+    payload: AuthError;
+} | {
+    status: 404;
+    payload: SimpleError;
+}>;
+type BranchTransactionRequestBody = {
+    operations: TransactionOperation$1[];
+};
+type BranchTransactionVariables = {
+    body: BranchTransactionRequestBody;
+    pathParams: BranchTransactionPathParams;
+} & DataPlaneFetcherExtraProps;
+declare const branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal) => Promise<TransactionSuccess>;
 type InsertRecordPathParams = {
     /**
      * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
@@ -4801,245 +4810,245 @@ declare function parseWorkspacesUrlParts(url: string): {
     region: string;
 } | null;
 
+type responses_AggResponse = AggResponse;
 type responses_AuthError = AuthError;
 type responses_BadRequestError = BadRequestError;
-type responses_SimpleError = SimpleError;
+type responses_BranchMigrationPlan = BranchMigrationPlan;
 type responses_BulkError = BulkError;
 type responses_BulkInsertResponse = BulkInsertResponse;
-type responses_BranchMigrationPlan = BranchMigrationPlan;
+type responses_QueryResponse = QueryResponse;
 type responses_RecordResponse = RecordResponse;
-type responses_SchemaCompareResponse = SchemaCompareResponse;
 type responses_RecordUpdateResponse = RecordUpdateResponse;
-type responses_QueryResponse = QueryResponse;
+type responses_SchemaCompareResponse = SchemaCompareResponse;
 type responses_SchemaUpdateResponse = SchemaUpdateResponse;
-type responses_SummarizeResponse = SummarizeResponse;
-type responses_AggResponse = AggResponse;
 type responses_SearchResponse = SearchResponse;
-type responses_TransactionSuccess = TransactionSuccess;
-type responses_TransactionFailure = TransactionFailure;
+type responses_SimpleError = SimpleError;
+type responses_SummarizeResponse = SummarizeResponse;
 declare namespace responses {
   export {
+    responses_AggResponse as AggResponse,
     responses_AuthError as AuthError,
     responses_BadRequestError as BadRequestError,
-    responses_SimpleError as SimpleError,
+    responses_BranchMigrationPlan as BranchMigrationPlan,
     responses_BulkError as BulkError,
     responses_BulkInsertResponse as BulkInsertResponse,
-    responses_BranchMigrationPlan as BranchMigrationPlan,
+    responses_QueryResponse as QueryResponse,
     responses_RecordResponse as RecordResponse,
-    responses_SchemaCompareResponse as SchemaCompareResponse,
     responses_RecordUpdateResponse as RecordUpdateResponse,
-    responses_QueryResponse as QueryResponse,
+    responses_SchemaCompareResponse as SchemaCompareResponse,
     responses_SchemaUpdateResponse as SchemaUpdateResponse,
-    responses_SummarizeResponse as SummarizeResponse,
-    responses_AggResponse as AggResponse,
     responses_SearchResponse as SearchResponse,
-    responses_TransactionSuccess as TransactionSuccess,
-    responses_TransactionFailure as TransactionFailure,
+    responses_SimpleError as SimpleError,
+    responses_SummarizeResponse as SummarizeResponse,
   };
 }
 
+type schemas_APIKeyName = APIKeyName;
+type schemas_AggExpression = AggExpression;
+type schemas_AggExpressionMap = AggExpressionMap;
+type schemas_AverageAgg = AverageAgg;
+type schemas_BoosterExpression = BoosterExpression;
+type schemas_Branch = Branch;
 type schemas_BranchMetadata = BranchMetadata;
+type schemas_BranchMigration = BranchMigration;
 type schemas_BranchName = BranchName;
-type schemas_DBName = DBName;
-type schemas_DateTime = DateTime;
-type schemas_MigrationStatus = MigrationStatus;
-type schemas_ListBranchesResponse = ListBranchesResponse;
-type schemas_ListGitBranchesResponse = ListGitBranchesResponse;
-type schemas_Branch = Branch;
-type schemas_DBBranch = DBBranch;
-type schemas_StartedFromMetadata = StartedFromMetadata;
-type schemas_Schema = Schema;
-type schemas_SchemaEditScript = SchemaEditScript;
-type schemas_Table = Table;
 type schemas_Column = Column;
 type schemas_ColumnLink = ColumnLink;
-type schemas_RevLink = RevLink;
-type schemas_DBBranchName = DBBranchName;
-type schemas_TableName = TableName;
-type schemas_ColumnName = ColumnName;
-type schemas_MetricsDatapoint = MetricsDatapoint;
-type schemas_MetricsLatency = MetricsLatency;
-type schemas_BranchMigration = BranchMigration;
-type schemas_TableMigration = TableMigration;
 type schemas_ColumnMigration = ColumnMigration;
-type schemas_Commit = Commit;
-type schemas_Migration = Migration;
-type schemas_MigrationOp = MigrationOp;
-type schemas_MigrationTableOp = MigrationTableOp;
-type schemas_MigrationColumnOp = MigrationColumnOp;
-type schemas_TableOpAdd = TableOpAdd;
-type schemas_TableOpRemove = TableOpRemove;
-type schemas_TableOpRename = TableOpRename;
+type schemas_ColumnName = ColumnName;
 type schemas_ColumnOpAdd = ColumnOpAdd;
 type schemas_ColumnOpRemove = ColumnOpRemove;
 type schemas_ColumnOpRename = ColumnOpRename;
-type schemas_MigrationRequestNumber = MigrationRequestNumber;
-type schemas_MigrationRequest = MigrationRequest;
-type schemas_SortExpression = SortExpression;
-type schemas_SortOrder = SortOrder;
-type schemas_FuzzinessExpression = FuzzinessExpression;
-type schemas_PrefixExpression = PrefixExpression;
-type schemas_TargetExpression = TargetExpression;
-type schemas_FilterExpression = FilterExpression;
-type schemas_SummaryExpressionList = SummaryExpressionList;
-type schemas_SummaryExpression = SummaryExpression;
-type schemas_AggExpressionMap = AggExpressionMap;
-type schemas_AggExpression = AggExpression;
+type schemas_ColumnsProjection = ColumnsProjection;
+type schemas_Commit = Commit;
 type schemas_CountAgg = CountAgg;
-type schemas_SumAgg = SumAgg;
-type schemas_MaxAgg = MaxAgg;
-type schemas_MinAgg = MinAgg;
-type schemas_AverageAgg = AverageAgg;
-type schemas_UniqueCountAgg = UniqueCountAgg;
+type schemas_DBBranch = DBBranch;
+type schemas_DBBranchName = DBBranchName;
+type schemas_DBName = DBName;
+type schemas_DatabaseMetadata = DatabaseMetadata;
 type schemas_DateHistogramAgg = DateHistogramAgg;
-type schemas_TopValuesAgg = TopValuesAgg;
-type schemas_NumericHistogramAgg = NumericHistogramAgg;
-type schemas_HighlightExpression = HighlightExpression;
-type schemas_BoosterExpression = BoosterExpression;
-type schemas_FilterList = FilterList;
+type schemas_DateTime = DateTime;
 type schemas_FilterColumn = FilterColumn;
 type schemas_FilterColumnIncludes = FilterColumnIncludes;
+type schemas_FilterExpression = FilterExpression;
+type schemas_FilterList = FilterList;
 type schemas_FilterPredicate = FilterPredicate;
 type schemas_FilterPredicateOp = FilterPredicateOp;
 type schemas_FilterPredicateRangeOp = FilterPredicateRangeOp;
 type schemas_FilterRangeValue = FilterRangeValue;
 type schemas_FilterValue = FilterValue;
+type schemas_FuzzinessExpression = FuzzinessExpression;
+type schemas_HighlightExpression = HighlightExpression;
+type schemas_InviteID = InviteID;
+type schemas_InviteKey = InviteKey;
+type schemas_ListBranchesResponse = ListBranchesResponse;
+type schemas_ListDatabasesResponse = ListDatabasesResponse;
+type schemas_ListGitBranchesResponse = ListGitBranchesResponse;
+type schemas_ListRegionsResponse = ListRegionsResponse;
+type schemas_MaxAgg = MaxAgg;
+type schemas_MetricsDatapoint = MetricsDatapoint;
+type schemas_MetricsLatency = MetricsLatency;
+type schemas_Migration = Migration;
+type schemas_MigrationColumnOp = MigrationColumnOp;
+type schemas_MigrationOp = MigrationOp;
+type schemas_MigrationRequest = MigrationRequest;
+type schemas_MigrationRequestNumber = MigrationRequestNumber;
+type schemas_MigrationStatus = MigrationStatus;
+type schemas_MigrationTableOp = MigrationTableOp;
+type schemas_MinAgg = MinAgg;
+type schemas_NumericHistogramAgg = NumericHistogramAgg;
 type schemas_PageConfig = PageConfig;
-type schemas_SearchPageConfig = SearchPageConfig;
-type schemas_ColumnsProjection = ColumnsProjection;
-type schemas_RecordMeta = RecordMeta;
+type schemas_PrefixExpression = PrefixExpression;
 type schemas_RecordID = RecordID;
-type schemas_TableRename = TableRename;
+type schemas_RecordMeta = RecordMeta;
 type schemas_RecordsMetadata = RecordsMetadata;
-type schemas_TransactionInsertOp = TransactionInsertOp;
-type schemas_TransactionUpdateOp = TransactionUpdateOp;
+type schemas_Region = Region;
+type schemas_RevLink = RevLink;
+type schemas_Role = Role;
+type schemas_Schema = Schema;
+type schemas_SchemaEditScript = SchemaEditScript;
+type schemas_SearchPageConfig = SearchPageConfig;
+type schemas_SortExpression = SortExpression;
+type schemas_SortOrder = SortOrder;
+type schemas_StartedFromMetadata = StartedFromMetadata;
+type schemas_SumAgg = SumAgg;
+type schemas_SummaryExpression = SummaryExpression;
+type schemas_SummaryExpressionList = SummaryExpressionList;
+type schemas_Table = Table;
+type schemas_TableMigration = TableMigration;
+type schemas_TableName = TableName;
+type schemas_TableOpAdd = TableOpAdd;
+type schemas_TableOpRemove = TableOpRemove;
+type schemas_TableOpRename = TableOpRename;
+type schemas_TableRename = TableRename;
+type schemas_TargetExpression = TargetExpression;
+type schemas_TopValuesAgg = TopValuesAgg;
 type schemas_TransactionDeleteOp = TransactionDeleteOp;
+type schemas_TransactionError = TransactionError;
+type schemas_TransactionFailure = TransactionFailure;
+type schemas_TransactionInsertOp = TransactionInsertOp;
+type schemas_TransactionResultDelete = TransactionResultDelete;
 type schemas_TransactionResultInsert = TransactionResultInsert;
 type schemas_TransactionResultUpdate = TransactionResultUpdate;
-type schemas_TransactionResultDelete = TransactionResultDelete;
-type schemas_TransactionError = TransactionError;
+type schemas_TransactionSuccess = TransactionSuccess;
+type schemas_TransactionUpdateOp = TransactionUpdateOp;
+type schemas_UniqueCountAgg = UniqueCountAgg;
 type schemas_User = User;
 type schemas_UserID = UserID;
 type schemas_UserWithID = UserWithID;
-type schemas_APIKeyName = APIKeyName;
-type schemas_WorkspaceID = WorkspaceID;
-type schemas_Role = Role;
-type schemas_WorkspaceMeta = WorkspaceMeta;
 type schemas_Workspace = Workspace;
-type schemas_WorkspaceMember = WorkspaceMember;
-type schemas_InviteID = InviteID;
+type schemas_WorkspaceID = WorkspaceID;
 type schemas_WorkspaceInvite = WorkspaceInvite;
+type schemas_WorkspaceMember = WorkspaceMember;
 type schemas_WorkspaceMembers = WorkspaceMembers;
-type schemas_InviteKey = InviteKey;
-type schemas_DatabaseMetadata = DatabaseMetadata;
-type schemas_ListDatabasesResponse = ListDatabasesResponse;
-type schemas_ListRegionsResponse = ListRegionsResponse;
-type schemas_Region = Region;
+type schemas_WorkspaceMeta = WorkspaceMeta;
 declare namespace schemas {
   export {
+    schemas_APIKeyName as APIKeyName,
+    schemas_AggExpression as AggExpression,
+    schemas_AggExpressionMap as AggExpressionMap,
+    AggResponse$1 as AggResponse,
+    schemas_AverageAgg as AverageAgg,
+    schemas_BoosterExpression as BoosterExpression,
+    schemas_Branch as Branch,
     schemas_BranchMetadata as BranchMetadata,
+    schemas_BranchMigration as BranchMigration,
     schemas_BranchName as BranchName,
-    schemas_DBName as DBName,
-    schemas_DateTime as DateTime,
-    schemas_MigrationStatus as MigrationStatus,
-    schemas_ListBranchesResponse as ListBranchesResponse,
-    schemas_ListGitBranchesResponse as ListGitBranchesResponse,
-    schemas_Branch as Branch,
-    schemas_DBBranch as DBBranch,
-    schemas_StartedFromMetadata as StartedFromMetadata,
-    schemas_Schema as Schema,
-    schemas_SchemaEditScript as SchemaEditScript,
-    schemas_Table as Table,
     schemas_Column as Column,
     schemas_ColumnLink as ColumnLink,
-    schemas_RevLink as RevLink,
-    schemas_DBBranchName as DBBranchName,
-    schemas_TableName as TableName,
-    schemas_ColumnName as ColumnName,
-    schemas_MetricsDatapoint as MetricsDatapoint,
-    schemas_MetricsLatency as MetricsLatency,
-    schemas_BranchMigration as BranchMigration,
-    schemas_TableMigration as TableMigration,
     schemas_ColumnMigration as ColumnMigration,
-    schemas_Commit as Commit,
-    schemas_Migration as Migration,
-    schemas_MigrationOp as MigrationOp,
-    schemas_MigrationTableOp as MigrationTableOp,
-    schemas_MigrationColumnOp as MigrationColumnOp,
-    schemas_TableOpAdd as TableOpAdd,
-    schemas_TableOpRemove as TableOpRemove,
-    schemas_TableOpRename as TableOpRename,
+    schemas_ColumnName as ColumnName,
     schemas_ColumnOpAdd as ColumnOpAdd,
     schemas_ColumnOpRemove as ColumnOpRemove,
     schemas_ColumnOpRename as ColumnOpRename,
-    schemas_MigrationRequestNumber as MigrationRequestNumber,
-    schemas_MigrationRequest as MigrationRequest,
-    schemas_SortExpression as SortExpression,
-    schemas_SortOrder as SortOrder,
-    schemas_FuzzinessExpression as FuzzinessExpression,
-    schemas_PrefixExpression as PrefixExpression,
-    schemas_TargetExpression as TargetExpression,
-    schemas_FilterExpression as FilterExpression,
-    schemas_SummaryExpressionList as SummaryExpressionList,
-    schemas_SummaryExpression as SummaryExpression,
-    schemas_AggExpressionMap as AggExpressionMap,
-    schemas_AggExpression as AggExpression,
+    schemas_ColumnsProjection as ColumnsProjection,
+    schemas_Commit as Commit,
     schemas_CountAgg as CountAgg,
-    schemas_SumAgg as SumAgg,
-    schemas_MaxAgg as MaxAgg,
-    schemas_MinAgg as MinAgg,
-    schemas_AverageAgg as AverageAgg,
-    schemas_UniqueCountAgg as UniqueCountAgg,
-    schemas_DateHistogramAgg as DateHistogramAgg,
-    schemas_TopValuesAgg as TopValuesAgg,
-    schemas_NumericHistogramAgg as NumericHistogramAgg,
-    schemas_HighlightExpression as HighlightExpression,
-    schemas_BoosterExpression as BoosterExpression,
-    ValueBooster$1 as ValueBooster,
-    NumericBooster$1 as NumericBooster,
+    schemas_DBBranch as DBBranch,
+    schemas_DBBranchName as DBBranchName,
+    schemas_DBName as DBName,
+    schemas_DatabaseMetadata as DatabaseMetadata,
     DateBooster$1 as DateBooster,
-    schemas_FilterList as FilterList,
+    schemas_DateHistogramAgg as DateHistogramAgg,
+    schemas_DateTime as DateTime,
     schemas_FilterColumn as FilterColumn,
     schemas_FilterColumnIncludes as FilterColumnIncludes,
+    schemas_FilterExpression as FilterExpression,
+    schemas_FilterList as FilterList,
     schemas_FilterPredicate as FilterPredicate,
     schemas_FilterPredicateOp as FilterPredicateOp,
     schemas_FilterPredicateRangeOp as FilterPredicateRangeOp,
     schemas_FilterRangeValue as FilterRangeValue,
     schemas_FilterValue as FilterValue,
+    schemas_FuzzinessExpression as FuzzinessExpression,
+    schemas_HighlightExpression as HighlightExpression,
+    schemas_InviteID as InviteID,
+    schemas_InviteKey as InviteKey,
+    schemas_ListBranchesResponse as ListBranchesResponse,
+    schemas_ListDatabasesResponse as ListDatabasesResponse,
+    schemas_ListGitBranchesResponse as ListGitBranchesResponse,
+    schemas_ListRegionsResponse as ListRegionsResponse,
+    schemas_MaxAgg as MaxAgg,
+    schemas_MetricsDatapoint as MetricsDatapoint,
+    schemas_MetricsLatency as MetricsLatency,
+    schemas_Migration as Migration,
+    schemas_MigrationColumnOp as MigrationColumnOp,
+    schemas_MigrationOp as MigrationOp,
+    schemas_MigrationRequest as MigrationRequest,
+    schemas_MigrationRequestNumber as MigrationRequestNumber,
+    schemas_MigrationStatus as MigrationStatus,
+    schemas_MigrationTableOp as MigrationTableOp,
+    schemas_MinAgg as MinAgg,
+    NumericBooster$1 as NumericBooster,
+    schemas_NumericHistogramAgg as NumericHistogramAgg,
     schemas_PageConfig as PageConfig,
-    schemas_SearchPageConfig as SearchPageConfig,
-    schemas_ColumnsProjection as ColumnsProjection,
-    schemas_RecordMeta as RecordMeta,
+    schemas_PrefixExpression as PrefixExpression,
     schemas_RecordID as RecordID,
-    schemas_TableRename as TableRename,
+    schemas_RecordMeta as RecordMeta,
     schemas_RecordsMetadata as RecordsMetadata,
-    AggResponse$1 as AggResponse,
-    TransactionOperation$1 as TransactionOperation,
-    schemas_TransactionInsertOp as TransactionInsertOp,
-    schemas_TransactionUpdateOp as TransactionUpdateOp,
+    schemas_Region as Region,
+    schemas_RevLink as RevLink,
+    schemas_Role as Role,
+    schemas_Schema as Schema,
+    schemas_SchemaEditScript as SchemaEditScript,
+    schemas_SearchPageConfig as SearchPageConfig,
+    schemas_SortExpression as SortExpression,
+    schemas_SortOrder as SortOrder,
+    schemas_StartedFromMetadata as StartedFromMetadata,
+    schemas_SumAgg as SumAgg,
+    schemas_SummaryExpression as SummaryExpression,
+    schemas_SummaryExpressionList as SummaryExpressionList,
+    schemas_Table as Table,
+    schemas_TableMigration as TableMigration,
+    schemas_TableName as TableName,
+    schemas_TableOpAdd as TableOpAdd,
+    schemas_TableOpRemove as TableOpRemove,
+    schemas_TableOpRename as TableOpRename,
+    schemas_TableRename as TableRename,
+    schemas_TargetExpression as TargetExpression,
+    schemas_TopValuesAgg as TopValuesAgg,
     schemas_TransactionDeleteOp as TransactionDeleteOp,
+    schemas_TransactionError as TransactionError,
+    schemas_TransactionFailure as TransactionFailure,
+    schemas_TransactionInsertOp as TransactionInsertOp,
+    TransactionOperation$1 as TransactionOperation,
+    schemas_TransactionResultDelete as TransactionResultDelete,
     schemas_TransactionResultInsert as TransactionResultInsert,
     schemas_TransactionResultUpdate as TransactionResultUpdate,
-    schemas_TransactionResultDelete as TransactionResultDelete,
-    schemas_TransactionError as TransactionError,
-    XataRecord$1 as XataRecord,
+    schemas_TransactionSuccess as TransactionSuccess,
+    schemas_TransactionUpdateOp as TransactionUpdateOp,
+    schemas_UniqueCountAgg as UniqueCountAgg,
     schemas_User as User,
     schemas_UserID as UserID,
     schemas_UserWithID as UserWithID,
-    schemas_APIKeyName as APIKeyName,
-    schemas_WorkspaceID as WorkspaceID,
-    schemas_Role as Role,
-    schemas_WorkspaceMeta as WorkspaceMeta,
+    ValueBooster$1 as ValueBooster,
     schemas_Workspace as Workspace,
-    schemas_WorkspaceMember as WorkspaceMember,
-    schemas_InviteID as InviteID,
+    schemas_WorkspaceID as WorkspaceID,
     schemas_WorkspaceInvite as WorkspaceInvite,
+    schemas_WorkspaceMember as WorkspaceMember,
     schemas_WorkspaceMembers as WorkspaceMembers,
-    schemas_InviteKey as InviteKey,
-    schemas_DatabaseMetadata as DatabaseMetadata,
-    schemas_ListDatabasesResponse as ListDatabasesResponse,
-    schemas_ListRegionsResponse as ListRegionsResponse,
-    schemas_Region as Region,
+    schemas_WorkspaceMeta as WorkspaceMeta,
+    XataRecord$1 as XataRecord,
   };
 }
 
@@ -5663,7 +5672,7 @@ type SelectedPick<O extends XataRecord, Key extends SelectableColumn<O>[]> = Xat
 type ValueAtColumn<O, P extends SelectableColumn<O>> = P extends '*' ? Values<O> : P extends 'id' ? string : P extends keyof O ? O[P] : P extends `${infer K}.${infer V}` ? K extends keyof O ? Values<NonNullable<O[K]> extends infer Item ? Item extends Record<string, any> ? V extends SelectableColumn<Item> ? {
     V: ValueAtColumn<Item, V>;
 } : never : O[K] : never> : never : never;
-type MAX_RECURSION = 5;
+type MAX_RECURSION = 2;
 type NestedColumns<O, RecursivePath extends any[]> = RecursivePath['length'] extends MAX_RECURSION ? never : If<IsObject<O>, Values<{
     [K in DataProps<O>]: NonNullable<O[K]> extends infer Item ? If<IsArray<Item>, K, // If the property is an array, we stop recursion. We don't support object arrays yet
     If<IsObject<Item>, Item extends XataRecord ? SelectableColumn<Item, [...RecursivePath, Item]> extends infer Column ? Column extends string ? K | `${K}.${Column}` : never : never : Item extends Date ? K : `${K}.${StringKeys<Item> | '*'}`, // This allows usage of objects that are not links
@@ -5699,6 +5708,14 @@ interface XataRecord<OriginalRecord extends XataRecord<any> = XataRecord<any>> e
      * Get metadata of this record.
      */
     getMetadata(): XataRecordMetadata;
+    /**
+     * Get an object representation of this record.
+     */
+    toSerializable(): JSONData<OriginalRecord>;
+    /**
+     * Get a string representation of this record.
+     */
+    toString(): string;
     /**
      * Retrieves a refreshed copy of the current record from the database.
      * @param columns The columns to retrieve. If not specified, all first level properties are retrieved.
@@ -5779,6 +5796,10 @@ type EditableDataFields<T> = T extends XataRecord ? {
 type EditableData<O extends XataRecord> = Identifiable & Partial<Omit<{
     [K in keyof O]: EditableDataFields<O[K]>;
 }, keyof XataRecord>>;
+type JSONDataFields<T> = T extends XataRecord ? string : NonNullable<T> extends XataRecord ? string | null | undefined : T extends Date ? string : NonNullable<T> extends Date ? string | null | undefined : T;
+type JSONData<O> = Identifiable & Partial<Omit<{
+    [K in keyof O]: JSONDataFields<O[K]>;
+}, keyof XataRecord>>;
 
 /**
  * PropertyMatchFilter
@@ -6579,6 +6600,8 @@ declare class RecordArray<Result extends XataRecord> extends Array<Result> {
     constructor(page: Paginable<any, Result>, overrideRecords?: Result[]);
     static parseConstructorParams(...args: any[]): any[];
     toArray(): Result[];
+    toSerializable(): JSONData<Result>[];
+    toString(): string;
     map<U>(callbackfn: (value: Result, index: number, array: Result[]) => U, thisArg?: any): U[];
     /**
      * Retrieve next page of records