@xata.io/client 0.0.0-alpha.vebc4a36 → 0.0.0-alpha.vec0147b

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -22,21 +22,20 @@ declare class SimpleCache implements CacheImpl {
22
22
  clear(): Promise<void>;
23
23
  }
24
24
 
25
+ declare abstract class XataPlugin {
26
+ abstract build(options: XataPluginOptions): unknown;
27
+ }
28
+ type XataPluginOptions = ApiExtraProps & {
29
+ cache: CacheImpl;
30
+ host: HostProvider;
31
+ };
32
+
25
33
  type AttributeDictionary = Record<string, string | number | boolean | undefined>;
26
34
  type TraceFunction = <T>(name: string, fn: (options: {
27
35
  name?: string;
28
36
  setAttributes: (attrs: AttributeDictionary) => void;
29
37
  }) => T, options?: AttributeDictionary) => Promise<T>;
30
38
 
31
- declare abstract class XataPlugin {
32
- abstract build(options: XataPluginOptions): unknown | Promise<unknown>;
33
- }
34
- type XataPluginOptions = {
35
- getFetchProps: () => Promise<ApiExtraProps>;
36
- cache: CacheImpl;
37
- trace?: TraceFunction;
38
- };
39
-
40
39
  type RequestInit = {
41
40
  body?: string;
42
41
  headers?: Record<string, string>;
@@ -73,7 +72,7 @@ type FetcherExtraProps = {
73
72
  endpoint: 'controlPlane' | 'dataPlane';
74
73
  apiUrl: string;
75
74
  workspacesApiUrl: string | WorkspaceApiUrlBuilder;
76
- fetchImpl: FetchImpl;
75
+ fetch: FetchImpl;
77
76
  apiKey: string;
78
77
  trace: TraceFunction;
79
78
  signal?: AbortSignal;
@@ -87,7 +86,7 @@ type FetcherExtraProps = {
87
86
  type ControlPlaneFetcherExtraProps = {
88
87
  apiUrl: string;
89
88
  workspacesApiUrl: string | WorkspaceApiUrlBuilder;
90
- fetchImpl: FetchImpl;
89
+ fetch: FetchImpl;
91
90
  apiKey: string;
92
91
  trace: TraceFunction;
93
92
  signal?: AbortSignal;
@@ -1137,7 +1136,7 @@ type ColumnVector = {
1137
1136
  };
1138
1137
  type Column = {
1139
1138
  name: string;
1140
- type: 'bool' | 'int' | 'float' | 'string' | 'text' | 'email' | 'multiple' | 'link' | 'object' | 'datetime' | 'vector';
1139
+ type: 'bool' | 'int' | 'float' | 'string' | 'text' | 'email' | 'multiple' | 'link' | 'object' | 'datetime' | 'vector' | 'file[]' | 'file' | 'image[]' | 'image';
1141
1140
  link?: ColumnLink;
1142
1141
  vector?: ColumnVector;
1143
1142
  notNull?: boolean;
@@ -1174,6 +1173,11 @@ type DBBranch = {
1174
1173
  schema: Schema;
1175
1174
  };
1176
1175
  type MigrationStatus = 'completed' | 'pending' | 'failed';
1176
+ type BranchWithCopyID = {
1177
+ branchName: BranchName;
1178
+ dbBranchID: string;
1179
+ copyID: string;
1180
+ };
1177
1181
  type MetricsDatapoint = {
1178
1182
  timestamp: string;
1179
1183
  value: number;
@@ -1289,7 +1293,7 @@ type FilterColumnIncludes = {
1289
1293
  $includesNone?: FilterPredicate;
1290
1294
  };
1291
1295
  type FilterColumn = FilterColumnIncludes | FilterPredicate | FilterList;
1292
- type SortOrder = 'asc' | 'desc';
1296
+ type SortOrder = 'asc' | 'desc' | 'random';
1293
1297
  type SortExpression = string[] | {
1294
1298
  [key: string]: SortOrder;
1295
1299
  } | {
@@ -1438,10 +1442,9 @@ type Commit = {
1438
1442
  message?: string;
1439
1443
  id: string;
1440
1444
  parentID?: string;
1445
+ checksum?: string;
1441
1446
  mergeParentID?: string;
1442
- status: MigrationStatus;
1443
1447
  createdAt: DateTime;
1444
- modifiedAt?: DateTime;
1445
1448
  operations: MigrationOp[];
1446
1449
  };
1447
1450
  type SchemaEditScript = {
@@ -1449,6 +1452,16 @@ type SchemaEditScript = {
1449
1452
  targetMigrationID?: string;
1450
1453
  operations: MigrationOp[];
1451
1454
  };
1455
+ type BranchOp = {
1456
+ id: string;
1457
+ parentID?: string;
1458
+ title?: string;
1459
+ message?: string;
1460
+ status: MigrationStatus;
1461
+ createdAt: DateTime;
1462
+ modifiedAt?: DateTime;
1463
+ migration?: Commit;
1464
+ };
1452
1465
  /**
1453
1466
  * Branch schema migration.
1454
1467
  */
@@ -1456,6 +1469,14 @@ type Migration = {
1456
1469
  parentID?: string;
1457
1470
  operations: MigrationOp[];
1458
1471
  };
1472
+ type MigrationObject = {
1473
+ title?: string;
1474
+ message?: string;
1475
+ id: string;
1476
+ parentID?: string;
1477
+ checksum?: string;
1478
+ operations: MigrationOp[];
1479
+ };
1459
1480
  /**
1460
1481
  * @pattern [a-zA-Z0-9_\-~\.]+
1461
1482
  */
@@ -1634,6 +1655,61 @@ type TransactionFailure = {
1634
1655
  */
1635
1656
  errors: TransactionError[];
1636
1657
  };
1658
+ /**
1659
+ * Object column value
1660
+ */
1661
+ type ObjectValue = {
1662
+ [key: string]: string | boolean | number | string[] | number[] | DateTime | ObjectValue;
1663
+ };
1664
+ /**
1665
+ * Object representing a file
1666
+ *
1667
+ * @x-go-type file.InputFile
1668
+ */
1669
+ type InputFileEntry = {
1670
+ /**
1671
+ * File name
1672
+ *
1673
+ * @maxLength 1024
1674
+ * @minLength 1
1675
+ * @pattern [0-9a-zA-Z!\-_\.\*'\(\)]+
1676
+ */
1677
+ name: string;
1678
+ /**
1679
+ * Media type
1680
+ *
1681
+ * @maxLength 255
1682
+ * @minLength 3
1683
+ * @pattern ^\w+/[-+.\w]+$
1684
+ */
1685
+ mediaType?: string;
1686
+ /**
1687
+ * Base64 encoded content
1688
+ *
1689
+ * @maxLength 20971520
1690
+ */
1691
+ base64Content?: string;
1692
+ /**
1693
+ * Enable public access to the file
1694
+ */
1695
+ enablePublicUrl?: boolean;
1696
+ /**
1697
+ * Time to live for signed URLs
1698
+ */
1699
+ signedUrlTimeout?: number;
1700
+ };
1701
+ /**
1702
+ * Array of file entries
1703
+ *
1704
+ * @maxItems 50
1705
+ */
1706
+ type InputFileArray = InputFileEntry[];
1707
+ /**
1708
+ * Xata input record
1709
+ */
1710
+ type DataInputRecord = {
1711
+ [key: string]: RecordID | string | boolean | number | string[] | number[] | DateTime | ObjectValue | InputFileArray | InputFileEntry | null;
1712
+ };
1637
1713
  /**
1638
1714
  * Xata Table Record Metadata
1639
1715
  */
@@ -2119,6 +2195,10 @@ type SearchResponse = {
2119
2195
  records: XataRecord$1[];
2120
2196
  warning?: string;
2121
2197
  };
2198
+ type RateLimitError = {
2199
+ id?: string;
2200
+ message: string;
2201
+ };
2122
2202
  type SummarizeResponse = {
2123
2203
  summaries: Record<string, any>[];
2124
2204
  };
@@ -2134,7 +2214,7 @@ type AggResponse = {
2134
2214
  type DataPlaneFetcherExtraProps = {
2135
2215
  apiUrl: string;
2136
2216
  workspacesApiUrl: string | WorkspaceApiUrlBuilder;
2137
- fetchImpl: FetchImpl;
2217
+ fetch: FetchImpl;
2138
2218
  apiKey: string;
2139
2219
  trace: TraceFunction;
2140
2220
  signal?: AbortSignal;
@@ -2280,6 +2360,36 @@ type DeleteBranchVariables = {
2280
2360
  * Delete the branch in the database and all its resources
2281
2361
  */
2282
2362
  declare const deleteBranch: (variables: DeleteBranchVariables, signal?: AbortSignal) => Promise<DeleteBranchResponse>;
2363
+ type CopyBranchPathParams = {
2364
+ /**
2365
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
2366
+ */
2367
+ dbBranchName: DBBranchName;
2368
+ workspace: string;
2369
+ region: string;
2370
+ };
2371
+ type CopyBranchError = ErrorWrapper<{
2372
+ status: 400;
2373
+ payload: BadRequestError;
2374
+ } | {
2375
+ status: 401;
2376
+ payload: AuthError;
2377
+ } | {
2378
+ status: 404;
2379
+ payload: SimpleError;
2380
+ }>;
2381
+ type CopyBranchRequestBody = {
2382
+ destinationBranch: string;
2383
+ limit?: number;
2384
+ };
2385
+ type CopyBranchVariables = {
2386
+ body: CopyBranchRequestBody;
2387
+ pathParams: CopyBranchPathParams;
2388
+ } & DataPlaneFetcherExtraProps;
2389
+ /**
2390
+ * Create a copy of the branch
2391
+ */
2392
+ declare const copyBranch: (variables: CopyBranchVariables, signal?: AbortSignal) => Promise<BranchWithCopyID>;
2283
2393
  type UpdateBranchMetadataPathParams = {
2284
2394
  /**
2285
2395
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
@@ -2924,7 +3034,7 @@ type MergeMigrationRequestError = ErrorWrapper<{
2924
3034
  type MergeMigrationRequestVariables = {
2925
3035
  pathParams: MergeMigrationRequestPathParams;
2926
3036
  } & DataPlaneFetcherExtraProps;
2927
- declare const mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal) => Promise<Commit>;
3037
+ declare const mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal) => Promise<BranchOp>;
2928
3038
  type GetBranchSchemaHistoryPathParams = {
2929
3039
  /**
2930
3040
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
@@ -3121,6 +3231,32 @@ type ApplyBranchSchemaEditVariables = {
3121
3231
  pathParams: ApplyBranchSchemaEditPathParams;
3122
3232
  } & DataPlaneFetcherExtraProps;
3123
3233
  declare const applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
3234
+ type PushBranchMigrationsPathParams = {
3235
+ /**
3236
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
3237
+ */
3238
+ dbBranchName: DBBranchName;
3239
+ workspace: string;
3240
+ region: string;
3241
+ };
3242
+ type PushBranchMigrationsError = ErrorWrapper<{
3243
+ status: 400;
3244
+ payload: BadRequestError;
3245
+ } | {
3246
+ status: 401;
3247
+ payload: AuthError;
3248
+ } | {
3249
+ status: 404;
3250
+ payload: SimpleError;
3251
+ }>;
3252
+ type PushBranchMigrationsRequestBody = {
3253
+ migrations: MigrationObject[];
3254
+ };
3255
+ type PushBranchMigrationsVariables = {
3256
+ body: PushBranchMigrationsRequestBody;
3257
+ pathParams: PushBranchMigrationsPathParams;
3258
+ } & DataPlaneFetcherExtraProps;
3259
+ declare const pushBranchMigrations: (variables: PushBranchMigrationsVariables, signal?: AbortSignal) => Promise<SchemaUpdateResponse>;
3124
3260
  type CreateTablePathParams = {
3125
3261
  /**
3126
3262
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
@@ -3527,7 +3663,7 @@ type InsertRecordError = ErrorWrapper<{
3527
3663
  payload: SimpleError;
3528
3664
  }>;
3529
3665
  type InsertRecordVariables = {
3530
- body?: Record<string, any>;
3666
+ body?: DataInputRecord;
3531
3667
  pathParams: InsertRecordPathParams;
3532
3668
  queryParams?: InsertRecordQueryParams;
3533
3669
  } & DataPlaneFetcherExtraProps;
@@ -3613,7 +3749,7 @@ type InsertRecordWithIDError = ErrorWrapper<{
3613
3749
  payload: SimpleError;
3614
3750
  }>;
3615
3751
  type InsertRecordWithIDVariables = {
3616
- body?: Record<string, any>;
3752
+ body?: DataInputRecord;
3617
3753
  pathParams: InsertRecordWithIDPathParams;
3618
3754
  queryParams?: InsertRecordWithIDQueryParams;
3619
3755
  } & DataPlaneFetcherExtraProps;
@@ -3658,7 +3794,7 @@ type UpdateRecordWithIDError = ErrorWrapper<{
3658
3794
  payload: SimpleError;
3659
3795
  }>;
3660
3796
  type UpdateRecordWithIDVariables = {
3661
- body?: Record<string, any>;
3797
+ body?: DataInputRecord;
3662
3798
  pathParams: UpdateRecordWithIDPathParams;
3663
3799
  queryParams?: UpdateRecordWithIDQueryParams;
3664
3800
  } & DataPlaneFetcherExtraProps;
@@ -3700,7 +3836,7 @@ type UpsertRecordWithIDError = ErrorWrapper<{
3700
3836
  payload: SimpleError;
3701
3837
  }>;
3702
3838
  type UpsertRecordWithIDVariables = {
3703
- body?: Record<string, any>;
3839
+ body?: DataInputRecord;
3704
3840
  pathParams: UpsertRecordWithIDPathParams;
3705
3841
  queryParams?: UpsertRecordWithIDQueryParams;
3706
3842
  } & DataPlaneFetcherExtraProps;
@@ -3774,7 +3910,7 @@ type BulkInsertTableRecordsError = ErrorWrapper<{
3774
3910
  payload: SimpleError;
3775
3911
  }>;
3776
3912
  type BulkInsertTableRecordsRequestBody = {
3777
- records: Record<string, any>[];
3913
+ records: DataInputRecord[];
3778
3914
  };
3779
3915
  type BulkInsertTableRecordsVariables = {
3780
3916
  body: BulkInsertTableRecordsRequestBody;
@@ -4475,6 +4611,37 @@ type QueryTableVariables = {
4475
4611
  * }
4476
4612
  * ```
4477
4613
  *
4614
+ * It is also possible to sort results randomly:
4615
+ *
4616
+ * ```json
4617
+ * POST /db/demo:main/tables/table/query
4618
+ * {
4619
+ * "sort": {
4620
+ * "*": "random"
4621
+ * }
4622
+ * }
4623
+ * ```
4624
+ *
4625
+ * Note that a random sort does not apply to a specific column, hence the special column name `"*"`.
4626
+ *
4627
+ * A random sort can be combined with an ascending or descending sort on a specific column:
4628
+ *
4629
+ * ```json
4630
+ * POST /db/demo:main/tables/table/query
4631
+ * {
4632
+ * "sort": [
4633
+ * {
4634
+ * "name": "desc"
4635
+ * },
4636
+ * {
4637
+ * "*": "random"
4638
+ * }
4639
+ * ]
4640
+ * }
4641
+ * ```
4642
+ *
4643
+ * This will sort on the `name` column, breaking ties randomly.
4644
+ *
4478
4645
  * ### Pagination
4479
4646
  *
4480
4647
  * We offer cursor pagination and offset pagination. For queries that are expected to return more than 1000 records,
@@ -4679,6 +4846,46 @@ type SearchTableVariables = {
4679
4846
  * * filtering on columns of type `multiple` is currently unsupported
4680
4847
  */
4681
4848
  declare const searchTable: (variables: SearchTableVariables, signal?: AbortSignal) => Promise<SearchResponse>;
4849
+ type SqlQueryPathParams = {
4850
+ /**
4851
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4852
+ */
4853
+ dbBranchName: DBBranchName;
4854
+ workspace: string;
4855
+ region: string;
4856
+ };
4857
+ type SqlQueryError = ErrorWrapper<{
4858
+ status: 400;
4859
+ payload: BadRequestError;
4860
+ } | {
4861
+ status: 401;
4862
+ payload: AuthError;
4863
+ } | {
4864
+ status: 404;
4865
+ payload: SimpleError;
4866
+ }>;
4867
+ type SqlQueryRequestBody = {
4868
+ /**
4869
+ * The query string.
4870
+ *
4871
+ * @minLength 1
4872
+ */
4873
+ query: string;
4874
+ /**
4875
+ * The consistency level for this request.
4876
+ *
4877
+ * @default strong
4878
+ */
4879
+ consistency?: 'strong' | 'eventual';
4880
+ };
4881
+ type SqlQueryVariables = {
4882
+ body: SqlQueryRequestBody;
4883
+ pathParams: SqlQueryPathParams;
4884
+ } & DataPlaneFetcherExtraProps;
4885
+ /**
4886
+ * Run an SQL query across the database branch.
4887
+ */
4888
+ declare const sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal) => Promise<QueryResponse>;
4682
4889
  type VectorSearchTablePathParams = {
4683
4890
  /**
4684
4891
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
@@ -4708,7 +4915,7 @@ type VectorSearchTableRequestBody = {
4708
4915
  */
4709
4916
  queryVector: number[];
4710
4917
  /**
4711
- * The vector column in which to search.
4918
+ * The vector column in which to search. It must be of type `vector`.
4712
4919
  */
4713
4920
  column: string;
4714
4921
  /**
@@ -4717,7 +4924,7 @@ type VectorSearchTableRequestBody = {
4717
4924
  *
4718
4925
  * @default cosineSimilarity
4719
4926
  */
4720
- spaceFunction?: string;
4927
+ similarityFunction?: string;
4721
4928
  /**
4722
4929
  * Number of results to return.
4723
4930
  *
@@ -4739,6 +4946,90 @@ type VectorSearchTableVariables = {
4739
4946
  * dimension as the vector column.
4740
4947
  */
4741
4948
  declare const vectorSearchTable: (variables: VectorSearchTableVariables, signal?: AbortSignal) => Promise<SearchResponse>;
4949
+ type AskTablePathParams = {
4950
+ /**
4951
+ * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
4952
+ */
4953
+ dbBranchName: DBBranchName;
4954
+ /**
4955
+ * The Table name
4956
+ */
4957
+ tableName: TableName;
4958
+ workspace: string;
4959
+ region: string;
4960
+ };
4961
+ type AskTableError = ErrorWrapper<{
4962
+ status: 400;
4963
+ payload: BadRequestError;
4964
+ } | {
4965
+ status: 401;
4966
+ payload: AuthError;
4967
+ } | {
4968
+ status: 404;
4969
+ payload: SimpleError;
4970
+ } | {
4971
+ status: 429;
4972
+ payload: RateLimitError;
4973
+ }>;
4974
+ type AskTableResponse = {
4975
+ /**
4976
+ * The answer to the input question
4977
+ */
4978
+ answer?: string;
4979
+ };
4980
+ type AskTableRequestBody = {
4981
+ /**
4982
+ * The question you'd like to ask.
4983
+ *
4984
+ * @minLength 3
4985
+ */
4986
+ question: string;
4987
+ /**
4988
+ * The type of search to use. If set to `keyword` (the default), the search can be configured by passing
4989
+ * a `search` object with the following fields. For more details about each, see the Search endpoint documentation.
4990
+ * All fields are optional.
4991
+ * * fuzziness - typo tolerance
4992
+ * * target - columns to search into, and weights.
4993
+ * * prefix - prefix search type.
4994
+ * * filter - pre-filter before searching.
4995
+ * * boosters - control relevancy.
4996
+ * If set to `vector`, a `vectorSearch` object must be passed, with the following parameters. For more details, see the Vector
4997
+ * Search endpoint documentation. The `column` and `contentColumn` parameters are required.
4998
+ * * column - the vector column containing the embeddings.
4999
+ * * contentColumn - the column that contains the text from which the embeddings where computed.
5000
+ * * filter - pre-filter before searching.
5001
+ *
5002
+ * @default keyword
5003
+ */
5004
+ searchType?: 'keyword' | 'vector';
5005
+ search?: {
5006
+ fuzziness?: FuzzinessExpression;
5007
+ target?: TargetExpression;
5008
+ prefix?: PrefixExpression;
5009
+ filter?: FilterExpression;
5010
+ boosters?: BoosterExpression[];
5011
+ };
5012
+ vectorSearch?: {
5013
+ /**
5014
+ * The column to use for vector search. It must be of type `vector`.
5015
+ */
5016
+ column: string;
5017
+ /**
5018
+ * The column containing the text for vector search. Must be of type `text`.
5019
+ */
5020
+ contentColumn: string;
5021
+ filter?: FilterExpression;
5022
+ };
5023
+ rules?: string[];
5024
+ };
5025
+ type AskTableVariables = {
5026
+ body: AskTableRequestBody;
5027
+ pathParams: AskTablePathParams;
5028
+ } & DataPlaneFetcherExtraProps;
5029
+ /**
5030
+ * Ask your table a question. If the `Accept` header is set to `text/event-stream`, Xata will stream the results back as SSE's.
5031
+ */
5032
+ declare const askTable: (variables: AskTableVariables, signal?: AbortSignal) => Promise<AskTableResponse>;
4742
5033
  type SummarizeTablePathParams = {
4743
5034
  /**
4744
5035
  * The DBBranchName matches the pattern `{db_name}:{branch_name}`.
@@ -4885,7 +5176,7 @@ type AggregateTableVariables = {
4885
5176
  pathParams: AggregateTablePathParams;
4886
5177
  } & DataPlaneFetcherExtraProps;
4887
5178
  /**
4888
- * This endpoint allows you to run aggragations (analytics) on the data from one table.
5179
+ * This endpoint allows you to run aggregations (analytics) on the data from one table.
4889
5180
  * While the summary endpoint is served from a transactional store and the results are strongly
4890
5181
  * consistent, the aggregate endpoint is served from our columnar store and the results are
4891
5182
  * only eventually consistent. On the other hand, the aggregate endpoint uses a
@@ -4902,6 +5193,7 @@ declare const operationsByTag: {
4902
5193
  getBranchDetails: (variables: GetBranchDetailsVariables, signal?: AbortSignal | undefined) => Promise<DBBranch>;
4903
5194
  createBranch: (variables: CreateBranchVariables, signal?: AbortSignal | undefined) => Promise<CreateBranchResponse>;
4904
5195
  deleteBranch: (variables: DeleteBranchVariables, signal?: AbortSignal | undefined) => Promise<DeleteBranchResponse>;
5196
+ copyBranch: (variables: CopyBranchVariables, signal?: AbortSignal | undefined) => Promise<BranchWithCopyID>;
4905
5197
  updateBranchMetadata: (variables: UpdateBranchMetadataVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
4906
5198
  getBranchMetadata: (variables: GetBranchMetadataVariables, signal?: AbortSignal | undefined) => Promise<BranchMetadata>;
4907
5199
  getBranchStats: (variables: GetBranchStatsVariables, signal?: AbortSignal | undefined) => Promise<GetBranchStatsResponse>;
@@ -4910,16 +5202,6 @@ declare const operationsByTag: {
4910
5202
  removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables, signal?: AbortSignal | undefined) => Promise<undefined>;
4911
5203
  resolveBranch: (variables: ResolveBranchVariables, signal?: AbortSignal | undefined) => Promise<ResolveBranchResponse>;
4912
5204
  };
4913
- records: {
4914
- branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal | undefined) => Promise<TransactionSuccess>;
4915
- insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
4916
- getRecord: (variables: GetRecordVariables, signal?: AbortSignal | undefined) => Promise<XataRecord$1>;
4917
- insertRecordWithID: (variables: InsertRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
4918
- updateRecordWithID: (variables: UpdateRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
4919
- upsertRecordWithID: (variables: UpsertRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
4920
- deleteRecord: (variables: DeleteRecordVariables, signal?: AbortSignal | undefined) => Promise<XataRecord$1>;
4921
- bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables, signal?: AbortSignal | undefined) => Promise<BulkInsertResponse>;
4922
- };
4923
5205
  migrations: {
4924
5206
  getBranchMigrationHistory: (variables: GetBranchMigrationHistoryVariables, signal?: AbortSignal | undefined) => Promise<GetBranchMigrationHistoryResponse>;
4925
5207
  getBranchMigrationPlan: (variables: GetBranchMigrationPlanVariables, signal?: AbortSignal | undefined) => Promise<BranchMigrationPlan>;
@@ -4930,6 +5212,17 @@ declare const operationsByTag: {
4930
5212
  updateBranchSchema: (variables: UpdateBranchSchemaVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
4931
5213
  previewBranchSchemaEdit: (variables: PreviewBranchSchemaEditVariables, signal?: AbortSignal | undefined) => Promise<PreviewBranchSchemaEditResponse>;
4932
5214
  applyBranchSchemaEdit: (variables: ApplyBranchSchemaEditVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
5215
+ pushBranchMigrations: (variables: PushBranchMigrationsVariables, signal?: AbortSignal | undefined) => Promise<SchemaUpdateResponse>;
5216
+ };
5217
+ records: {
5218
+ branchTransaction: (variables: BranchTransactionVariables, signal?: AbortSignal | undefined) => Promise<TransactionSuccess>;
5219
+ insertRecord: (variables: InsertRecordVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
5220
+ getRecord: (variables: GetRecordVariables, signal?: AbortSignal | undefined) => Promise<XataRecord$1>;
5221
+ insertRecordWithID: (variables: InsertRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
5222
+ updateRecordWithID: (variables: UpdateRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
5223
+ upsertRecordWithID: (variables: UpsertRecordWithIDVariables, signal?: AbortSignal | undefined) => Promise<RecordUpdateResponse>;
5224
+ deleteRecord: (variables: DeleteRecordVariables, signal?: AbortSignal | undefined) => Promise<XataRecord$1>;
5225
+ bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables, signal?: AbortSignal | undefined) => Promise<BulkInsertResponse>;
4933
5226
  };
4934
5227
  migrationRequests: {
4935
5228
  queryMigrationRequests: (variables: QueryMigrationRequestsVariables, signal?: AbortSignal | undefined) => Promise<QueryMigrationRequestsResponse>;
@@ -4939,7 +5232,7 @@ declare const operationsByTag: {
4939
5232
  listMigrationRequestsCommits: (variables: ListMigrationRequestsCommitsVariables, signal?: AbortSignal | undefined) => Promise<ListMigrationRequestsCommitsResponse>;
4940
5233
  compareMigrationRequest: (variables: CompareMigrationRequestVariables, signal?: AbortSignal | undefined) => Promise<SchemaCompareResponse>;
4941
5234
  getMigrationRequestIsMerged: (variables: GetMigrationRequestIsMergedVariables, signal?: AbortSignal | undefined) => Promise<GetMigrationRequestIsMergedResponse>;
4942
- mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal | undefined) => Promise<Commit>;
5235
+ mergeMigrationRequest: (variables: MergeMigrationRequestVariables, signal?: AbortSignal | undefined) => Promise<BranchOp>;
4943
5236
  };
4944
5237
  table: {
4945
5238
  createTable: (variables: CreateTableVariables, signal?: AbortSignal | undefined) => Promise<CreateTableResponse>;
@@ -4957,7 +5250,9 @@ declare const operationsByTag: {
4957
5250
  queryTable: (variables: QueryTableVariables, signal?: AbortSignal | undefined) => Promise<QueryResponse>;
4958
5251
  searchBranch: (variables: SearchBranchVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
4959
5252
  searchTable: (variables: SearchTableVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
5253
+ sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal | undefined) => Promise<QueryResponse>;
4960
5254
  vectorSearchTable: (variables: VectorSearchTableVariables, signal?: AbortSignal | undefined) => Promise<SearchResponse>;
5255
+ askTable: (variables: AskTableVariables, signal?: AbortSignal | undefined) => Promise<AskTableResponse>;
4961
5256
  summarizeTable: (variables: SummarizeTableVariables, signal?: AbortSignal | undefined) => Promise<SummarizeResponse>;
4962
5257
  aggregateTable: (variables: AggregateTableVariables, signal?: AbortSignal | undefined) => Promise<AggResponse>;
4963
5258
  };
@@ -5001,7 +5296,7 @@ declare const operationsByTag: {
5001
5296
  };
5002
5297
  };
5003
5298
 
5004
- type HostAliases = 'production' | 'staging';
5299
+ type HostAliases = 'production' | 'staging' | 'dev';
5005
5300
  type ProviderBuilder = {
5006
5301
  main: string;
5007
5302
  workspaces: string;
@@ -5011,6 +5306,7 @@ declare function getHostUrl(provider: HostProvider, type: keyof ProviderBuilder)
5011
5306
  declare function isHostProviderAlias(alias: HostProvider | string): alias is HostAliases;
5012
5307
  declare function isHostProviderBuilder(builder: HostProvider): builder is ProviderBuilder;
5013
5308
  declare function parseProviderString(provider?: string): HostProvider | null;
5309
+ declare function buildProviderString(provider: HostProvider): string;
5014
5310
  declare function parseWorkspacesUrlParts(url: string): {
5015
5311
  workspace: string;
5016
5312
  region: string;
@@ -5023,6 +5319,7 @@ type responses_BranchMigrationPlan = BranchMigrationPlan;
5023
5319
  type responses_BulkError = BulkError;
5024
5320
  type responses_BulkInsertResponse = BulkInsertResponse;
5025
5321
  type responses_QueryResponse = QueryResponse;
5322
+ type responses_RateLimitError = RateLimitError;
5026
5323
  type responses_RecordResponse = RecordResponse;
5027
5324
  type responses_RecordUpdateResponse = RecordUpdateResponse;
5028
5325
  type responses_SchemaCompareResponse = SchemaCompareResponse;
@@ -5039,6 +5336,7 @@ declare namespace responses {
5039
5336
  responses_BulkError as BulkError,
5040
5337
  responses_BulkInsertResponse as BulkInsertResponse,
5041
5338
  responses_QueryResponse as QueryResponse,
5339
+ responses_RateLimitError as RateLimitError,
5042
5340
  responses_RecordResponse as RecordResponse,
5043
5341
  responses_RecordUpdateResponse as RecordUpdateResponse,
5044
5342
  responses_SchemaCompareResponse as SchemaCompareResponse,
@@ -5058,6 +5356,8 @@ type schemas_Branch = Branch;
5058
5356
  type schemas_BranchMetadata = BranchMetadata;
5059
5357
  type schemas_BranchMigration = BranchMigration;
5060
5358
  type schemas_BranchName = BranchName;
5359
+ type schemas_BranchOp = BranchOp;
5360
+ type schemas_BranchWithCopyID = BranchWithCopyID;
5061
5361
  type schemas_Column = Column;
5062
5362
  type schemas_ColumnLink = ColumnLink;
5063
5363
  type schemas_ColumnMigration = ColumnMigration;
@@ -5072,6 +5372,7 @@ type schemas_CountAgg = CountAgg;
5072
5372
  type schemas_DBBranch = DBBranch;
5073
5373
  type schemas_DBBranchName = DBBranchName;
5074
5374
  type schemas_DBName = DBName;
5375
+ type schemas_DataInputRecord = DataInputRecord;
5075
5376
  type schemas_DatabaseGithubSettings = DatabaseGithubSettings;
5076
5377
  type schemas_DatabaseMetadata = DatabaseMetadata;
5077
5378
  type schemas_DateHistogramAgg = DateHistogramAgg;
@@ -5087,6 +5388,8 @@ type schemas_FilterRangeValue = FilterRangeValue;
5087
5388
  type schemas_FilterValue = FilterValue;
5088
5389
  type schemas_FuzzinessExpression = FuzzinessExpression;
5089
5390
  type schemas_HighlightExpression = HighlightExpression;
5391
+ type schemas_InputFileArray = InputFileArray;
5392
+ type schemas_InputFileEntry = InputFileEntry;
5090
5393
  type schemas_InviteID = InviteID;
5091
5394
  type schemas_InviteKey = InviteKey;
5092
5395
  type schemas_ListBranchesResponse = ListBranchesResponse;
@@ -5098,6 +5401,7 @@ type schemas_MetricsDatapoint = MetricsDatapoint;
5098
5401
  type schemas_MetricsLatency = MetricsLatency;
5099
5402
  type schemas_Migration = Migration;
5100
5403
  type schemas_MigrationColumnOp = MigrationColumnOp;
5404
+ type schemas_MigrationObject = MigrationObject;
5101
5405
  type schemas_MigrationOp = MigrationOp;
5102
5406
  type schemas_MigrationRequest = MigrationRequest;
5103
5407
  type schemas_MigrationRequestNumber = MigrationRequestNumber;
@@ -5105,6 +5409,7 @@ type schemas_MigrationStatus = MigrationStatus;
5105
5409
  type schemas_MigrationTableOp = MigrationTableOp;
5106
5410
  type schemas_MinAgg = MinAgg;
5107
5411
  type schemas_NumericHistogramAgg = NumericHistogramAgg;
5412
+ type schemas_ObjectValue = ObjectValue;
5108
5413
  type schemas_PageConfig = PageConfig;
5109
5414
  type schemas_PrefixExpression = PrefixExpression;
5110
5415
  type schemas_RecordID = RecordID;
@@ -5163,6 +5468,8 @@ declare namespace schemas {
5163
5468
  schemas_BranchMetadata as BranchMetadata,
5164
5469
  schemas_BranchMigration as BranchMigration,
5165
5470
  schemas_BranchName as BranchName,
5471
+ schemas_BranchOp as BranchOp,
5472
+ schemas_BranchWithCopyID as BranchWithCopyID,
5166
5473
  schemas_Column as Column,
5167
5474
  schemas_ColumnLink as ColumnLink,
5168
5475
  schemas_ColumnMigration as ColumnMigration,
@@ -5177,6 +5484,7 @@ declare namespace schemas {
5177
5484
  schemas_DBBranch as DBBranch,
5178
5485
  schemas_DBBranchName as DBBranchName,
5179
5486
  schemas_DBName as DBName,
5487
+ schemas_DataInputRecord as DataInputRecord,
5180
5488
  schemas_DatabaseGithubSettings as DatabaseGithubSettings,
5181
5489
  schemas_DatabaseMetadata as DatabaseMetadata,
5182
5490
  DateBooster$1 as DateBooster,
@@ -5193,6 +5501,8 @@ declare namespace schemas {
5193
5501
  schemas_FilterValue as FilterValue,
5194
5502
  schemas_FuzzinessExpression as FuzzinessExpression,
5195
5503
  schemas_HighlightExpression as HighlightExpression,
5504
+ schemas_InputFileArray as InputFileArray,
5505
+ schemas_InputFileEntry as InputFileEntry,
5196
5506
  schemas_InviteID as InviteID,
5197
5507
  schemas_InviteKey as InviteKey,
5198
5508
  schemas_ListBranchesResponse as ListBranchesResponse,
@@ -5204,6 +5514,7 @@ declare namespace schemas {
5204
5514
  schemas_MetricsLatency as MetricsLatency,
5205
5515
  schemas_Migration as Migration,
5206
5516
  schemas_MigrationColumnOp as MigrationColumnOp,
5517
+ schemas_MigrationObject as MigrationObject,
5207
5518
  schemas_MigrationOp as MigrationOp,
5208
5519
  schemas_MigrationRequest as MigrationRequest,
5209
5520
  schemas_MigrationRequestNumber as MigrationRequestNumber,
@@ -5212,6 +5523,7 @@ declare namespace schemas {
5212
5523
  schemas_MinAgg as MinAgg,
5213
5524
  NumericBooster$1 as NumericBooster,
5214
5525
  schemas_NumericHistogramAgg as NumericHistogramAgg,
5526
+ schemas_ObjectValue as ObjectValue,
5215
5527
  schemas_PageConfig as PageConfig,
5216
5528
  schemas_PrefixExpression as PrefixExpression,
5217
5529
  schemas_RecordID as RecordID,
@@ -5392,6 +5704,14 @@ declare class BranchApi {
5392
5704
  database: DBName;
5393
5705
  branch: BranchName;
5394
5706
  }): Promise<DeleteBranchResponse>;
5707
+ copyBranch({ workspace, region, database, branch, destinationBranch, limit }: {
5708
+ workspace: WorkspaceID;
5709
+ region: string;
5710
+ database: DBName;
5711
+ branch: BranchName;
5712
+ destinationBranch: BranchName;
5713
+ limit?: number;
5714
+ }): Promise<BranchWithCopyID>;
5395
5715
  updateBranchMetadata({ workspace, region, database, branch, metadata }: {
5396
5716
  workspace: WorkspaceID;
5397
5717
  region: string;
@@ -5644,6 +5964,26 @@ declare class SearchAndFilterApi {
5644
5964
  prefix?: PrefixExpression;
5645
5965
  highlight?: HighlightExpression;
5646
5966
  }): Promise<SearchResponse>;
5967
+ vectorSearchTable({ workspace, region, database, branch, table, queryVector, column, similarityFunction, size, filter }: {
5968
+ workspace: WorkspaceID;
5969
+ region: string;
5970
+ database: DBName;
5971
+ branch: BranchName;
5972
+ table: TableName;
5973
+ queryVector: number[];
5974
+ column: string;
5975
+ similarityFunction?: string;
5976
+ size?: number;
5977
+ filter?: FilterExpression;
5978
+ }): Promise<SearchResponse>;
5979
+ askTable({ workspace, region, database, branch, table, options }: {
5980
+ workspace: WorkspaceID;
5981
+ region: string;
5982
+ database: DBName;
5983
+ branch: BranchName;
5984
+ table: TableName;
5985
+ options: AskTableRequestBody;
5986
+ }): Promise<AskTableResponse>;
5647
5987
  summarizeTable({ workspace, region, database, branch, table, filter, columns, summaries, sort, summariesFilter, page, consistency }: {
5648
5988
  workspace: WorkspaceID;
5649
5989
  region: string;
@@ -5729,7 +6069,7 @@ declare class MigrationRequestsApi {
5729
6069
  region: string;
5730
6070
  database: DBName;
5731
6071
  migrationRequest: MigrationRequestNumber;
5732
- }): Promise<Commit>;
6072
+ }): Promise<BranchOp>;
5733
6073
  }
5734
6074
  declare class MigrationsApi {
5735
6075
  private extraProps;
@@ -5808,6 +6148,13 @@ declare class MigrationsApi {
5808
6148
  branch: BranchName;
5809
6149
  edits: SchemaEditScript;
5810
6150
  }): Promise<SchemaUpdateResponse>;
6151
+ pushBranchMigrations({ workspace, region, database, branch, migrations }: {
6152
+ workspace: WorkspaceID;
6153
+ region: string;
6154
+ database: DBName;
6155
+ branch: BranchName;
6156
+ migrations: MigrationObject[];
6157
+ }): Promise<SchemaUpdateResponse>;
5811
6158
  }
5812
6159
  declare class DatabaseApi {
5813
6160
  private extraProps;
@@ -5852,7 +6199,7 @@ declare class DatabaseApi {
5852
6199
  }
5853
6200
 
5854
6201
  declare class XataApiPlugin implements XataPlugin {
5855
- build(options: XataPluginOptions): Promise<XataApiClient>;
6202
+ build(options: XataPluginOptions): XataApiClient;
5856
6203
  }
5857
6204
 
5858
6205
  type StringKeys<O> = Extract<keyof O, string>;
@@ -6017,11 +6364,20 @@ type XataRecordMetadata = {
6017
6364
  };
6018
6365
  declare function isIdentifiable(x: any): x is Identifiable & Record<string, unknown>;
6019
6366
  declare function isXataRecord(x: any): x is XataRecord & Record<string, unknown>;
6367
+ type NumericOperator = ExclusiveOr<{
6368
+ $increment?: number;
6369
+ }, ExclusiveOr<{
6370
+ $decrement?: number;
6371
+ }, ExclusiveOr<{
6372
+ $multiply?: number;
6373
+ }, {
6374
+ $divide?: number;
6375
+ }>>>;
6020
6376
  type EditableDataFields<T> = T extends XataRecord ? {
6021
6377
  id: string;
6022
6378
  } | string : NonNullable<T> extends XataRecord ? {
6023
6379
  id: string;
6024
- } | string | null | undefined : T extends Date ? string | Date : NonNullable<T> extends Date ? string | Date | null | undefined : T;
6380
+ } | string | null | undefined : T extends Date ? string | Date : NonNullable<T> extends Date ? string | Date | null | undefined : T extends number ? number | NumericOperator : T;
6025
6381
  type EditableData<O extends XataRecord> = Identifiable & Partial<Omit<{
6026
6382
  [K in keyof O]: EditableDataFields<O[K]>;
6027
6383
  }, keyof XataRecord>>;
@@ -6244,7 +6600,7 @@ declare class SearchPlugin<Schemas extends Record<string, XataRecord>> extends X
6244
6600
  #private;
6245
6601
  private db;
6246
6602
  constructor(db: SchemaPluginResult<Schemas>, schemaTables?: Table[]);
6247
- build({ getFetchProps }: XataPluginOptions): SearchPluginResult<Schemas>;
6603
+ build(pluginOptions: XataPluginOptions): SearchPluginResult<Schemas>;
6248
6604
  }
6249
6605
  type SearchXataRecord<Record extends XataRecord> = Omit<Record, 'getMetadata'> & {
6250
6606
  getMetadata: () => XataRecordMetadata & SearchExtraProperties;
@@ -6434,12 +6790,53 @@ type ComplexAggregationResult = {
6434
6790
  }>;
6435
6791
  };
6436
6792
 
6793
+ type KeywordAskOptions<Record extends XataRecord> = {
6794
+ searchType: 'keyword';
6795
+ search?: {
6796
+ fuzziness?: FuzzinessExpression;
6797
+ target?: TargetColumn<Record>[];
6798
+ prefix?: PrefixExpression;
6799
+ filter?: Filter<Record>;
6800
+ boosters?: Boosters<Record>[];
6801
+ };
6802
+ };
6803
+ type VectorAskOptions<Record extends XataRecord> = {
6804
+ searchType: 'vector';
6805
+ vectorSearch?: {
6806
+ /**
6807
+ * The column to use for vector search. It must be of type `vector`.
6808
+ */
6809
+ column: string;
6810
+ /**
6811
+ * The column containing the text for vector search. Must be of type `text`.
6812
+ */
6813
+ contentColumn: string;
6814
+ filter?: Filter<Record>;
6815
+ };
6816
+ };
6817
+ type TypeAskOptions<Record extends XataRecord> = KeywordAskOptions<Record> | VectorAskOptions<Record>;
6818
+ type BaseAskOptions = {
6819
+ rules?: string[];
6820
+ };
6821
+ type AskOptions<Record extends XataRecord> = TypeAskOptions<Record> & BaseAskOptions;
6822
+ type AskResult = {
6823
+ answer?: string;
6824
+ records?: string[];
6825
+ };
6826
+
6437
6827
  type SortDirection = 'asc' | 'desc';
6438
- type SortFilterExtended<T extends XataRecord, Columns extends string = ColumnsByValue<T, any>> = {
6828
+ type RandomFilter = {
6829
+ '*': 'random';
6830
+ };
6831
+ type RandomFilterExtended = {
6832
+ column: '*';
6833
+ direction: 'random';
6834
+ };
6835
+ type SortFilterExtended<T extends XataRecord, Columns extends string = ColumnsByValue<T, any>> = RandomFilterExtended | {
6439
6836
  column: Columns;
6440
6837
  direction?: SortDirection;
6441
6838
  };
6442
- type SortFilter<T extends XataRecord, Columns extends string = ColumnsByValue<T, any>> = Columns | SortFilterExtended<T, Columns> | SortFilterBase<T, Columns>;
6839
+ type SortFilter<T extends XataRecord, Columns extends string = ColumnsByValue<T, any>> = Columns | SortFilterExtended<T, Columns> | SortFilterBase<T, Columns> | RandomFilter;
6443
6840
  type SortFilterBase<T extends XataRecord, Columns extends string = ColumnsByValue<T, any>> = Values<{
6444
6841
  [Key in Columns]: {
6445
6842
  [K in Key]: SortDirection;
@@ -6571,7 +6968,9 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
6571
6968
  * @param direction The direction. Either ascending or descending.
6572
6969
  * @returns A new Query object.
6573
6970
  */
6574
- sort<F extends ColumnsByValue<Record, any>>(column: F, direction?: SortDirection): Query<Record, Result>;
6971
+ sort<F extends ColumnsByValue<Record, any>>(column: F, direction: SortDirection): Query<Record, Result>;
6972
+ sort(column: '*', direction: 'random'): Query<Record, Result>;
6973
+ sort<F extends ColumnsByValue<Record, any>>(column: F): Query<Record, Result>;
6575
6974
  /**
6576
6975
  * Builds a new query specifying the set of columns to be returned in the query response.
6577
6976
  * @param columns Array of column names to be returned by the query.
@@ -6597,7 +6996,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
6597
6996
  * @param options Pagination options
6598
6997
  * @returns A page of results
6599
6998
  */
6600
- getPaginated<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<Page<Record, SelectedPick<Record, typeof options['columns']>>>;
6999
+ getPaginated<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<Page<Record, SelectedPick<Record, (typeof options)['columns']>>>;
6601
7000
  /**
6602
7001
  * Get results in an iterator
6603
7002
  *
@@ -6628,7 +7027,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
6628
7027
  */
6629
7028
  getIterator<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
6630
7029
  batchSize?: number;
6631
- }>(options: Options): AsyncGenerator<SelectedPick<Record, typeof options['columns']>[]>;
7030
+ }>(options: Options): AsyncGenerator<SelectedPick<Record, (typeof options)['columns']>[]>;
6632
7031
  /**
6633
7032
  * Performs the query in the database and returns a set of results.
6634
7033
  * @returns An array of records from the database.
@@ -6639,7 +7038,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
6639
7038
  * @param options Additional options to be used when performing the query.
6640
7039
  * @returns An array of records from the database.
6641
7040
  */
6642
- getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<RecordArray<SelectedPick<Record, typeof options['columns']>>>;
7041
+ getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<RecordArray<SelectedPick<Record, (typeof options)['columns']>>>;
6643
7042
  /**
6644
7043
  * Performs the query in the database and returns a set of results.
6645
7044
  * @param options Additional options to be used when performing the query.
@@ -6660,7 +7059,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
6660
7059
  */
6661
7060
  getAll<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
6662
7061
  batchSize?: number;
6663
- }>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>[]>;
7062
+ }>(options: Options): Promise<SelectedPick<Record, (typeof options)['columns']>[]>;
6664
7063
  /**
6665
7064
  * Performs the query in the database and returns all the results.
6666
7065
  * Warning: If there are a large number of results, this method can have performance implications.
@@ -6680,7 +7079,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
6680
7079
  * @param options Additional options to be used when performing the query.
6681
7080
  * @returns The first record that matches the query, or null if no record matched the query.
6682
7081
  */
6683
- getFirst<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']> | null>;
7082
+ getFirst<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, (typeof options)['columns']> | null>;
6684
7083
  /**
6685
7084
  * Performs the query in the database and returns the first result.
6686
7085
  * @param options Additional options to be used when performing the query.
@@ -6699,7 +7098,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
6699
7098
  * @returns The first record that matches the query, or null if no record matched the query.
6700
7099
  * @throws if there are no results.
6701
7100
  */
6702
- getFirstOrThrow<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>>;
7101
+ getFirstOrThrow<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, (typeof options)['columns']>>;
6703
7102
  /**
6704
7103
  * Performs the query in the database and returns the first result.
6705
7104
  * @param options Additional options to be used when performing the query.
@@ -7364,15 +7763,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7364
7763
  * @param query The vector to search for similarities. Must have the same dimension as the vector column used.
7365
7764
  * @param options The options to search with (like: spaceFunction)
7366
7765
  */
7367
- abstract vectorSearch<F extends SelectableColumn<Record>>(column: F, // TODO: check if column is a vector column
7368
- query: number[], options?: {
7766
+ abstract vectorSearch<F extends ColumnsByValue<Record, number[]>>(column: F, query: number[], options?: {
7369
7767
  /**
7370
7768
  * The function used to measure the distance between two points. Can be one of:
7371
7769
  * `cosineSimilarity`, `l1`, `l2`. The default is `cosineSimilarity`.
7372
7770
  *
7373
7771
  * @default cosineSimilarity
7374
7772
  */
7375
- spaceFunction?: string;
7773
+ similarityFunction?: string;
7376
7774
  /**
7377
7775
  * Number of results to return.
7378
7776
  *
@@ -7381,7 +7779,7 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7381
7779
  * @minimum 1
7382
7780
  */
7383
7781
  size?: number;
7384
- filter?: Filter<NonNullable<ValueAtColumn<Record, F>>>;
7782
+ filter?: Filter<Record>;
7385
7783
  }): Promise<SearchXataRecord<SelectedPick<Record, ['*']>>[]>;
7386
7784
  /**
7387
7785
  * Aggregates records in the table.
@@ -7390,6 +7788,16 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
7390
7788
  * @returns The requested aggregations.
7391
7789
  */
7392
7790
  abstract aggregate<Expression extends Dictionary<AggregationExpression<Record>>>(expression?: Expression, filter?: Filter<Record>): Promise<AggregationResult<Record, Expression>>;
7791
+ /**
7792
+ * Experimental: Ask the database to perform a natural language question.
7793
+ */
7794
+ abstract ask(question: string, options?: AskOptions<Record>): Promise<AskResult>;
7795
+ /**
7796
+ * Experimental: Ask the database to perform a natural language question.
7797
+ */
7798
+ abstract ask(question: string, options: AskOptions<Record> & {
7799
+ onMessage: (message: AskResult) => void;
7800
+ }): void;
7393
7801
  abstract query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
7394
7802
  }
7395
7803
  declare class RestRepository<Record extends XataRecord> extends Query<Record, SelectedPick<Record, ['*']>> implements Repository<Record> {
@@ -7511,14 +7919,17 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
7511
7919
  page?: SearchPageConfig;
7512
7920
  target?: TargetColumn<Record>[];
7513
7921
  }): Promise<any>;
7514
- vectorSearch<F extends SelectableColumn<Record, []>>(column: F, query: number[], options?: {
7515
- spaceFunction?: string | undefined;
7922
+ vectorSearch<F extends ColumnsByValue<Record, number[]>>(column: F, query: number[], options?: {
7923
+ similarityFunction?: string | undefined;
7516
7924
  size?: number | undefined;
7517
- filter?: Filter<NonNullable<ValueAtColumn<Record, F>>> | undefined;
7925
+ filter?: Filter<Record> | undefined;
7518
7926
  } | undefined): Promise<SearchXataRecord<SelectedPick<Record, ['*']>>[]>;
7519
7927
  aggregate<Expression extends Dictionary<AggregationExpression<Record>>>(aggs?: Expression, filter?: Filter<Record>): Promise<any>;
7520
7928
  query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
7521
7929
  summarizeTable<Result extends XataRecord>(query: Query<Record, Result>, summaries?: Dictionary<SummarizeExpression<Record>>, summariesFilter?: FilterExpression): Promise<SummarizeResponse>;
7930
+ ask(question: string, options?: AskOptions<Record> & {
7931
+ onMessage?: (message: AskResult) => void;
7932
+ }): any;
7522
7933
  }
7523
7934
 
7524
7935
  type BaseSchema = {
@@ -7772,19 +8183,15 @@ type TransactionPluginResult<Schemas extends Record<string, XataRecord>> = {
7772
8183
  run: <Tables extends StringKeys<Schemas>, Operations extends TransactionOperation<Schemas, Tables>[]>(operations: Narrow<Operations>) => Promise<TransactionResults<Schemas, Tables, Operations>>;
7773
8184
  };
7774
8185
  declare class TransactionPlugin<Schemas extends Record<string, XataRecord>> extends XataPlugin {
7775
- build({ getFetchProps }: XataPluginOptions): TransactionPluginResult<Schemas>;
8186
+ build(pluginOptions: XataPluginOptions): TransactionPluginResult<Schemas>;
7776
8187
  }
7777
8188
 
7778
- type BranchStrategyValue = string | undefined | null;
7779
- type BranchStrategyBuilder = () => BranchStrategyValue | Promise<BranchStrategyValue>;
7780
- type BranchStrategy = BranchStrategyValue | BranchStrategyBuilder;
7781
- type BranchStrategyOption = NonNullable<BranchStrategy | BranchStrategy[]>;
7782
-
7783
8189
  type BaseClientOptions = {
7784
8190
  fetch?: FetchImpl;
8191
+ host?: HostProvider;
7785
8192
  apiKey?: string;
7786
8193
  databaseURL?: string;
7787
- branch?: BranchStrategyOption;
8194
+ branch?: string;
7788
8195
  cache?: CacheImpl;
7789
8196
  trace?: TraceFunction;
7790
8197
  enableBrowser?: boolean;
@@ -7826,18 +8233,14 @@ type SerializerResult<T> = T extends XataRecord ? Identifiable & Omit<{
7826
8233
  [K in keyof T]: SerializerResult<T[K]>;
7827
8234
  }, keyof XataRecord> : T extends any[] ? SerializerResult<T[number]>[] : T;
7828
8235
 
7829
- type BranchResolutionOptions = {
7830
- databaseURL?: string;
7831
- apiKey?: string;
7832
- fetchImpl?: FetchImpl;
7833
- clientName?: string;
7834
- xataAgentExtra?: Record<string, string>;
7835
- };
7836
- declare function getCurrentBranchName(options?: BranchResolutionOptions): Promise<string>;
7837
- declare function getCurrentBranchDetails(options?: BranchResolutionOptions): Promise<DBBranch | null>;
7838
8236
  declare function getDatabaseURL(): string | undefined;
7839
-
7840
8237
  declare function getAPIKey(): string | undefined;
8238
+ declare function getBranch(): string | undefined;
8239
+ declare function buildPreviewBranchName({ org, branch }: {
8240
+ org: string;
8241
+ branch: string;
8242
+ }): string;
8243
+ declare function getPreviewBranch(): string | undefined;
7841
8244
 
7842
8245
  interface Body {
7843
8246
  arrayBuffer(): Promise<ArrayBuffer>;
@@ -7924,4 +8327,4 @@ declare class XataError extends Error {
7924
8327
  constructor(message: string, status: number);
7925
8328
  }
7926
8329
 
7927
- export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, AggregateTableError, AggregateTablePathParams, AggregateTableRequestBody, AggregateTableVariables, ApiExtraProps, ApplyBranchSchemaEditError, ApplyBranchSchemaEditPathParams, ApplyBranchSchemaEditRequestBody, ApplyBranchSchemaEditVariables, BaseClient, BaseClientOptions, BaseData, BaseSchema, BranchTransactionError, BranchTransactionPathParams, BranchTransactionRequestBody, BranchTransactionVariables, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsQueryParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, ColumnsByValue, CompareBranchSchemasError, CompareBranchSchemasPathParams, CompareBranchSchemasRequestBody, CompareBranchSchemasVariables, CompareBranchWithUserSchemaError, CompareBranchWithUserSchemaPathParams, CompareBranchWithUserSchemaRequestBody, CompareBranchWithUserSchemaVariables, CompareMigrationRequestError, CompareMigrationRequestPathParams, CompareMigrationRequestVariables, CreateBranchError, CreateBranchPathParams, CreateBranchQueryParams, CreateBranchRequestBody, CreateBranchResponse, CreateBranchVariables, CreateDatabaseError, CreateDatabasePathParams, CreateDatabaseRequestBody, CreateDatabaseResponse, CreateDatabaseVariables, CreateMigrationRequestError, CreateMigrationRequestPathParams, CreateMigrationRequestRequestBody, CreateMigrationRequestResponse, CreateMigrationRequestVariables, CreateTableError, CreateTablePathParams, CreateTableResponse, CreateTableVariables, CreateUserAPIKeyError, CreateUserAPIKeyPathParams, CreateUserAPIKeyResponse, CreateUserAPIKeyVariables, CreateWorkspaceError, CreateWorkspaceVariables, CursorNavigationOptions, DeleteBranchError, DeleteBranchPathParams, DeleteBranchResponse, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabaseGithubSettingsError, DeleteDatabaseGithubSettingsPathParams, DeleteDatabaseGithubSettingsVariables, DeleteDatabasePathParams, DeleteDatabaseResponse, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordQueryParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableResponse, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, DeserializedType, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, FetcherError, FetcherExtraProps, GetBranchDetailsError, GetBranchDetailsPathParams, GetBranchDetailsVariables, GetBranchListError, GetBranchListPathParams, GetBranchListVariables, GetBranchMetadataError, GetBranchMetadataPathParams, GetBranchMetadataVariables, GetBranchMigrationHistoryError, GetBranchMigrationHistoryPathParams, GetBranchMigrationHistoryRequestBody, GetBranchMigrationHistoryResponse, GetBranchMigrationHistoryVariables, GetBranchMigrationPlanError, GetBranchMigrationPlanPathParams, GetBranchMigrationPlanVariables, GetBranchSchemaHistoryError, GetBranchSchemaHistoryPathParams, GetBranchSchemaHistoryRequestBody, GetBranchSchemaHistoryResponse, GetBranchSchemaHistoryVariables, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, GetDatabaseGithubSettingsError, GetDatabaseGithubSettingsPathParams, GetDatabaseGithubSettingsVariables, GetDatabaseListError, GetDatabaseListPathParams, GetDatabaseListVariables, GetDatabaseMetadataError, GetDatabaseMetadataPathParams, GetDatabaseMetadataVariables, GetGitBranchesMappingError, GetGitBranchesMappingPathParams, GetGitBranchesMappingVariables, GetMigrationRequestError, GetMigrationRequestIsMergedError, GetMigrationRequestIsMergedPathParams, GetMigrationRequestIsMergedResponse, GetMigrationRequestIsMergedVariables, GetMigrationRequestPathParams, GetMigrationRequestVariables, GetRecordError, GetRecordPathParams, GetRecordQueryParams, GetRecordVariables, GetTableColumnsError, GetTableColumnsPathParams, GetTableColumnsResponse, GetTableColumnsVariables, GetTableSchemaError, GetTableSchemaPathParams, GetTableSchemaResponse, GetTableSchemaVariables, GetUserAPIKeysError, GetUserAPIKeysResponse, GetUserAPIKeysVariables, GetUserError, GetUserVariables, GetWorkspaceError, GetWorkspaceMembersListError, GetWorkspaceMembersListPathParams, GetWorkspaceMembersListVariables, GetWorkspacePathParams, GetWorkspaceVariables, GetWorkspacesListError, GetWorkspacesListResponse, GetWorkspacesListVariables, HostProvider, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordQueryParams, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, Link, ListMigrationRequestsCommitsError, ListMigrationRequestsCommitsPathParams, ListMigrationRequestsCommitsRequestBody, ListMigrationRequestsCommitsResponse, ListMigrationRequestsCommitsVariables, ListRegionsError, ListRegionsPathParams, ListRegionsVariables, MergeMigrationRequestError, MergeMigrationRequestPathParams, MergeMigrationRequestVariables, OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Paginable, PaginationQueryMeta, PreviewBranchSchemaEditError, PreviewBranchSchemaEditPathParams, PreviewBranchSchemaEditRequestBody, PreviewBranchSchemaEditResponse, PreviewBranchSchemaEditVariables, Query, QueryMigrationRequestsError, QueryMigrationRequestsPathParams, QueryMigrationRequestsRequestBody, QueryMigrationRequestsResponse, QueryMigrationRequestsVariables, QueryTableError, QueryTablePathParams, QueryTableRequestBody, QueryTableVariables, RecordArray, RemoveGitBranchesEntryError, RemoveGitBranchesEntryPathParams, RemoveGitBranchesEntryQueryParams, RemoveGitBranchesEntryVariables, RemoveWorkspaceMemberError, RemoveWorkspaceMemberPathParams, RemoveWorkspaceMemberVariables, Repository, ResendWorkspaceMemberInviteError, ResendWorkspaceMemberInvitePathParams, ResendWorkspaceMemberInviteVariables, ResolveBranchError, ResolveBranchPathParams, ResolveBranchQueryParams, ResolveBranchResponse, ResolveBranchVariables, responses as Responses, RestRepository, SchemaDefinition, SchemaInference, SchemaPlugin, SchemaPluginResult, schemas as Schemas, SearchBranchError, SearchBranchPathParams, SearchBranchRequestBody, SearchBranchVariables, SearchOptions, SearchPlugin, SearchPluginResult, SearchTableError, SearchTablePathParams, SearchTableRequestBody, SearchTableVariables, SearchXataRecord, SelectableColumn, SelectedPick, SerializedString, Serializer, SerializerResult, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, SummarizeTableError, SummarizeTablePathParams, SummarizeTableRequestBody, SummarizeTableVariables, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateBranchSchemaError, UpdateBranchSchemaPathParams, UpdateBranchSchemaVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, UpdateDatabaseGithubSettingsError, UpdateDatabaseGithubSettingsPathParams, UpdateDatabaseGithubSettingsVariables, UpdateDatabaseMetadataError, UpdateDatabaseMetadataPathParams, UpdateDatabaseMetadataRequestBody, UpdateDatabaseMetadataVariables, UpdateMigrationRequestError, UpdateMigrationRequestPathParams, UpdateMigrationRequestRequestBody, UpdateMigrationRequestVariables, UpdateRecordWithIDError, UpdateRecordWithIDPathParams, UpdateRecordWithIDQueryParams, UpdateRecordWithIDVariables, UpdateTableError, UpdateTablePathParams, UpdateTableRequestBody, UpdateTableVariables, UpdateUserError, UpdateUserVariables, UpdateWorkspaceError, UpdateWorkspaceMemberInviteError, UpdateWorkspaceMemberInvitePathParams, UpdateWorkspaceMemberInviteRequestBody, UpdateWorkspaceMemberInviteVariables, UpdateWorkspaceMemberRoleError, UpdateWorkspaceMemberRolePathParams, UpdateWorkspaceMemberRoleRequestBody, UpdateWorkspaceMemberRoleVariables, UpdateWorkspacePathParams, UpdateWorkspaceVariables, UpsertRecordWithIDError, UpsertRecordWithIDPathParams, UpsertRecordWithIDQueryParams, UpsertRecordWithIDVariables, ValueAtColumn, VectorSearchTableError, VectorSearchTablePathParams, VectorSearchTableRequestBody, VectorSearchTableVariables, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, branchTransaction, buildClient, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, startsWith, summarizeTable, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID, vectorSearchTable };
8330
+ export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, AggregateTableError, AggregateTablePathParams, AggregateTableRequestBody, AggregateTableVariables, ApiExtraProps, ApplyBranchSchemaEditError, ApplyBranchSchemaEditPathParams, ApplyBranchSchemaEditRequestBody, ApplyBranchSchemaEditVariables, AskOptions, AskResult, AskTableError, AskTablePathParams, AskTableRequestBody, AskTableResponse, AskTableVariables, BaseClient, BaseClientOptions, BaseData, BaseSchema, BranchTransactionError, BranchTransactionPathParams, BranchTransactionRequestBody, BranchTransactionVariables, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsQueryParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, ColumnsByValue, CompareBranchSchemasError, CompareBranchSchemasPathParams, CompareBranchSchemasRequestBody, CompareBranchSchemasVariables, CompareBranchWithUserSchemaError, CompareBranchWithUserSchemaPathParams, CompareBranchWithUserSchemaRequestBody, CompareBranchWithUserSchemaVariables, CompareMigrationRequestError, CompareMigrationRequestPathParams, CompareMigrationRequestVariables, CopyBranchError, CopyBranchPathParams, CopyBranchRequestBody, CopyBranchVariables, CreateBranchError, CreateBranchPathParams, CreateBranchQueryParams, CreateBranchRequestBody, CreateBranchResponse, CreateBranchVariables, CreateDatabaseError, CreateDatabasePathParams, CreateDatabaseRequestBody, CreateDatabaseResponse, CreateDatabaseVariables, CreateMigrationRequestError, CreateMigrationRequestPathParams, CreateMigrationRequestRequestBody, CreateMigrationRequestResponse, CreateMigrationRequestVariables, CreateTableError, CreateTablePathParams, CreateTableResponse, CreateTableVariables, CreateUserAPIKeyError, CreateUserAPIKeyPathParams, CreateUserAPIKeyResponse, CreateUserAPIKeyVariables, CreateWorkspaceError, CreateWorkspaceVariables, CursorNavigationOptions, DeleteBranchError, DeleteBranchPathParams, DeleteBranchResponse, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabaseGithubSettingsError, DeleteDatabaseGithubSettingsPathParams, DeleteDatabaseGithubSettingsVariables, DeleteDatabasePathParams, DeleteDatabaseResponse, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordQueryParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableResponse, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, DeserializedType, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, FetcherError, FetcherExtraProps, GetBranchDetailsError, GetBranchDetailsPathParams, GetBranchDetailsVariables, GetBranchListError, GetBranchListPathParams, GetBranchListVariables, GetBranchMetadataError, GetBranchMetadataPathParams, GetBranchMetadataVariables, GetBranchMigrationHistoryError, GetBranchMigrationHistoryPathParams, GetBranchMigrationHistoryRequestBody, GetBranchMigrationHistoryResponse, GetBranchMigrationHistoryVariables, GetBranchMigrationPlanError, GetBranchMigrationPlanPathParams, GetBranchMigrationPlanVariables, GetBranchSchemaHistoryError, GetBranchSchemaHistoryPathParams, GetBranchSchemaHistoryRequestBody, GetBranchSchemaHistoryResponse, GetBranchSchemaHistoryVariables, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, GetDatabaseGithubSettingsError, GetDatabaseGithubSettingsPathParams, GetDatabaseGithubSettingsVariables, GetDatabaseListError, GetDatabaseListPathParams, GetDatabaseListVariables, GetDatabaseMetadataError, GetDatabaseMetadataPathParams, GetDatabaseMetadataVariables, GetGitBranchesMappingError, GetGitBranchesMappingPathParams, GetGitBranchesMappingVariables, GetMigrationRequestError, GetMigrationRequestIsMergedError, GetMigrationRequestIsMergedPathParams, GetMigrationRequestIsMergedResponse, GetMigrationRequestIsMergedVariables, GetMigrationRequestPathParams, GetMigrationRequestVariables, GetRecordError, GetRecordPathParams, GetRecordQueryParams, GetRecordVariables, GetTableColumnsError, GetTableColumnsPathParams, GetTableColumnsResponse, GetTableColumnsVariables, GetTableSchemaError, GetTableSchemaPathParams, GetTableSchemaResponse, GetTableSchemaVariables, GetUserAPIKeysError, GetUserAPIKeysResponse, GetUserAPIKeysVariables, GetUserError, GetUserVariables, GetWorkspaceError, GetWorkspaceMembersListError, GetWorkspaceMembersListPathParams, GetWorkspaceMembersListVariables, GetWorkspacePathParams, GetWorkspaceVariables, GetWorkspacesListError, GetWorkspacesListResponse, GetWorkspacesListVariables, HostProvider, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordQueryParams, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, KeywordAskOptions, Link, ListMigrationRequestsCommitsError, ListMigrationRequestsCommitsPathParams, ListMigrationRequestsCommitsRequestBody, ListMigrationRequestsCommitsResponse, ListMigrationRequestsCommitsVariables, ListRegionsError, ListRegionsPathParams, ListRegionsVariables, MergeMigrationRequestError, MergeMigrationRequestPathParams, MergeMigrationRequestVariables, OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Paginable, PaginationQueryMeta, PreviewBranchSchemaEditError, PreviewBranchSchemaEditPathParams, PreviewBranchSchemaEditRequestBody, PreviewBranchSchemaEditResponse, PreviewBranchSchemaEditVariables, PushBranchMigrationsError, PushBranchMigrationsPathParams, PushBranchMigrationsRequestBody, PushBranchMigrationsVariables, Query, QueryMigrationRequestsError, QueryMigrationRequestsPathParams, QueryMigrationRequestsRequestBody, QueryMigrationRequestsResponse, QueryMigrationRequestsVariables, QueryTableError, QueryTablePathParams, QueryTableRequestBody, QueryTableVariables, RecordArray, RemoveGitBranchesEntryError, RemoveGitBranchesEntryPathParams, RemoveGitBranchesEntryQueryParams, RemoveGitBranchesEntryVariables, RemoveWorkspaceMemberError, RemoveWorkspaceMemberPathParams, RemoveWorkspaceMemberVariables, Repository, ResendWorkspaceMemberInviteError, ResendWorkspaceMemberInvitePathParams, ResendWorkspaceMemberInviteVariables, ResolveBranchError, ResolveBranchPathParams, ResolveBranchQueryParams, ResolveBranchResponse, ResolveBranchVariables, responses as Responses, RestRepository, SchemaDefinition, SchemaInference, SchemaPlugin, SchemaPluginResult, schemas as Schemas, SearchBranchError, SearchBranchPathParams, SearchBranchRequestBody, SearchBranchVariables, SearchOptions, SearchPlugin, SearchPluginResult, SearchTableError, SearchTablePathParams, SearchTableRequestBody, SearchTableVariables, SearchXataRecord, SelectableColumn, SelectedPick, SerializedString, Serializer, SerializerResult, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, SqlQueryError, SqlQueryPathParams, SqlQueryRequestBody, SqlQueryVariables, SummarizeTableError, SummarizeTablePathParams, SummarizeTableRequestBody, SummarizeTableVariables, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateBranchSchemaError, UpdateBranchSchemaPathParams, UpdateBranchSchemaVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, UpdateDatabaseGithubSettingsError, UpdateDatabaseGithubSettingsPathParams, UpdateDatabaseGithubSettingsVariables, UpdateDatabaseMetadataError, UpdateDatabaseMetadataPathParams, UpdateDatabaseMetadataRequestBody, UpdateDatabaseMetadataVariables, UpdateMigrationRequestError, UpdateMigrationRequestPathParams, UpdateMigrationRequestRequestBody, UpdateMigrationRequestVariables, UpdateRecordWithIDError, UpdateRecordWithIDPathParams, UpdateRecordWithIDQueryParams, UpdateRecordWithIDVariables, UpdateTableError, UpdateTablePathParams, UpdateTableRequestBody, UpdateTableVariables, UpdateUserError, UpdateUserVariables, UpdateWorkspaceError, UpdateWorkspaceMemberInviteError, UpdateWorkspaceMemberInvitePathParams, UpdateWorkspaceMemberInviteRequestBody, UpdateWorkspaceMemberInviteVariables, UpdateWorkspaceMemberRoleError, UpdateWorkspaceMemberRolePathParams, UpdateWorkspaceMemberRoleRequestBody, UpdateWorkspaceMemberRoleVariables, UpdateWorkspacePathParams, UpdateWorkspaceVariables, UpsertRecordWithIDError, UpsertRecordWithIDPathParams, UpsertRecordWithIDQueryParams, UpsertRecordWithIDVariables, ValueAtColumn, VectorAskOptions, VectorSearchTableError, VectorSearchTablePathParams, VectorSearchTableRequestBody, VectorSearchTableVariables, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, askTable, branchTransaction, buildClient, buildPreviewBranchName, buildProviderString, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, copyBranch, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranch, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getPreviewBranch, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, pushBranchMigrations, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, sqlQuery, startsWith, summarizeTable, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID, vectorSearchTable };