@xata.io/client 0.18.0 → 0.18.2

package/dist/index.d.ts

@@ -68,6 +68,9 @@ declare type XataPluginOptions = {
  * @version 1.0
  */
 declare type User = {
+    /**
+     * @format email
+     */
     email: string;
     fullname: string;
     image: string;
@@ -109,6 +112,9 @@ declare type Workspace = WorkspaceMeta & {
 declare type WorkspaceMember = {
     userId: UserID;
     fullname: string;
+    /**
+     * @format email
+     */
     email: string;
     role: Role;
 };
@@ -118,7 +124,13 @@ declare type WorkspaceMember = {
 declare type InviteID = string;
 declare type WorkspaceInvite = {
     inviteId: InviteID;
+    /**
+     * @format email
+     */
     email: string;
+    /**
+     * @format date-time
+     */
     expires: string;
     role: Role;
 };
@@ -134,14 +146,32 @@ declare type InviteKey = string;
  * Metadata of databases
  */
 declare type DatabaseMetadata = {
+    /**
+     * The machine-readable name of a database
+     */
     name: string;
+    /**
+     * The time this database was created
+     */
     createdAt: DateTime;
+    /**
+     * The number of branches the database has
+     */
     numberOfBranches: number;
+    /**
+     * Metadata about the database for display in Xata user interfaces
+     */
     ui?: {
+        /**
+         * The user-selected color for this database across interfaces
+         */
         color?: string;
     };
 };
 declare type ListDatabasesResponse = {
+    /**
+     * A list of databases in a Xata workspace
+     */
     databases?: DatabaseMetadata[];
 };
 declare type ListBranchesResponse = {
@@ -163,8 +193,14 @@ declare type Branch = {
  * @x-go-type xata.BranchMetadata
  */
 declare type BranchMetadata = {
+    /**
+     * @minLength 1
+     */
     repository?: string;
     branch?: BranchName;
+    /**
+     * @minLength 1
+     */
     stage?: string;
     labels?: string[];
 };
@@ -383,15 +419,42 @@ declare type ColumnOpRename = {
     newName: string;
 };
 declare type MigrationRequest = {
+    /**
+     * The migration request number.
+     */
     number: number;
+    /**
+     * Migration request creation timestamp.
+     */
     createdAt: DateTime;
+    /**
+     * Last modified timestamp.
+     */
     modifiedAt?: DateTime;
+    /**
+     * Timestamp when the migration request was closed.
+     */
     closedAt?: DateTime;
+    /**
+     * Timestamp when the migration request was merged.
+     */
     mergedAt?: DateTime;
     status: 'open' | 'closed' | 'merging' | 'merged';
+    /**
+     * The migration request title.
+     */
     title: string;
+    /**
+     * The migration request body with detailed description.
+     */
     body: string;
+    /**
+     * Name of the source branch.
+     */
     source: string;
+    /**
+     * Name of the target branch.
+     */
     target: string;
 };
 declare type SortExpression = string[] | {
@@ -415,6 +478,23 @@ declare type FuzzinessExpression = number;
  * 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.
  */
 declare type PrefixExpression = 'phrase' | 'disabled';
+/**
+ * The target expression is used to filter the search results by the target columns.
+ */
+declare type TargetExpression = (string | {
+    /**
+     * The name of the column.
+     */
+    column: string;
+    /**
+     * The weight of the column.
+     *
+     * @default 1
+     * @maximum 10
+     * @minimum 1
+     */
+    weight?: number;
+})[];
 /**
  * @minProperties 1
  */
@@ -429,23 +509,51 @@ declare type FilterExpression = {
     [key: string]: FilterColumn;
 };
 /**
- * The full summary expression; the entire expression is a map of names to requests.
+ * 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"}}
  * @x-go-type xbquery.SummaryList
  */
 declare type SummaryExpressionList = {
     [key: string]: SummaryExpression;
 };
 /**
- * A single summary expression. The key represents an aggregation function; the value a column to aggregate.
+ * 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.*`.
  *
- * You may only call one aggregation per key.
+ * We currently support the `count` operation. When using `count`, one can set a column name
+ * as the value. Xata will return the total number times this column is non-null in each group.
  *
+ * Alternately, if you'd like to count the total rows in each group - irregardless of null/not null
+ * status - you can set `count` to `*` to count everything.
+ *
+ * @example {"count":"deleted_at"}
  * @x-go-type xbquery.Summary
  */
 declare type SummaryExpression = Record<string, any>;
 declare 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;
 };
 /**
@@ -464,15 +572,30 @@ declare type BoosterExpression = {
  * Boost records with a particular value for a column.
  */
 declare 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;
 };
 /**
  * Boost records based on the value of a numeric column.
  */
 declare type NumericBooster$1 = {
+    /**
+     * The column in which to look for the value.
+     */
     column: string;
+    /**
+     * The factor with which to multiply the value of the column before adding it to the item score.
+     */
     factor: number;
 };
 /**
@@ -481,9 +604,24 @@ declare type NumericBooster$1 = {
  * should be interpreted as: a record with a date 10 days before/after origin will score 2 times less than a record with the date at origin.
  */
 declare type DateBooster$1 = {
+    /**
+     * The column in which to look for the value.
+     */
     column: string;
+    /**
+     * The datetime (formatted as RFC3339) from where to apply the score decay function. The maximum boost will be applied for records with values at this time.
+     * If it is not specified, the current date and time is used.
+     */
     origin?: string;
+    /**
+     * The duration at which distance from origin the score is decayed with factor, using an exponential function. It is fromatted as number + units, for example: `5d`, `20m`, `10s`.
+     *
+     * @pattern ^(\d+)(d|h|m|s|ms)$
+     */
     scale: string;
+    /**
+     * The decay factor to expect at "scale" distance from the "origin".
+     */
     decay: number;
 };
 declare type FilterList = FilterExpression | FilterExpression[];
@@ -535,13 +673,40 @@ declare type FilterValue = number | string | boolean;
  * Pagination settings.
  */
 declare 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.
+     */
     first?: string;
+    /**
+     * Query the last page from the cursor.
+     */
     last?: 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
+ */
 declare type ColumnsProjection = string[];
 /**
  * Xata Table Record Metadata
@@ -549,14 +714,29 @@ declare type ColumnsProjection = string[];
 declare 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[];
     };
 };
@@ -568,7 +748,13 @@ declare type RecordID = string;
  * @example {"newName":"newName","oldName":"oldName"}
  */
 declare type TableRename = {
+    /**
+     * @minLength 1
+     */
     newName: string;
+    /**
+     * @minLength 1
+     */
     oldName: string;
 };
 /**
@@ -576,7 +762,13 @@ declare type TableRename = {
  */
 declare type RecordsMetadata = {
     page: {
+        /**
+         * last record id
+         */
         cursor: string;
+        /**
+         * true if more records can be fetch
+         */
         more: boolean;
     };
 };
@@ -641,6 +833,7 @@ 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;
@@ -716,6 +909,7 @@ declare namespace schemas {
     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,
@@ -799,11 +993,15 @@ declare type SummarizeResponse = {
 };
 declare type SearchResponse = {
     records: XataRecord$1[];
+    warning?: string;
 };
 /**
  * @example {"migrationID":"mig_c7m19ilcefoebpqj12p0"}
  */
 declare type MigrationIdResponse = {
+    /**
+     * @minLength 1
+     */
     migrationID: string;
 };
 
@@ -913,6 +1111,9 @@ declare type GetUserAPIKeysVariables = FetcherExtraProps;
  */
 declare const getUserAPIKeys: (variables: GetUserAPIKeysVariables) => Promise<GetUserAPIKeysResponse>;
 declare type CreateUserAPIKeyPathParams = {
+    /**
+     * API Key name
+     */
     keyName: APIKeyName;
 };
 declare type CreateUserAPIKeyError = ErrorWrapper<{
@@ -938,6 +1139,9 @@ declare type CreateUserAPIKeyVariables = {
  */
 declare const createUserAPIKey: (variables: CreateUserAPIKeyVariables) => Promise<CreateUserAPIKeyResponse>;
 declare type DeleteUserAPIKeyPathParams = {
+    /**
+     * API Key name
+     */
     keyName: APIKeyName;
 };
 declare type DeleteUserAPIKeyError = ErrorWrapper<{
@@ -998,6 +1202,9 @@ declare type GetWorkspacesListVariables = FetcherExtraProps;
  */
 declare const getWorkspacesList: (variables: GetWorkspacesListVariables) => Promise<GetWorkspacesListResponse>;
 declare type GetWorkspacePathParams = {
+    /**
+     * Workspace name
+     */
     workspaceId: WorkspaceID;
 };
 declare type GetWorkspaceError = ErrorWrapper<{
@@ -1018,6 +1225,9 @@ declare type GetWorkspaceVariables = {
  */
 declare const getWorkspace: (variables: GetWorkspaceVariables) => Promise<Workspace>;
 declare type UpdateWorkspacePathParams = {
+    /**
+     * Workspace name
+     */
     workspaceId: WorkspaceID;
 };
 declare type UpdateWorkspaceError = ErrorWrapper<{
@@ -1039,6 +1249,9 @@ declare type UpdateWorkspaceVariables = {
  */
 declare const updateWorkspace: (variables: UpdateWorkspaceVariables) => Promise<Workspace>;
 declare type DeleteWorkspacePathParams = {
+    /**
+     * Workspace name
+     */
     workspaceId: WorkspaceID;
 };
 declare type DeleteWorkspaceError = ErrorWrapper<{
@@ -1059,6 +1272,9 @@ declare type DeleteWorkspaceVariables = {
  */
 declare const deleteWorkspace: (variables: DeleteWorkspaceVariables) => Promise<undefined>;
 declare type GetWorkspaceMembersListPathParams = {
+    /**
+     * Workspace name
+     */
     workspaceId: WorkspaceID;
 };
 declare type GetWorkspaceMembersListError = ErrorWrapper<{
@@ -1079,7 +1295,13 @@ declare type GetWorkspaceMembersListVariables = {
  */
 declare const getWorkspaceMembersList: (variables: GetWorkspaceMembersListVariables) => Promise<WorkspaceMembers>;
 declare type UpdateWorkspaceMemberRolePathParams = {
+    /**
+     * Workspace name
+     */
     workspaceId: WorkspaceID;
+    /**
+     * UserID
+     */
     userId: UserID;
 };
 declare type UpdateWorkspaceMemberRoleError = ErrorWrapper<{
@@ -1104,7 +1326,13 @@ declare type UpdateWorkspaceMemberRoleVariables = {
  */
 declare const updateWorkspaceMemberRole: (variables: UpdateWorkspaceMemberRoleVariables) => Promise<undefined>;
 declare type RemoveWorkspaceMemberPathParams = {
+    /**
+     * Workspace name
+     */
     workspaceId: WorkspaceID;
+    /**
+     * UserID
+     */
     userId: UserID;
 };
 declare type RemoveWorkspaceMemberError = ErrorWrapper<{
@@ -1125,6 +1353,9 @@ declare type RemoveWorkspaceMemberVariables = {
  */
 declare const removeWorkspaceMember: (variables: RemoveWorkspaceMemberVariables) => Promise<undefined>;
 declare type InviteWorkspaceMemberPathParams = {
+    /**
+     * Workspace name
+     */
     workspaceId: WorkspaceID;
 };
 declare type InviteWorkspaceMemberError = ErrorWrapper<{
@@ -1141,6 +1372,9 @@ declare type InviteWorkspaceMemberError = ErrorWrapper<{
     payload: SimpleError;
 }>;
 declare type InviteWorkspaceMemberRequestBody = {
+    /**
+     * @format email
+     */
     email: string;
     role: Role;
 };
@@ -1153,7 +1387,13 @@ declare type InviteWorkspaceMemberVariables = {
  */
 declare const inviteWorkspaceMember: (variables: InviteWorkspaceMemberVariables) => Promise<WorkspaceInvite>;
 declare type UpdateWorkspaceMemberInvitePathParams = {
+    /**
+     * Workspace name
+     */
     workspaceId: WorkspaceID;
+    /**
+     * Invite identifier
+     */
     inviteId: InviteID;
 };
 declare type UpdateWorkspaceMemberInviteError = ErrorWrapper<{
@@ -1181,7 +1421,13 @@ declare type UpdateWorkspaceMemberInviteVariables = {
  */
 declare const updateWorkspaceMemberInvite: (variables: UpdateWorkspaceMemberInviteVariables) => Promise<WorkspaceInvite>;
 declare type CancelWorkspaceMemberInvitePathParams = {
+    /**
+     * Workspace name
+     */
     workspaceId: WorkspaceID;
+    /**
+     * Invite identifier
+     */
     inviteId: InviteID;
 };
 declare type CancelWorkspaceMemberInviteError = ErrorWrapper<{
@@ -1202,7 +1448,13 @@ declare type CancelWorkspaceMemberInviteVariables = {
  */
 declare const cancelWorkspaceMemberInvite: (variables: CancelWorkspaceMemberInviteVariables) => Promise<undefined>;
 declare type ResendWorkspaceMemberInvitePathParams = {
+    /**
+     * Workspace name
+     */
     workspaceId: WorkspaceID;
+    /**
+     * Invite identifier
+     */
     inviteId: InviteID;
 };
 declare type ResendWorkspaceMemberInviteError = ErrorWrapper<{
@@ -1223,7 +1475,13 @@ declare type ResendWorkspaceMemberInviteVariables = {
  */
 declare const resendWorkspaceMemberInvite: (variables: ResendWorkspaceMemberInviteVariables) => Promise<undefined>;
 declare type AcceptWorkspaceMemberInvitePathParams = {
+    /**
+     * Workspace name
+     */
     workspaceId: WorkspaceID;
+    /**
+     * Invite Key (secret) for the invited user
+     */
     inviteKey: InviteKey;
 };
 declare type AcceptWorkspaceMemberInviteError = ErrorWrapper<{
@@ -1261,6 +1519,9 @@ declare type GetDatabaseListVariables = {
  */
 declare const getDatabaseList: (variables: GetDatabaseListVariables) => Promise<ListDatabasesResponse>;
 declare type GetBranchListPathParams = {
+    /**
+     * The Database Name
+     */
     dbName: DBName;
     workspace: string;
 };
@@ -1282,6 +1543,9 @@ declare type GetBranchListVariables = {
  */
 declare const getBranchList: (variables: GetBranchListVariables) => Promise<ListBranchesResponse>;
 declare type CreateDatabasePathParams = {
+    /**
+     * The Database Name
+     */
     dbName: DBName;
     workspace: string;
 };
@@ -1293,10 +1557,16 @@ declare type CreateDatabaseError = ErrorWrapper<{
     payload: AuthError;
 }>;
 declare type CreateDatabaseResponse = {
+    /**
+     * @minLength 1
+     */
     databaseName: string;
     branchName?: string;
 };
 declare type CreateDatabaseRequestBody = {
+    /**
+     * @minLength 1
+     */
     branchName?: string;
     ui?: {
         color?: string;
@@ -1312,6 +1582,9 @@ declare type CreateDatabaseVariables = {
  */
 declare const createDatabase: (variables: CreateDatabaseVariables) => Promise<CreateDatabaseResponse>;
 declare type DeleteDatabasePathParams = {
+    /**
+     * The Database Name
+     */
     dbName: DBName;
     workspace: string;
 };
@@ -1333,6 +1606,9 @@ declare type DeleteDatabaseVariables = {
  */
 declare const deleteDatabase: (variables: DeleteDatabaseVariables) => Promise<undefined>;
 declare type GetDatabaseMetadataPathParams = {
+    /**
+     * The Database Name
+     */
     dbName: DBName;
     workspace: string;
 };
@@ -1354,6 +1630,9 @@ declare type GetDatabaseMetadataVariables = {
  */
 declare const getDatabaseMetadata: (variables: GetDatabaseMetadataVariables) => Promise<DatabaseMetadata>;
 declare type UpdateDatabaseMetadataPathParams = {
+    /**
+     * The Database Name
+     */
     dbName: DBName;
     workspace: string;
 };
@@ -1369,6 +1648,9 @@ declare type UpdateDatabaseMetadataError = ErrorWrapper<{
 }>;
 declare type UpdateDatabaseMetadataRequestBody = {
     ui?: {
+        /**
+         * @minLength 1
+         */
         color?: string;
     };
 };
@@ -1381,6 +1663,9 @@ declare type UpdateDatabaseMetadataVariables = {
  */
 declare const updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables) => Promise<DatabaseMetadata>;
 declare type GetGitBranchesMappingPathParams = {
+    /**
+     * The Database Name
+     */
     dbName: DBName;
     workspace: string;
 };
@@ -1420,6 +1705,9 @@ declare type GetGitBranchesMappingVariables = {
  */
 declare const getGitBranchesMapping: (variables: GetGitBranchesMappingVariables) => Promise<ListGitBranchesResponse>;
 declare type AddGitBranchesEntryPathParams = {
+    /**
+     * The Database Name
+     */
     dbName: DBName;
     workspace: string;
 };
@@ -1431,10 +1719,19 @@ declare type AddGitBranchesEntryError = ErrorWrapper<{
     payload: AuthError;
 }>;
 declare type AddGitBranchesEntryResponse = {
+    /**
+     * Warning message
+     */
     warning?: string;
 };
 declare type AddGitBranchesEntryRequestBody = {
+    /**
+     * The name of the Git branch.
+     */
     gitBranch: string;
+    /**
+     * The name of the Xata branch.
+     */
     xataBranch: BranchName;
 };
 declare type AddGitBranchesEntryVariables = {
@@ -1458,10 +1755,16 @@ declare type AddGitBranchesEntryVariables = {
  */
 declare const addGitBranchesEntry: (variables: AddGitBranchesEntryVariables) => Promise<AddGitBranchesEntryResponse>;
 declare type RemoveGitBranchesEntryPathParams = {
+    /**
+     * The Database Name
+     */
     dbName: DBName;
     workspace: string;
 };
 declare type RemoveGitBranchesEntryQueryParams = {
+    /**
+     * The Git Branch to remove from the mapping
+     */
     gitBranch: string;
 };
 declare type RemoveGitBranchesEntryError = ErrorWrapper<{
@@ -1486,11 +1789,20 @@ declare type RemoveGitBranchesEntryVariables = {
  */
 declare const removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables) => Promise<undefined>;
 declare type ResolveBranchPathParams = {
+    /**
+     * The Database Name
+     */
     dbName: DBName;
     workspace: string;
 };
 declare type ResolveBranchQueryParams = {
+    /**
+     * The Git Branch
+     */
     gitBranch?: string;
+    /**
+     * Default branch to fallback to
+     */
     fallbackBranch?: string;
 };
 declare type ResolveBranchError = ErrorWrapper<{
@@ -1538,6 +1850,9 @@ declare type ResolveBranchVariables = {
  */
 declare const resolveBranch: (variables: ResolveBranchVariables) => Promise<ResolveBranchResponse>;
 declare type ListMigrationRequestsPathParams = {
+    /**
+     * The Database Name
+     */
     dbName: DBName;
     workspace: string;
 };
@@ -1567,6 +1882,9 @@ declare type ListMigrationRequestsVariables = {
 } & FetcherExtraProps;
 declare const listMigrationRequests: (variables: ListMigrationRequestsVariables) => Promise<ListMigrationRequestsResponse>;
 declare type CreateMigrationRequestPathParams = {
+    /**
+     * The Database Name
+     */
     dbName: DBName;
     workspace: string;
 };
@@ -1584,9 +1902,21 @@ declare type CreateMigrationRequestResponse = {
     number: number;
 };
 declare type CreateMigrationRequestRequestBody = {
+    /**
+     * The source branch.
+     */
     source: string;
+    /**
+     * The target branch.
+     */
     target: string;
+    /**
+     * The title.
+     */
     title: string;
+    /**
+     * Optional migration request description.
+     */
     body?: string;
 };
 declare type CreateMigrationRequestVariables = {
@@ -1595,7 +1925,13 @@ declare type CreateMigrationRequestVariables = {
 } & FetcherExtraProps;
 declare const createMigrationRequest: (variables: CreateMigrationRequestVariables) => Promise<CreateMigrationRequestResponse>;
 declare type GetMigrationRequestPathParams = {
+    /**
+     * The Database Name
+     */
     dbName: DBName;
+    /**
+     * The migration request number.
+     */
     mrNumber: number;
     workspace: string;
 };
@@ -1614,7 +1950,13 @@ declare type GetMigrationRequestVariables = {
 } & FetcherExtraProps;
 declare const getMigrationRequest: (variables: GetMigrationRequestVariables) => Promise<MigrationRequest>;
 declare type UpdateMigrationRequestPathParams = {
+    /**
+     * The Database Name
+     */
     dbName: DBName;
+    /**
+     * The migration request number.
+     */
     mrNumber: number;
     workspace: string;
 };
@@ -1629,8 +1971,17 @@ declare type UpdateMigrationRequestError = ErrorWrapper<{
     payload: SimpleError;
 }>;
 declare type UpdateMigrationRequestRequestBody = {
+    /**
+     * New migration request title.
+     */
     title?: string;
+    /**
+     * New migration request description.
+     */
     body?: string;
+    /**
+     * Change the migration request status.
+     */
     status?: 'open' | 'closed';
 };
 declare type UpdateMigrationRequestVariables = {
@@ -1639,7 +1990,13 @@ declare type UpdateMigrationRequestVariables = {
 } & FetcherExtraProps;
 declare const updateMigrationRequest: (variables: UpdateMigrationRequestVariables) => Promise<undefined>;
 declare type ListMigrationRequestsCommitsPathParams = {
+    /**
+     * The Database Name
+     */
     dbName: DBName;
+    /**
+     * The migration request number.
+     */
     mrNumber: number;
     workspace: string;
 };
@@ -1655,15 +2012,32 @@ declare type ListMigrationRequestsCommitsError = ErrorWrapper<{
 }>;
 declare type ListMigrationRequestsCommitsResponse = {
     meta: {
+        /**
+         * last record id
+         */
         cursor: string;
+        /**
+         * true if more records can be fetch
+         */
         more: boolean;
     };
     logs: Commit[];
 };
 declare type ListMigrationRequestsCommitsRequestBody = {
     page?: {
+        /**
+         * Query the next page that follow the cursor.
+         */
         after?: string;
+        /**
+         * Query the previous page before the cursor.
+         */
         before?: 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;
     };
 };
@@ -1673,7 +2047,13 @@ declare type ListMigrationRequestsCommitsVariables = {
 } & FetcherExtraProps;
 declare const listMigrationRequestsCommits: (variables: ListMigrationRequestsCommitsVariables) => Promise<ListMigrationRequestsCommitsResponse>;
 declare type CompareMigrationRequestPathParams = {
+    /**
+     * The Database Name
+     */
     dbName: DBName;
+    /**
+     * The migration request number.
+     */
     mrNumber: number;
     workspace: string;
 };
@@ -1692,7 +2072,13 @@ declare type CompareMigrationRequestVariables = {
 } & FetcherExtraProps;
 declare const compareMigrationRequest: (variables: CompareMigrationRequestVariables) => Promise<SchemaCompareResponse>;
 declare type GetMigrationRequestIsMergedPathParams = {
+    /**
+     * The Database Name
+     */
     dbName: DBName;
+    /**
+     * The migration request number.
+     */
     mrNumber: number;
     workspace: string;
 };
@@ -1714,7 +2100,13 @@ declare type GetMigrationRequestIsMergedVariables = {
 } & FetcherExtraProps;
 declare const getMigrationRequestIsMerged: (variables: GetMigrationRequestIsMergedVariables) => Promise<GetMigrationRequestIsMergedResponse>;
 declare type MergeMigrationRequestPathParams = {
+    /**
+     * The Database Name
+     */
     dbName: DBName;
+    /**
+     * The migration request number.
+     */
     mrNumber: number;
     workspace: string;
 };
@@ -1733,6 +2125,9 @@ declare type MergeMigrationRequestVariables = {
 } & FetcherExtraProps;
 declare const mergeMigrationRequest: (variables: MergeMigrationRequestVariables) => Promise<Commit>;
 declare type GetBranchDetailsPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
     workspace: string;
 };
@@ -1751,10 +2146,16 @@ declare type GetBranchDetailsVariables = {
 } & FetcherExtraProps;
 declare const getBranchDetails: (variables: GetBranchDetailsVariables) => Promise<DBBranch>;
 declare type CreateBranchPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
     workspace: string;
 };
 declare type CreateBranchQueryParams = {
+    /**
+     * Name of source branch to branch the new schema from
+     */
     from?: string;
 };
 declare type CreateBranchError = ErrorWrapper<{
@@ -1768,10 +2169,16 @@ declare type CreateBranchError = ErrorWrapper<{
     payload: SimpleError;
 }>;
 declare type CreateBranchResponse = {
+    /**
+     * @minLength 1
+     */
     databaseName: string;
     branchName: string;
 };
 declare type CreateBranchRequestBody = {
+    /**
+     * Select the branch to fork from. Defaults to 'main'
+     */
     from?: string;
     metadata?: BranchMetadata;
 };
@@ -1782,6 +2189,9 @@ declare type CreateBranchVariables = {
 } & FetcherExtraProps;
 declare const createBranch: (variables: CreateBranchVariables) => Promise<CreateBranchResponse>;
 declare type DeleteBranchPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
     workspace: string;
 };
@@ -1803,6 +2213,9 @@ declare type DeleteBranchVariables = {
  */
 declare const deleteBranch: (variables: DeleteBranchVariables) => Promise<undefined>;
 declare type UpdateBranchMetadataPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
     workspace: string;
 };
@@ -1825,6 +2238,9 @@ declare type UpdateBranchMetadataVariables = {
  */
 declare const updateBranchMetadata: (variables: UpdateBranchMetadataVariables) => Promise<undefined>;
 declare type GetBranchMetadataPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
     workspace: string;
 };
@@ -1843,6 +2259,9 @@ declare type GetBranchMetadataVariables = {
 } & FetcherExtraProps;
 declare const getBranchMetadata: (variables: GetBranchMetadataVariables) => Promise<BranchMetadata>;
 declare type GetBranchMigrationHistoryPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
     workspace: string;
 };
@@ -1870,6 +2289,9 @@ declare type GetBranchMigrationHistoryVariables = {
 } & FetcherExtraProps;
 declare const getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables) => Promise<GetBranchMigrationHistoryResponse>;
 declare type ExecuteBranchMigrationPlanPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
     workspace: string;
 };
@@ -1896,6 +2318,9 @@ declare type ExecuteBranchMigrationPlanVariables = {
  */
 declare const executeBranchMigrationPlan: (variables: ExecuteBranchMigrationPlanVariables) => Promise<undefined>;
 declare type GetBranchMigrationPlanPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
     workspace: string;
 };
@@ -1918,6 +2343,9 @@ declare type GetBranchMigrationPlanVariables = {
  */
 declare const getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables) => Promise<BranchMigrationPlan>;
 declare type CompareBranchWithUserSchemaPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
     workspace: string;
 };
@@ -1940,7 +2368,13 @@ declare type CompareBranchWithUserSchemaVariables = {
 } & FetcherExtraProps;
 declare const compareBranchWithUserSchema: (variables: CompareBranchWithUserSchemaVariables) => Promise<SchemaCompareResponse>;
 declare type CompareBranchSchemasPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
+    /**
+     * The Database Name
+     */
     branchName: BranchName;
     workspace: string;
 };
@@ -1960,6 +2394,9 @@ declare type CompareBranchSchemasVariables = {
 } & FetcherExtraProps;
 declare const compareBranchSchemas: (variables: CompareBranchSchemasVariables) => Promise<SchemaCompareResponse>;
 declare type UpdateBranchSchemaPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
     workspace: string;
 };
@@ -1983,6 +2420,9 @@ declare type UpdateBranchSchemaVariables = {
 } & FetcherExtraProps;
 declare const updateBranchSchema: (variables: UpdateBranchSchemaVariables) => Promise<UpdateBranchSchemaResponse>;
 declare type PreviewBranchSchemaEditPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
     workspace: string;
 };
@@ -2010,6 +2450,9 @@ declare type PreviewBranchSchemaEditVariables = {
 } & FetcherExtraProps;
 declare const previewBranchSchemaEdit: (variables: PreviewBranchSchemaEditVariables) => Promise<PreviewBranchSchemaEditResponse>;
 declare type ApplyBranchSchemaEditPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
     workspace: string;
 };
@@ -2036,6 +2479,9 @@ declare type ApplyBranchSchemaEditVariables = {
 } & FetcherExtraProps;
 declare const applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables) => Promise<ApplyBranchSchemaEditResponse>;
 declare type GetBranchSchemaHistoryPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
     workspace: string;
 };
@@ -2051,15 +2497,32 @@ declare type GetBranchSchemaHistoryError = ErrorWrapper<{
 }>;
 declare type GetBranchSchemaHistoryResponse = {
     meta: {
+        /**
+         * last record id
+         */
         cursor: string;
+        /**
+         * true if more records can be fetch
+         */
         more: boolean;
     };
     logs: Commit[];
 };
 declare type GetBranchSchemaHistoryRequestBody = {
     page?: {
+        /**
+         * Query the next page that follow the cursor.
+         */
         after?: string;
+        /**
+         * Query the previous page before the cursor.
+         */
         before?: 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;
     };
 };
@@ -2069,6 +2532,9 @@ declare type GetBranchSchemaHistoryVariables = {
 } & FetcherExtraProps;
 declare const getBranchSchemaHistory: (variables: GetBranchSchemaHistoryVariables) => Promise<GetBranchSchemaHistoryResponse>;
 declare type GetBranchStatsPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
     workspace: string;
 };
@@ -2101,7 +2567,13 @@ declare type GetBranchStatsVariables = {
  */
 declare const getBranchStats: (variables: GetBranchStatsVariables) => Promise<GetBranchStatsResponse>;
 declare type CreateTablePathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
+    /**
+     * The Table name
+     */
     tableName: TableName;
     workspace: string;
 };
@@ -2120,6 +2592,9 @@ declare type CreateTableError = ErrorWrapper<{
 }>;
 declare type CreateTableResponse = {
     branchName: string;
+    /**
+     * @minLength 1
+     */
     tableName: string;
 };
 declare type CreateTableVariables = {
@@ -2130,7 +2605,13 @@ declare type CreateTableVariables = {
  */
 declare const createTable: (variables: CreateTableVariables) => Promise<CreateTableResponse>;
 declare type DeleteTablePathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
+    /**
+     * The Table name
+     */
     tableName: TableName;
     workspace: string;
 };
@@ -2149,7 +2630,13 @@ declare type DeleteTableVariables = {
  */
 declare const deleteTable: (variables: DeleteTableVariables) => Promise<undefined>;
 declare type UpdateTablePathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
+    /**
+     * The Table name
+     */
     tableName: TableName;
     workspace: string;
 };
@@ -2164,6 +2651,9 @@ declare type UpdateTableError = ErrorWrapper<{
     payload: SimpleError;
 }>;
 declare type UpdateTableRequestBody = {
+    /**
+     * @minLength 1
+     */
     name: string;
 };
 declare type UpdateTableVariables = {
@@ -2185,7 +2675,13 @@ declare type UpdateTableVariables = {
  */
 declare const updateTable: (variables: UpdateTableVariables) => Promise<undefined>;
 declare type GetTableSchemaPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
+    /**
+     * The Table name
+     */
     tableName: TableName;
     workspace: string;
 };
@@ -2207,7 +2703,13 @@ declare type GetTableSchemaVariables = {
 } & FetcherExtraProps;
 declare const getTableSchema: (variables: GetTableSchemaVariables) => Promise<GetTableSchemaResponse>;
 declare type SetTableSchemaPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
+    /**
+     * The Table name
+     */
     tableName: TableName;
     workspace: string;
 };
@@ -2233,7 +2735,13 @@ declare type SetTableSchemaVariables = {
 } & FetcherExtraProps;
 declare const setTableSchema: (variables: SetTableSchemaVariables) => Promise<undefined>;
 declare type GetTableColumnsPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
+    /**
+     * The Table name
+     */
     tableName: TableName;
     workspace: string;
 };
@@ -2259,7 +2767,13 @@ declare type GetTableColumnsVariables = {
  */
 declare const getTableColumns: (variables: GetTableColumnsVariables) => Promise<GetTableColumnsResponse>;
 declare type AddTableColumnPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
+    /**
+     * The Table name
+     */
     tableName: TableName;
     workspace: string;
 };
@@ -2284,8 +2798,17 @@ declare type AddTableColumnVariables = {
  */
 declare const addTableColumn: (variables: AddTableColumnVariables) => Promise<MigrationIdResponse>;
 declare type GetColumnPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
+    /**
+     * The Table name
+     */
     tableName: TableName;
+    /**
+     * The Column name
+     */
     columnName: ColumnName;
     workspace: string;
 };
@@ -2307,8 +2830,17 @@ declare type GetColumnVariables = {
  */
 declare const getColumn: (variables: GetColumnVariables) => Promise<Column>;
 declare type DeleteColumnPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
+    /**
+     * The Table name
+     */
     tableName: TableName;
+    /**
+     * The Column name
+     */
     columnName: ColumnName;
     workspace: string;
 };
@@ -2330,8 +2862,17 @@ declare type DeleteColumnVariables = {
  */
 declare const deleteColumn: (variables: DeleteColumnVariables) => Promise<MigrationIdResponse>;
 declare type UpdateColumnPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
+    /**
+     * The Table name
+     */
     tableName: TableName;
+    /**
+     * The Column name
+     */
     columnName: ColumnName;
     workspace: string;
 };
@@ -2346,6 +2887,9 @@ declare type UpdateColumnError = ErrorWrapper<{
     payload: SimpleError;
 }>;
 declare type UpdateColumnRequestBody = {
+    /**
+     * @minLength 1
+     */
     name: string;
 };
 declare type UpdateColumnVariables = {
@@ -2357,11 +2901,20 @@ declare type UpdateColumnVariables = {
  */
 declare const updateColumn: (variables: UpdateColumnVariables) => Promise<MigrationIdResponse>;
 declare type InsertRecordPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
+    /**
+     * The Table name
+     */
     tableName: TableName;
     workspace: string;
 };
 declare type InsertRecordQueryParams = {
+    /**
+     * Column filters
+     */
     columns?: ColumnsProjection;
 };
 declare type InsertRecordError = ErrorWrapper<{
@@ -2384,12 +2937,24 @@ declare type InsertRecordVariables = {
  */
 declare const insertRecord: (variables: InsertRecordVariables) => Promise<RecordUpdateResponse>;
 declare type InsertRecordWithIDPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
+    /**
+     * The Table name
+     */
     tableName: TableName;
+    /**
+     * The Record name
+     */
     recordId: RecordID;
     workspace: string;
 };
 declare type InsertRecordWithIDQueryParams = {
+    /**
+     * Column filters
+     */
     columns?: ColumnsProjection;
     createOnly?: boolean;
     ifVersion?: number;
@@ -2417,12 +2982,24 @@ declare type InsertRecordWithIDVariables = {
  */
 declare const insertRecordWithID: (variables: InsertRecordWithIDVariables) => Promise<RecordUpdateResponse>;
 declare type UpdateRecordWithIDPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
+    /**
+     * The Table name
+     */
     tableName: TableName;
+    /**
+     * The Record name
+     */
     recordId: RecordID;
     workspace: string;
 };
 declare type UpdateRecordWithIDQueryParams = {
+    /**
+     * Column filters
+     */
     columns?: ColumnsProjection;
     ifVersion?: number;
 };
@@ -2446,12 +3023,24 @@ declare type UpdateRecordWithIDVariables = {
 } & FetcherExtraProps;
 declare const updateRecordWithID: (variables: UpdateRecordWithIDVariables) => Promise<RecordUpdateResponse>;
 declare type UpsertRecordWithIDPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
+    /**
+     * The Table name
+     */
     tableName: TableName;
+    /**
+     * The Record name
+     */
     recordId: RecordID;
     workspace: string;
 };
 declare type UpsertRecordWithIDQueryParams = {
+    /**
+     * Column filters
+     */
     columns?: ColumnsProjection;
     ifVersion?: number;
 };
@@ -2475,12 +3064,24 @@ declare type UpsertRecordWithIDVariables = {
 } & FetcherExtraProps;
 declare const upsertRecordWithID: (variables: UpsertRecordWithIDVariables) => Promise<RecordUpdateResponse>;
 declare type DeleteRecordPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
+    /**
+     * The Table name
+     */
     tableName: TableName;
+    /**
+     * The Record name
+     */
     recordId: RecordID;
     workspace: string;
 };
 declare type DeleteRecordQueryParams = {
+    /**
+     * Column filters
+     */
     columns?: ColumnsProjection;
 };
 declare type DeleteRecordError = ErrorWrapper<{
@@ -2499,12 +3100,24 @@ declare type DeleteRecordVariables = {
 } & FetcherExtraProps;
 declare const deleteRecord: (variables: DeleteRecordVariables) => Promise<XataRecord$1>;
 declare type GetRecordPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
+    /**
+     * The Table name
+     */
     tableName: TableName;
+    /**
+     * The Record name
+     */
     recordId: RecordID;
     workspace: string;
 };
 declare type GetRecordQueryParams = {
+    /**
+     * Column filters
+     */
     columns?: ColumnsProjection;
 };
 declare type GetRecordError = ErrorWrapper<{
@@ -2526,11 +3139,20 @@ declare type GetRecordVariables = {
  */
 declare const getRecord: (variables: GetRecordVariables) => Promise<XataRecord$1>;
 declare type BulkInsertTableRecordsPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
+    /**
+     * The Table name
+     */
     tableName: TableName;
     workspace: string;
 };
 declare type BulkInsertTableRecordsQueryParams = {
+    /**
+     * Column filters
+     */
     columns?: ColumnsProjection;
 };
 declare type BulkInsertTableRecordsError = ErrorWrapper<{
@@ -2559,7 +3181,13 @@ declare type BulkInsertTableRecordsVariables = {
  */
 declare const bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables) => Promise<BulkInsertResponse>;
 declare type QueryTablePathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
+    /**
+     * The Table name
+     */
     tableName: TableName;
     workspace: string;
 };
@@ -2613,8 +3241,9 @@ declare type QueryTableVariables = {
  * If the `columns` array is not specified, all columns are included. For link
  * fields, only the ID column of the linked records is included in the response.
  *
- * If the `columns` array is specified, only the selected columns are included.
- * The `*` wildcard can be used to select all columns of the given array
+ * If the `columns` array is specified, only the selected and internal
+ * columns `id` and `xata` are included. The `*` wildcard can be used to
+ * select all columns.
  *
  * For objects and link fields, if the column name of the object is specified, we
  * include all of its sub-keys. If only some sub-keys are specified (via dotted
@@ -2730,6 +3359,10 @@ declare type QueryTableVariables = {
  *
  * ```json
  * {
+ *   "id": "id1"
+ *   "xata": {
+ *     "version": 0
+ *   }
  *   "name": "Kilian",
  *   "address": {
  *     "street": "New street"
@@ -2749,6 +3382,10 @@ declare type QueryTableVariables = {
  *
  * ```json
  * {
+ *   "id": "id1"
+ *   "xata": {
+ *     "version": 0
+ *   }
  *   "name": "Kilian",
  *   "email": "kilian@gmail.com",
  *   "address": {
@@ -2778,6 +3415,10 @@ declare type QueryTableVariables = {
  *
  * ```json
  * {
+ *   "id": "id1"
+ *   "xata": {
+ *     "version": 0
+ *   }
  *   "name": "Kilian",
  *   "email": "kilian@gmail.com",
  *   "address": {
@@ -3204,8 +3845,8 @@ declare type QueryTableVariables = {
  *
  * ### Pagination
  *
- * We offer cursor pagination and offset pagination. The offset pagination is limited
- * in the amount of data it can retrieve, so we recommend the cursor pagination if you have more than 1000 records.
+ * We offer cursor pagination and offset pagination. For queries that are expected to return more than 1000 records,
+ * cursor pagination is needed in order to retrieve all of their results. The offset pagination method is limited to 1000 records.
  *
  * Example of size + offset pagination:
  *
@@ -3306,7 +3947,13 @@ declare type QueryTableVariables = {
  */
 declare const queryTable: (variables: QueryTableVariables) => Promise<QueryResponse>;
 declare type SearchTablePathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
+    /**
+     * The Table name
+     */
     tableName: TableName;
     workspace: string;
 };
@@ -3321,8 +3968,14 @@ declare type SearchTableError = ErrorWrapper<{
     payload: SimpleError;
 }>;
 declare type SearchTableRequestBody = {
+    /**
+     * The query string.
+     *
+     * @minLength 1
+     */
     query: string;
     fuzziness?: FuzzinessExpression;
+    target?: TargetExpression;
     prefix?: PrefixExpression;
     filter?: FilterExpression;
     highlight?: HighlightExpression;
@@ -3341,6 +3994,9 @@ declare type SearchTableVariables = {
  */
 declare const searchTable: (variables: SearchTableVariables) => Promise<SearchResponse>;
 declare type SearchBranchPathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
     workspace: string;
 };
@@ -3355,11 +4011,23 @@ declare type SearchBranchError = ErrorWrapper<{
     payload: SimpleError;
 }>;
 declare type SearchBranchRequestBody = {
+    /**
+     * An array with the tables in which to search. By default, all tables are included. Optionally, filters can be included that apply to each table.
+     */
     tables?: (string | {
+        /**
+         * The name of the table.
+         */
         table: string;
         filter?: FilterExpression;
+        target?: TargetExpression;
         boosters?: BoosterExpression[];
     })[];
+    /**
+     * The query string.
+     *
+     * @minLength 1
+     */
     query: string;
     fuzziness?: FuzzinessExpression;
     prefix?: PrefixExpression;
@@ -3374,7 +4042,13 @@ declare type SearchBranchVariables = {
  */
 declare const searchBranch: (variables: SearchBranchVariables) => Promise<SearchResponse>;
 declare type SummarizeTablePathParams = {
+    /**
+     * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
+     */
     dbBranchName: DBBranchName;
+    /**
+     * The Table name
+     */
     tableName: TableName;
     workspace: string;
 };
@@ -3389,15 +4063,53 @@ declare type SummarizeTableError = ErrorWrapper<{
     payload: SimpleError;
 }>;
 declare type SummarizeTableRequestBody = {
-    summaries?: SummaryExpressionList;
     columns?: ColumnsProjection;
+    summaries?: SummaryExpressionList;
+    sort?: SortExpression;
 };
 declare type SummarizeTableVariables = {
     body?: SummarizeTableRequestBody;
     pathParams: SummarizeTablePathParams;
 } & FetcherExtraProps;
 /**
- * Summarize table
+ * This endpoint allows you to (optionally) define groups, and then to run
+ * calculations on the values in each group. This is most helpful when you'd
+ * like to understand the data you have in your database.
+ *
+ * A group is a combination of unique values. If you create a group for `sold_by`,
+ * `product_name`, we will return one row for every combination of `sold_by` and
+ * `product_name` you have in your database. When you want to calculate statistics,
+ * you define these groups and ask Xata to calculate data on each group.
+ *
+ * **Some questions you can ask of your data:**
+ *
+ * How many records do I have in this table?
+ * - Set `columns: []` as we we want data from the entire table, so we ask for no groups.
+ * - Set `summaries: {"total": {"count": "*"}}` in order to see the count of all records.
+ * We use `count: *` here we'd like to know the total amount of rows; ignoring whether
+ * they are `null` or not.
+ *
+ * What are the top total sales for each product?
+ * - Set `columns: [product_name]` as we'd like to run calculations on each unique product
+ * name in our table. Setting `columns` like this will produce one row per unique product
+ * name.
+ * - Set `summaries: {"total_sales": {"count": "product_name"}}` as we'd like to create a
+ * field called "total_sales" for each group. This field will count all rows in each group
+ * with non-null product names.
+ * - Set `sort: [{"total_sales": "desc"}]` in order to bring the rows with the highest
+ * total_sales field to the top.
+ *
+ * `columns`: tells Xata how to create each group. If you add `product_id` we will create
+ * a new group for every unique `product_id`.
+ *
+ * `summaries`: tells Xata which calculations to run on each group.
+ *
+ * `sort`: tells Xata in which order you'd like to see results. You may sort by fields
+ * specified in `columns` as well as the summary names defined in `summaries`.
+ *
+ * note: Sorting on summarized values can be slower on very large tables; this will impact
+ * your rate limit significantly more than other queries. Try use `filter` [coming soon] to
+ * reduce the amount of data being processed in order to reduce impact on your limits.
  */
 declare const summarizeTable: (variables: SummarizeTableVariables) => Promise<SummarizeResponse>;
 declare const operationsByTag: {
@@ -3870,6 +4582,21 @@ declare type Boosters<O extends XataRecord> = Values<{
     } : never;
 }>;
 
+declare type TargetColumn<T extends XataRecord> = SelectableColumn<T> | {
+    /**
+     * The name of the column.
+     */
+    column: SelectableColumn<T>;
+    /**
+     * The weight of the column.
+     *
+     * @default 1
+     * @maximum 10
+     * @minimum 1
+     */
+    weight?: number;
+};
+
 declare type SearchOptions<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>> = {
     fuzziness?: FuzzinessExpression;
     prefix?: PrefixExpression;
@@ -3877,6 +4604,7 @@ declare type SearchOptions<Schemas extends Record<string, BaseData>, Tables exte
     tables?: Array<Tables | Values<{
         [Model in GetArrayInnerType<NonNullable<Tables[]>>]: {
             table: Model;
+            target?: TargetColumn<Schemas[Model] & XataRecord>[];
             filter?: Filter<SelectedPick<Schemas[Model] & XataRecord, ['*']>>;
             boosters?: Boosters<Schemas[Model] & XataRecord>[];
         };
@@ -4008,9 +4736,6 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
      * @returns A new Query object.
      */
     filter(filters?: Filter<Record>): Query<Record, Result>;
-    defaultFilter<T>(column: string, value: T): T | {
-        $includes: (T & string) | (T & string[]);
-    };
     /**
      * Builds a new query with a new sort option.
      * @param column The column name.