@xata.io/client 0.17.1 → 0.18.0
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/CHANGELOG.md +22 -0
- package/README.md +1 -1
- package/Usage.md +2 -0
- package/dist/index.cjs +107 -4
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +314 -33
- package/dist/index.mjs +106 -5
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
@@ -99,7 +99,7 @@ declare type WorkspaceID = string;
|
|
99
99
|
declare type Role = 'owner' | 'maintainer';
|
100
100
|
declare type WorkspaceMeta = {
|
101
101
|
name: string;
|
102
|
-
slug
|
102
|
+
slug?: string;
|
103
103
|
};
|
104
104
|
declare type Workspace = WorkspaceMeta & {
|
105
105
|
id: WorkspaceID;
|
@@ -135,7 +135,6 @@ declare type InviteKey = string;
|
|
135
135
|
*/
|
136
136
|
declare type DatabaseMetadata = {
|
137
137
|
name: string;
|
138
|
-
displayName: string;
|
139
138
|
createdAt: DateTime;
|
140
139
|
numberOfBranches: number;
|
141
140
|
ui?: {
|
@@ -147,7 +146,6 @@ declare type ListDatabasesResponse = {
|
|
147
146
|
};
|
148
147
|
declare type ListBranchesResponse = {
|
149
148
|
databaseName: string;
|
150
|
-
displayName: string;
|
151
149
|
branches: Branch[];
|
152
150
|
};
|
153
151
|
declare type ListGitBranchesResponse = {
|
@@ -224,6 +222,8 @@ declare type Column = {
|
|
224
222
|
link?: {
|
225
223
|
table: string;
|
226
224
|
};
|
225
|
+
notNull?: boolean;
|
226
|
+
unique?: boolean;
|
227
227
|
columns?: Column[];
|
228
228
|
};
|
229
229
|
declare type RevLink = {
|
@@ -402,7 +402,7 @@ declare type SortExpression = string[] | {
|
|
402
402
|
declare type SortOrder = 'asc' | 'desc';
|
403
403
|
/**
|
404
404
|
* Maximum [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance) for the search terms. The Levenshtein
|
405
|
-
* distance is the number of one
|
405
|
+
* distance is the number of one character changes needed to make two strings equal. The default is 1, meaning that single
|
406
406
|
* character typos per word are tollerated by search. You can set it to 0 to remove the typo tollerance or set it to 2
|
407
407
|
* to allow two typos in a word.
|
408
408
|
*
|
@@ -428,6 +428,22 @@ declare type FilterExpression = {
|
|
428
428
|
} & {
|
429
429
|
[key: string]: FilterColumn;
|
430
430
|
};
|
431
|
+
/**
|
432
|
+
* The full summary expression; the entire expression is a map of names to requests.
|
433
|
+
*
|
434
|
+
* @x-go-type xbquery.SummaryList
|
435
|
+
*/
|
436
|
+
declare type SummaryExpressionList = {
|
437
|
+
[key: string]: SummaryExpression;
|
438
|
+
};
|
439
|
+
/**
|
440
|
+
* A single summary expression. The key represents an aggregation function; the value a column to aggregate.
|
441
|
+
*
|
442
|
+
* You may only call one aggregation per key.
|
443
|
+
*
|
444
|
+
* @x-go-type xbquery.Summary
|
445
|
+
*/
|
446
|
+
declare type SummaryExpression = Record<string, any>;
|
431
447
|
declare type HighlightExpression = {
|
432
448
|
enabled?: boolean;
|
433
449
|
encodeHTML?: boolean;
|
@@ -626,6 +642,8 @@ type schemas_SortOrder = SortOrder;
|
|
626
642
|
type schemas_FuzzinessExpression = FuzzinessExpression;
|
627
643
|
type schemas_PrefixExpression = PrefixExpression;
|
628
644
|
type schemas_FilterExpression = FilterExpression;
|
645
|
+
type schemas_SummaryExpressionList = SummaryExpressionList;
|
646
|
+
type schemas_SummaryExpression = SummaryExpression;
|
629
647
|
type schemas_HighlightExpression = HighlightExpression;
|
630
648
|
type schemas_BoosterExpression = BoosterExpression;
|
631
649
|
type schemas_FilterList = FilterList;
|
@@ -699,6 +717,8 @@ declare namespace schemas {
|
|
699
717
|
schemas_FuzzinessExpression as FuzzinessExpression,
|
700
718
|
schemas_PrefixExpression as PrefixExpression,
|
701
719
|
schemas_FilterExpression as FilterExpression,
|
720
|
+
schemas_SummaryExpressionList as SummaryExpressionList,
|
721
|
+
schemas_SummaryExpression as SummaryExpression,
|
702
722
|
schemas_HighlightExpression as HighlightExpression,
|
703
723
|
schemas_BoosterExpression as BoosterExpression,
|
704
724
|
ValueBooster$1 as ValueBooster,
|
@@ -774,6 +794,9 @@ declare type QueryResponse = {
|
|
774
794
|
records: XataRecord$1[];
|
775
795
|
meta: RecordsMetadata;
|
776
796
|
};
|
797
|
+
declare type SummarizeResponse = {
|
798
|
+
summary: Record<string, any>[];
|
799
|
+
};
|
777
800
|
declare type SearchResponse = {
|
778
801
|
records: XataRecord$1[];
|
779
802
|
};
|
@@ -794,6 +817,7 @@ type responses_RecordResponse = RecordResponse;
|
|
794
817
|
type responses_SchemaCompareResponse = SchemaCompareResponse;
|
795
818
|
type responses_RecordUpdateResponse = RecordUpdateResponse;
|
796
819
|
type responses_QueryResponse = QueryResponse;
|
820
|
+
type responses_SummarizeResponse = SummarizeResponse;
|
797
821
|
type responses_SearchResponse = SearchResponse;
|
798
822
|
type responses_MigrationIdResponse = MigrationIdResponse;
|
799
823
|
declare namespace responses {
|
@@ -808,6 +832,7 @@ declare namespace responses {
|
|
808
832
|
responses_SchemaCompareResponse as SchemaCompareResponse,
|
809
833
|
responses_RecordUpdateResponse as RecordUpdateResponse,
|
810
834
|
responses_QueryResponse as QueryResponse,
|
835
|
+
responses_SummarizeResponse as SummarizeResponse,
|
811
836
|
responses_SearchResponse as SearchResponse,
|
812
837
|
responses_MigrationIdResponse as MigrationIdResponse,
|
813
838
|
};
|
@@ -1272,7 +1297,6 @@ declare type CreateDatabaseResponse = {
|
|
1272
1297
|
branchName?: string;
|
1273
1298
|
};
|
1274
1299
|
declare type CreateDatabaseRequestBody = {
|
1275
|
-
displayName?: string;
|
1276
1300
|
branchName?: string;
|
1277
1301
|
ui?: {
|
1278
1302
|
color?: string;
|
@@ -1329,6 +1353,33 @@ declare type GetDatabaseMetadataVariables = {
|
|
1329
1353
|
* Retrieve metadata of the given database
|
1330
1354
|
*/
|
1331
1355
|
declare const getDatabaseMetadata: (variables: GetDatabaseMetadataVariables) => Promise<DatabaseMetadata>;
|
1356
|
+
declare type UpdateDatabaseMetadataPathParams = {
|
1357
|
+
dbName: DBName;
|
1358
|
+
workspace: string;
|
1359
|
+
};
|
1360
|
+
declare type UpdateDatabaseMetadataError = ErrorWrapper<{
|
1361
|
+
status: 400;
|
1362
|
+
payload: BadRequestError;
|
1363
|
+
} | {
|
1364
|
+
status: 401;
|
1365
|
+
payload: AuthError;
|
1366
|
+
} | {
|
1367
|
+
status: 404;
|
1368
|
+
payload: SimpleError;
|
1369
|
+
}>;
|
1370
|
+
declare type UpdateDatabaseMetadataRequestBody = {
|
1371
|
+
ui?: {
|
1372
|
+
color?: string;
|
1373
|
+
};
|
1374
|
+
};
|
1375
|
+
declare type UpdateDatabaseMetadataVariables = {
|
1376
|
+
body?: UpdateDatabaseMetadataRequestBody;
|
1377
|
+
pathParams: UpdateDatabaseMetadataPathParams;
|
1378
|
+
} & FetcherExtraProps;
|
1379
|
+
/**
|
1380
|
+
* Update the color of the selected database
|
1381
|
+
*/
|
1382
|
+
declare const updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables) => Promise<DatabaseMetadata>;
|
1332
1383
|
declare type GetGitBranchesMappingPathParams = {
|
1333
1384
|
dbName: DBName;
|
1334
1385
|
workspace: string;
|
@@ -3311,6 +3362,7 @@ declare type SearchBranchRequestBody = {
|
|
3311
3362
|
})[];
|
3312
3363
|
query: string;
|
3313
3364
|
fuzziness?: FuzzinessExpression;
|
3365
|
+
prefix?: PrefixExpression;
|
3314
3366
|
highlight?: HighlightExpression;
|
3315
3367
|
};
|
3316
3368
|
declare type SearchBranchVariables = {
|
@@ -3321,6 +3373,33 @@ declare type SearchBranchVariables = {
|
|
3321
3373
|
* Run a free text search operation across the database branch.
|
3322
3374
|
*/
|
3323
3375
|
declare const searchBranch: (variables: SearchBranchVariables) => Promise<SearchResponse>;
|
3376
|
+
declare type SummarizeTablePathParams = {
|
3377
|
+
dbBranchName: DBBranchName;
|
3378
|
+
tableName: TableName;
|
3379
|
+
workspace: string;
|
3380
|
+
};
|
3381
|
+
declare type SummarizeTableError = ErrorWrapper<{
|
3382
|
+
status: 400;
|
3383
|
+
payload: BadRequestError;
|
3384
|
+
} | {
|
3385
|
+
status: 401;
|
3386
|
+
payload: AuthError;
|
3387
|
+
} | {
|
3388
|
+
status: 404;
|
3389
|
+
payload: SimpleError;
|
3390
|
+
}>;
|
3391
|
+
declare type SummarizeTableRequestBody = {
|
3392
|
+
summaries?: SummaryExpressionList;
|
3393
|
+
columns?: ColumnsProjection;
|
3394
|
+
};
|
3395
|
+
declare type SummarizeTableVariables = {
|
3396
|
+
body?: SummarizeTableRequestBody;
|
3397
|
+
pathParams: SummarizeTablePathParams;
|
3398
|
+
} & FetcherExtraProps;
|
3399
|
+
/**
|
3400
|
+
* Summarize table
|
3401
|
+
*/
|
3402
|
+
declare const summarizeTable: (variables: SummarizeTableVariables) => Promise<SummarizeResponse>;
|
3324
3403
|
declare const operationsByTag: {
|
3325
3404
|
users: {
|
3326
3405
|
getUser: (variables: GetUserVariables) => Promise<UserWithID>;
|
@@ -3350,6 +3429,7 @@ declare const operationsByTag: {
|
|
3350
3429
|
createDatabase: (variables: CreateDatabaseVariables) => Promise<CreateDatabaseResponse>;
|
3351
3430
|
deleteDatabase: (variables: DeleteDatabaseVariables) => Promise<undefined>;
|
3352
3431
|
getDatabaseMetadata: (variables: GetDatabaseMetadataVariables) => Promise<DatabaseMetadata>;
|
3432
|
+
updateDatabaseMetadata: (variables: UpdateDatabaseMetadataVariables) => Promise<DatabaseMetadata>;
|
3353
3433
|
getGitBranchesMapping: (variables: GetGitBranchesMappingVariables) => Promise<ListGitBranchesResponse>;
|
3354
3434
|
addGitBranchesEntry: (variables: AddGitBranchesEntryVariables) => Promise<AddGitBranchesEntryResponse>;
|
3355
3435
|
removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables) => Promise<undefined>;
|
@@ -3408,6 +3488,7 @@ declare const operationsByTag: {
|
|
3408
3488
|
queryTable: (variables: QueryTableVariables) => Promise<QueryResponse>;
|
3409
3489
|
searchTable: (variables: SearchTableVariables) => Promise<SearchResponse>;
|
3410
3490
|
searchBranch: (variables: SearchBranchVariables) => Promise<SearchResponse>;
|
3491
|
+
summarizeTable: (variables: SummarizeTableVariables) => Promise<SummarizeResponse>;
|
3411
3492
|
};
|
3412
3493
|
};
|
3413
3494
|
|
@@ -3470,6 +3551,7 @@ declare class DatabaseApi {
|
|
3470
3551
|
createDatabase(workspace: WorkspaceID, dbName: DBName, options?: CreateDatabaseRequestBody): Promise<CreateDatabaseResponse>;
|
3471
3552
|
deleteDatabase(workspace: WorkspaceID, dbName: DBName): Promise<void>;
|
3472
3553
|
getDatabaseMetadata(workspace: WorkspaceID, dbName: DBName): Promise<DatabaseMetadata>;
|
3554
|
+
updateDatabaseMetadata(workspace: WorkspaceID, dbName: DBName, options?: UpdateDatabaseMetadataRequestBody): Promise<DatabaseMetadata>;
|
3473
3555
|
getGitBranchesMapping(workspace: WorkspaceID, dbName: DBName): Promise<ListGitBranchesResponse>;
|
3474
3556
|
addGitBranchesEntry(workspace: WorkspaceID, dbName: DBName, body: AddGitBranchesEntryRequestBody): Promise<AddGitBranchesEntryResponse>;
|
3475
3557
|
removeGitBranchesEntry(workspace: WorkspaceID, dbName: DBName, gitBranch: string): Promise<void>;
|
@@ -3513,6 +3595,7 @@ declare class RecordsApi {
|
|
3513
3595
|
queryTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, query: QueryTableRequestBody): Promise<QueryResponse>;
|
3514
3596
|
searchTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, query: SearchTableRequestBody): Promise<SearchResponse>;
|
3515
3597
|
searchBranch(workspace: WorkspaceID, database: DBName, branch: BranchName, query: SearchBranchRequestBody): Promise<SearchResponse>;
|
3598
|
+
summarizeTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, query: SummarizeTableRequestBody): Promise<SummarizeResponse>;
|
3516
3599
|
}
|
3517
3600
|
declare class MigrationRequestsApi {
|
3518
3601
|
private extraProps;
|
@@ -3643,25 +3726,7 @@ interface XataRecord<OriginalRecord extends XataRecord<any> = XataRecord<any>> e
|
|
3643
3726
|
*/
|
3644
3727
|
delete(): Promise<Readonly<SelectedPick<OriginalRecord, ['*']>> | null>;
|
3645
3728
|
}
|
3646
|
-
declare type Link<Record extends XataRecord> =
|
3647
|
-
/**
|
3648
|
-
* Retrieves a refreshed copy of the current record from the database.
|
3649
|
-
*/
|
3650
|
-
read<K extends SelectableColumn<Record>>(columns?: K[]): Promise<Readonly<SelectedPick<Record, typeof columns extends SelectableColumn<Record>[] ? typeof columns : ['*']>> | null>;
|
3651
|
-
/**
|
3652
|
-
* Performs a partial update of the current record. On success a new object is
|
3653
|
-
* returned and the current object is not mutated.
|
3654
|
-
* @param partialUpdate The columns and their values that have to be updated.
|
3655
|
-
* @returns A new record containing the latest values for all the columns of the current record.
|
3656
|
-
*/
|
3657
|
-
update<K extends SelectableColumn<Record>>(partialUpdate: Partial<EditableData<Record>>, columns?: K[]): Promise<Readonly<SelectedPick<Record, typeof columns extends SelectableColumn<Record>[] ? typeof columns : ['*']>>>;
|
3658
|
-
/**
|
3659
|
-
* Performs a deletion of the current record in the database.
|
3660
|
-
*
|
3661
|
-
* @throws If the record was already deleted or if an error happened while performing the deletion.
|
3662
|
-
*/
|
3663
|
-
delete(): Promise<void>;
|
3664
|
-
};
|
3729
|
+
declare type Link<Record extends XataRecord> = XataRecord<Record>;
|
3665
3730
|
declare type XataRecordMetadata = {
|
3666
3731
|
/**
|
3667
3732
|
* Number that is increased every time the record is updated.
|
@@ -4068,6 +4133,26 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
4068
4133
|
* @returns The first record that matches the query, or null if no record matched the query.
|
4069
4134
|
*/
|
4070
4135
|
getFirst(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'>): Promise<Result | null>;
|
4136
|
+
/**
|
4137
|
+
* Performs the query in the database and returns the first result.
|
4138
|
+
* @returns The first record that matches the query, or null if no record matched the query.
|
4139
|
+
* @throws if there are no results.
|
4140
|
+
*/
|
4141
|
+
getFirstOrThrow(): Promise<Result>;
|
4142
|
+
/**
|
4143
|
+
* Performs the query in the database and returns the first result.
|
4144
|
+
* @param options Additional options to be used when performing the query.
|
4145
|
+
* @returns The first record that matches the query, or null if no record matched the query.
|
4146
|
+
* @throws if there are no results.
|
4147
|
+
*/
|
4148
|
+
getFirstOrThrow<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>>;
|
4149
|
+
/**
|
4150
|
+
* Performs the query in the database and returns the first result.
|
4151
|
+
* @param options Additional options to be used when performing the query.
|
4152
|
+
* @returns The first record that matches the query, or null if no record matched the query.
|
4153
|
+
* @throws if there are no results.
|
4154
|
+
*/
|
4155
|
+
getFirstOrThrow(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'>): Promise<Result>;
|
4071
4156
|
/**
|
4072
4157
|
* Builds a new query object adding a cache TTL in milliseconds.
|
4073
4158
|
* @param ttl The cache TTL in milliseconds.
|
@@ -4307,6 +4392,66 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
4307
4392
|
* @returns The persisted records for the given ids in order (if a record could not be found null is returned).
|
4308
4393
|
*/
|
4309
4394
|
abstract read(objects: Identifiable[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
|
4395
|
+
/**
|
4396
|
+
* Queries a single record from the table given its unique id.
|
4397
|
+
* @param id The unique id.
|
4398
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
4399
|
+
* @returns The persisted record for the given id.
|
4400
|
+
* @throws If the record could not be found.
|
4401
|
+
*/
|
4402
|
+
abstract readOrThrow<K extends SelectableColumn<Record>>(id: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
4403
|
+
/**
|
4404
|
+
* Queries a single record from the table given its unique id.
|
4405
|
+
* @param id The unique id.
|
4406
|
+
* @returns The persisted record for the given id.
|
4407
|
+
* @throws If the record could not be found.
|
4408
|
+
*/
|
4409
|
+
abstract readOrThrow(id: string): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
4410
|
+
/**
|
4411
|
+
* Queries multiple records from the table given their unique id.
|
4412
|
+
* @param ids The unique ids array.
|
4413
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
4414
|
+
* @returns The persisted records for the given ids in order.
|
4415
|
+
* @throws If one or more records could not be found.
|
4416
|
+
*/
|
4417
|
+
abstract readOrThrow<K extends SelectableColumn<Record>>(ids: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
4418
|
+
/**
|
4419
|
+
* Queries multiple records from the table given their unique id.
|
4420
|
+
* @param ids The unique ids array.
|
4421
|
+
* @returns The persisted records for the given ids in order.
|
4422
|
+
* @throws If one or more records could not be found.
|
4423
|
+
*/
|
4424
|
+
abstract readOrThrow(ids: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
4425
|
+
/**
|
4426
|
+
* Queries a single record from the table by the id in the object.
|
4427
|
+
* @param object Object containing the id of the record.
|
4428
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
4429
|
+
* @returns The persisted record for the given id.
|
4430
|
+
* @throws If the record could not be found.
|
4431
|
+
*/
|
4432
|
+
abstract readOrThrow<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
4433
|
+
/**
|
4434
|
+
* Queries a single record from the table by the id in the object.
|
4435
|
+
* @param object Object containing the id of the record.
|
4436
|
+
* @returns The persisted record for the given id.
|
4437
|
+
* @throws If the record could not be found.
|
4438
|
+
*/
|
4439
|
+
abstract readOrThrow(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
4440
|
+
/**
|
4441
|
+
* Queries multiple records from the table by the ids in the objects.
|
4442
|
+
* @param objects Array of objects containing the ids of the records.
|
4443
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
4444
|
+
* @returns The persisted records for the given ids in order.
|
4445
|
+
* @throws If one or more records could not be found.
|
4446
|
+
*/
|
4447
|
+
abstract readOrThrow<K extends SelectableColumn<Record>>(objects: Identifiable[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
4448
|
+
/**
|
4449
|
+
* Queries multiple records from the table by the ids in the objects.
|
4450
|
+
* @param objects Array of objects containing the ids of the records.
|
4451
|
+
* @returns The persisted records for the given ids in order.
|
4452
|
+
* @throws If one or more records could not be found.
|
4453
|
+
*/
|
4454
|
+
abstract readOrThrow(objects: Identifiable[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
4310
4455
|
/**
|
4311
4456
|
* Partially update a single record.
|
4312
4457
|
* @param object An object with its id and the columns to be updated.
|
@@ -4348,6 +4493,53 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
4348
4493
|
* @returns Array of the persisted records in order (if a record could not be found null is returned).
|
4349
4494
|
*/
|
4350
4495
|
abstract update(objects: Array<Partial<EditableData<Record>> & Identifiable>): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
|
4496
|
+
/**
|
4497
|
+
* Partially update a single record.
|
4498
|
+
* @param object An object with its id and the columns to be updated.
|
4499
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
4500
|
+
* @returns The full persisted record.
|
4501
|
+
* @throws If the record could not be found.
|
4502
|
+
*/
|
4503
|
+
abstract updateOrThrow<K extends SelectableColumn<Record>>(object: Partial<EditableData<Record>> & Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
4504
|
+
/**
|
4505
|
+
* Partially update a single record.
|
4506
|
+
* @param object An object with its id and the columns to be updated.
|
4507
|
+
* @returns The full persisted record.
|
4508
|
+
* @throws If the record could not be found.
|
4509
|
+
*/
|
4510
|
+
abstract updateOrThrow(object: Partial<EditableData<Record>> & Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
4511
|
+
/**
|
4512
|
+
* Partially update a single record given its unique id.
|
4513
|
+
* @param id The unique id.
|
4514
|
+
* @param object The column names and their values that have to be updated.
|
4515
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
4516
|
+
* @returns The full persisted record.
|
4517
|
+
* @throws If the record could not be found.
|
4518
|
+
*/
|
4519
|
+
abstract updateOrThrow<K extends SelectableColumn<Record>>(id: string, object: Partial<EditableData<Record>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
4520
|
+
/**
|
4521
|
+
* Partially update a single record given its unique id.
|
4522
|
+
* @param id The unique id.
|
4523
|
+
* @param object The column names and their values that have to be updated.
|
4524
|
+
* @returns The full persisted record.
|
4525
|
+
* @throws If the record could not be found.
|
4526
|
+
*/
|
4527
|
+
abstract updateOrThrow(id: string, object: Partial<EditableData<Record>>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
4528
|
+
/**
|
4529
|
+
* Partially updates multiple records.
|
4530
|
+
* @param objects An array of objects with their ids and columns to be updated.
|
4531
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
4532
|
+
* @returns Array of the persisted records in order.
|
4533
|
+
* @throws If one or more records could not be found.
|
4534
|
+
*/
|
4535
|
+
abstract updateOrThrow<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Record>> & Identifiable>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
|
4536
|
+
/**
|
4537
|
+
* Partially updates multiple records.
|
4538
|
+
* @param objects An array of objects with their ids and columns to be updated.
|
4539
|
+
* @returns Array of the persisted records in order.
|
4540
|
+
* @throws If one or more records could not be found.
|
4541
|
+
*/
|
4542
|
+
abstract updateOrThrow(objects: Array<Partial<EditableData<Record>> & Identifiable>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
|
4351
4543
|
/**
|
4352
4544
|
* Creates or updates a single record. If a record exists with the given id,
|
4353
4545
|
* it will be update, otherwise a new record will be created.
|
@@ -4447,6 +4639,66 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
4447
4639
|
* @returns Array of the deleted records in order (if a record could not be found null is returned).
|
4448
4640
|
*/
|
4449
4641
|
abstract delete(objects: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
|
4642
|
+
/**
|
4643
|
+
* Deletes a record given its unique id.
|
4644
|
+
* @param object An object with a unique id.
|
4645
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
4646
|
+
* @returns The deleted record, null if the record could not be found.
|
4647
|
+
* @throws If the record could not be found.
|
4648
|
+
*/
|
4649
|
+
abstract deleteOrThrow<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
4650
|
+
/**
|
4651
|
+
* Deletes a record given its unique id.
|
4652
|
+
* @param object An object with a unique id.
|
4653
|
+
* @returns The deleted record, null if the record could not be found.
|
4654
|
+
* @throws If the record could not be found.
|
4655
|
+
*/
|
4656
|
+
abstract deleteOrThrow(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
4657
|
+
/**
|
4658
|
+
* Deletes a record given a unique id.
|
4659
|
+
* @param id The unique id.
|
4660
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
4661
|
+
* @returns The deleted record, null if the record could not be found.
|
4662
|
+
* @throws If the record could not be found.
|
4663
|
+
*/
|
4664
|
+
abstract deleteOrThrow<K extends SelectableColumn<Record>>(id: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
4665
|
+
/**
|
4666
|
+
* Deletes a record given a unique id.
|
4667
|
+
* @param id The unique id.
|
4668
|
+
* @returns The deleted record, null if the record could not be found.
|
4669
|
+
* @throws If the record could not be found.
|
4670
|
+
*/
|
4671
|
+
abstract deleteOrThrow(id: string): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
4672
|
+
/**
|
4673
|
+
* Deletes multiple records given an array of objects with ids.
|
4674
|
+
* @param objects An array of objects with unique ids.
|
4675
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
4676
|
+
* @returns Array of the deleted records in order (if a record could not be found null is returned).
|
4677
|
+
* @throws If one or more records could not be found.
|
4678
|
+
*/
|
4679
|
+
abstract deleteOrThrow<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Record>> & Identifiable>, columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
4680
|
+
/**
|
4681
|
+
* Deletes multiple records given an array of objects with ids.
|
4682
|
+
* @param objects An array of objects with unique ids.
|
4683
|
+
* @returns Array of the deleted records in order (if a record could not be found null is returned).
|
4684
|
+
* @throws If one or more records could not be found.
|
4685
|
+
*/
|
4686
|
+
abstract deleteOrThrow(objects: Array<Partial<EditableData<Record>> & Identifiable>): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
4687
|
+
/**
|
4688
|
+
* Deletes multiple records given an array of unique ids.
|
4689
|
+
* @param objects An array of ids.
|
4690
|
+
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
4691
|
+
* @returns Array of the deleted records in order (if a record could not be found null is returned).
|
4692
|
+
* @throws If one or more records could not be found.
|
4693
|
+
*/
|
4694
|
+
abstract deleteOrThrow<K extends SelectableColumn<Record>>(objects: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
4695
|
+
/**
|
4696
|
+
* Deletes multiple records given an array of unique ids.
|
4697
|
+
* @param objects An array of ids.
|
4698
|
+
* @returns Array of the deleted records in order.
|
4699
|
+
* @throws If one or more records could not be found.
|
4700
|
+
*/
|
4701
|
+
abstract deleteOrThrow(objects: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
4450
4702
|
/**
|
4451
4703
|
* Search for records in the table.
|
4452
4704
|
* @param query The query to search for.
|
@@ -4484,12 +4736,26 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
|
|
4484
4736
|
read(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
|
4485
4737
|
read<K extends SelectableColumn<Record>>(objects: Identifiable[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
|
4486
4738
|
read(objects: Identifiable[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
|
4739
|
+
readOrThrow<K extends SelectableColumn<Record>>(id: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
4740
|
+
readOrThrow(id: string): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
4741
|
+
readOrThrow<K extends SelectableColumn<Record>>(ids: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
4742
|
+
readOrThrow(ids: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
4743
|
+
readOrThrow<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
4744
|
+
readOrThrow(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
4745
|
+
readOrThrow<K extends SelectableColumn<Record>>(objects: Identifiable[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
4746
|
+
readOrThrow(objects: Identifiable[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
4487
4747
|
update<K extends SelectableColumn<Record>>(object: Partial<EditableData<Record>> & Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
|
4488
4748
|
update(object: Partial<EditableData<Record>> & Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
|
4489
4749
|
update<K extends SelectableColumn<Record>>(id: string, object: Partial<EditableData<Record>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>> | null>;
|
4490
4750
|
update(id: string, object: Partial<EditableData<Record>>): Promise<Readonly<SelectedPick<Record, ['*']>> | null>;
|
4491
4751
|
update<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Record>> & Identifiable>, columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
|
4492
4752
|
update(objects: Array<Partial<EditableData<Record>> & Identifiable>): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
|
4753
|
+
updateOrThrow<K extends SelectableColumn<Record>>(object: Partial<EditableData<Record>> & Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
4754
|
+
updateOrThrow(object: Partial<EditableData<Record>> & Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
4755
|
+
updateOrThrow<K extends SelectableColumn<Record>>(id: string, object: Partial<EditableData<Record>>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
4756
|
+
updateOrThrow(id: string, object: Partial<EditableData<Record>>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
4757
|
+
updateOrThrow<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Record>> & Identifiable>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>[]>;
|
4758
|
+
updateOrThrow(objects: Array<Partial<EditableData<Record>> & Identifiable>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
|
4493
4759
|
createOrUpdate<K extends SelectableColumn<Record>>(object: EditableData<Record> & Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
4494
4760
|
createOrUpdate(object: EditableData<Record> & Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
4495
4761
|
createOrUpdate<K extends SelectableColumn<Record>>(id: string, object: Omit<EditableData<Record>, 'id'>, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
@@ -4504,6 +4770,14 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
|
|
4504
4770
|
delete(objects: Array<Partial<EditableData<Record>> & Identifiable>): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
|
4505
4771
|
delete<K extends SelectableColumn<Record>>(objects: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
|
4506
4772
|
delete(objects: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
|
4773
|
+
deleteOrThrow<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
4774
|
+
deleteOrThrow(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
4775
|
+
deleteOrThrow<K extends SelectableColumn<Record>>(id: string, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
4776
|
+
deleteOrThrow(id: string): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
4777
|
+
deleteOrThrow<K extends SelectableColumn<Record>>(objects: Array<Partial<EditableData<Record>> & Identifiable>, columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
4778
|
+
deleteOrThrow(objects: Array<Partial<EditableData<Record>> & Identifiable>): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
4779
|
+
deleteOrThrow<K extends SelectableColumn<Record>>(objects: string[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
4780
|
+
deleteOrThrow(objects: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
4507
4781
|
search(query: string, options?: {
|
4508
4782
|
fuzziness?: FuzzinessExpression;
|
4509
4783
|
prefix?: PrefixExpression;
|
@@ -4519,6 +4793,7 @@ declare type BaseSchema = {
|
|
4519
4793
|
columns: readonly ({
|
4520
4794
|
name: string;
|
4521
4795
|
type: Column['type'];
|
4796
|
+
notNull?: boolean;
|
4522
4797
|
} | {
|
4523
4798
|
name: string;
|
4524
4799
|
type: 'link';
|
@@ -4548,10 +4823,10 @@ declare type TableType<Tables, TableName> = Tables & {
|
|
4548
4823
|
} ? Columns extends readonly unknown[] ? Columns[number] extends {
|
4549
4824
|
name: string;
|
4550
4825
|
type: string;
|
4551
|
-
} ? Identifiable & {
|
4552
|
-
[K in Columns[number]['name']]
|
4553
|
-
} : never : never : never : never;
|
4554
|
-
declare type PropertyType<Tables, Properties, PropertyName> = Properties & {
|
4826
|
+
} ? Identifiable & UnionToIntersection<Values<{
|
4827
|
+
[K in Columns[number]['name']]: PropertyType<Tables, Columns[number], K>;
|
4828
|
+
}>> : never : never : never : never;
|
4829
|
+
declare type PropertyType<Tables, Properties, PropertyName extends PropertyKey> = Properties & {
|
4555
4830
|
name: PropertyName;
|
4556
4831
|
} extends infer Property ? Property extends {
|
4557
4832
|
name: string;
|
@@ -4560,12 +4835,18 @@ declare type PropertyType<Tables, Properties, PropertyName> = Properties & {
|
|
4560
4835
|
table: infer LinkedTable;
|
4561
4836
|
};
|
4562
4837
|
columns?: infer ObjectColumns;
|
4563
|
-
|
4838
|
+
notNull?: infer NotNull;
|
4839
|
+
} ? NotNull extends true ? {
|
4840
|
+
[K in PropertyName]: InnerType<Type, ObjectColumns, Tables, LinkedTable>;
|
4841
|
+
} : {
|
4842
|
+
[K in PropertyName]?: InnerType<Type, ObjectColumns, Tables, LinkedTable> | null;
|
4843
|
+
} : never : never;
|
4844
|
+
declare type InnerType<Type, ObjectColumns, Tables, LinkedTable> = Type extends 'string' | 'text' | 'email' ? string : Type extends 'int' | 'float' ? number : Type extends 'bool' ? boolean : Type extends 'datetime' ? Date : Type extends 'multiple' ? string[] : Type extends 'object' ? ObjectColumns extends readonly unknown[] ? ObjectColumns[number] extends {
|
4564
4845
|
name: string;
|
4565
4846
|
type: string;
|
4566
|
-
} ? {
|
4567
|
-
[K in ObjectColumns[number]['name']]
|
4568
|
-
} : never : never : Type extends 'link' ? TableType<Tables, LinkedTable> & XataRecord : never
|
4847
|
+
} ? UnionToIntersection<Values<{
|
4848
|
+
[K in ObjectColumns[number]['name']]: PropertyType<Tables, ObjectColumns[number], K>;
|
4849
|
+
}>> : never : never : Type extends 'link' ? TableType<Tables, LinkedTable> & XataRecord : never;
|
4569
4850
|
|
4570
4851
|
/**
|
4571
4852
|
* Operator to restrict results to only values that are greater than the given value.
|
@@ -4816,4 +5097,4 @@ declare class XataError extends Error {
|
|
4816
5097
|
constructor(message: string, status: number);
|
4817
5098
|
}
|
4818
5099
|
|
4819
|
-
export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, ApplyBranchSchemaEditError, ApplyBranchSchemaEditPathParams, ApplyBranchSchemaEditRequestBody, ApplyBranchSchemaEditResponse, ApplyBranchSchemaEditVariables, BaseClient, BaseClientOptions, BaseData, BaseSchema, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsQueryParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, CompareBranchSchemasError, CompareBranchSchemasPathParams, 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, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabasePathParams, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordQueryParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, 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, 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, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordQueryParams, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, Link, ListMigrationRequestsCommitsError, ListMigrationRequestsCommitsPathParams, ListMigrationRequestsCommitsRequestBody, ListMigrationRequestsCommitsResponse, ListMigrationRequestsCommitsVariables, ListMigrationRequestsError, ListMigrationRequestsPathParams, ListMigrationRequestsRequestBody, ListMigrationRequestsResponse, ListMigrationRequestsVariables, 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, 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, Serializer, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateBranchSchemaError, UpdateBranchSchemaPathParams, UpdateBranchSchemaResponse, UpdateBranchSchemaVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, 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, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, applyBranchSchemaEdit, buildClient, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getGitBranchesMapping, getMigrationRequest, getMigrationRequestIsMerged, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequests, listMigrationRequestsCommits, lt, lte, mergeMigrationRequest, notExists, operationsByTag, pattern, previewBranchSchemaEdit, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, startsWith, updateBranchMetadata, updateBranchSchema, updateColumn, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID };
|
5100
|
+
export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, ApplyBranchSchemaEditError, ApplyBranchSchemaEditPathParams, ApplyBranchSchemaEditRequestBody, ApplyBranchSchemaEditResponse, ApplyBranchSchemaEditVariables, BaseClient, BaseClientOptions, BaseData, BaseSchema, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsQueryParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, CompareBranchSchemasError, CompareBranchSchemasPathParams, 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, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabasePathParams, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordQueryParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, 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, 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, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordQueryParams, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, Link, ListMigrationRequestsCommitsError, ListMigrationRequestsCommitsPathParams, ListMigrationRequestsCommitsRequestBody, ListMigrationRequestsCommitsResponse, ListMigrationRequestsCommitsVariables, ListMigrationRequestsError, ListMigrationRequestsPathParams, ListMigrationRequestsRequestBody, ListMigrationRequestsResponse, ListMigrationRequestsVariables, 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, 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, Serializer, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, SummarizeTableError, SummarizeTablePathParams, SummarizeTableRequestBody, SummarizeTableVariables, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateBranchSchemaError, UpdateBranchSchemaPathParams, UpdateBranchSchemaResponse, UpdateBranchSchemaVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, 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, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, applyBranchSchemaEdit, buildClient, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, createBranch, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getGitBranchesMapping, getMigrationRequest, getMigrationRequestIsMerged, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, greaterEquals, greaterThan, greaterThanEquals, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isIdentifiable, isNot, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listMigrationRequests, listMigrationRequestsCommits, lt, lte, mergeMigrationRequest, notExists, operationsByTag, pattern, previewBranchSchemaEdit, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, startsWith, summarizeTable, updateBranchMetadata, updateBranchSchema, updateColumn, updateDatabaseMetadata, updateMigrationRequest, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID };
|