@xata.io/client 0.0.0-alpha.vf27674a → 0.0.0-alpha.vf3081bb
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/.eslintrc.cjs +1 -2
- package/CHANGELOG.md +54 -0
- package/README.md +265 -1
- package/dist/index.cjs +170 -71
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +287 -55
- package/dist/index.mjs +168 -71
- package/dist/index.mjs.map +1 -1
- package/package.json +5 -2
- package/tsconfig.json +1 -0
package/dist/index.d.ts
CHANGED
@@ -268,6 +268,17 @@ declare type SortExpression = string[] | {
|
|
268
268
|
[key: string]: SortOrder;
|
269
269
|
}[];
|
270
270
|
declare type SortOrder = 'asc' | 'desc';
|
271
|
+
/**
|
272
|
+
* Maximum [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance) for the search terms. The Levenshtein
|
273
|
+
* distance is the number of one charcter changes needed to make two strings equal. The default is 1, meaning that single
|
274
|
+
* character typos per word are tollerated by search. You can set it to 0 to remove the typo tollerance or set it to 2
|
275
|
+
* to allow two typos in a word.
|
276
|
+
*
|
277
|
+
* @default 1
|
278
|
+
* @maximum 2
|
279
|
+
* @minimum 0
|
280
|
+
*/
|
281
|
+
declare type FuzzinessExpression = number;
|
271
282
|
/**
|
272
283
|
* @minProperties 1
|
273
284
|
*/
|
@@ -281,6 +292,10 @@ declare type FilterExpression = {
|
|
281
292
|
} & {
|
282
293
|
[key: string]: FilterColumn;
|
283
294
|
};
|
295
|
+
declare type HighlightExpression = {
|
296
|
+
enabled?: boolean;
|
297
|
+
encodeHTML?: boolean;
|
298
|
+
};
|
284
299
|
declare type FilterList = FilterExpression | FilterExpression[];
|
285
300
|
declare type FilterColumn = FilterColumnIncludes | FilterPredicate | FilterList;
|
286
301
|
/**
|
@@ -366,6 +381,11 @@ declare type XataRecord$1 = {
|
|
366
381
|
xata: {
|
367
382
|
version: number;
|
368
383
|
table?: string;
|
384
|
+
highlight?: {
|
385
|
+
[key: string]: string[] | {
|
386
|
+
[key: string]: any;
|
387
|
+
};
|
388
|
+
};
|
369
389
|
warnings?: string[];
|
370
390
|
};
|
371
391
|
} & {
|
@@ -409,7 +429,9 @@ type schemas_TableMigration = TableMigration;
|
|
409
429
|
type schemas_ColumnMigration = ColumnMigration;
|
410
430
|
type schemas_SortExpression = SortExpression;
|
411
431
|
type schemas_SortOrder = SortOrder;
|
432
|
+
type schemas_FuzzinessExpression = FuzzinessExpression;
|
412
433
|
type schemas_FilterExpression = FilterExpression;
|
434
|
+
type schemas_HighlightExpression = HighlightExpression;
|
413
435
|
type schemas_FilterList = FilterList;
|
414
436
|
type schemas_FilterColumn = FilterColumn;
|
415
437
|
type schemas_FilterColumnIncludes = FilterColumnIncludes;
|
@@ -462,7 +484,9 @@ declare namespace schemas {
|
|
462
484
|
schemas_ColumnMigration as ColumnMigration,
|
463
485
|
schemas_SortExpression as SortExpression,
|
464
486
|
schemas_SortOrder as SortOrder,
|
487
|
+
schemas_FuzzinessExpression as FuzzinessExpression,
|
465
488
|
schemas_FilterExpression as FilterExpression,
|
489
|
+
schemas_HighlightExpression as HighlightExpression,
|
466
490
|
schemas_FilterList as FilterList,
|
467
491
|
schemas_FilterColumn as FilterColumn,
|
468
492
|
schemas_FilterColumnIncludes as FilterColumnIncludes,
|
@@ -1151,9 +1175,10 @@ declare type ResolveBranchVariables = {
|
|
1151
1175
|
} & FetcherExtraProps;
|
1152
1176
|
/**
|
1153
1177
|
* In order to resolve the database branch, the following algorithm is used:
|
1154
|
-
* * if the `gitBranch` is found in the [git branches mapping](), the associated Xata branch is returned
|
1178
|
+
* * if the `gitBranch` was provided and is found in the [git branches mapping](/api-reference/dbs/db_name/gitBranches), the associated Xata branch is returned
|
1155
1179
|
* * else, if a Xata branch with the exact same name as `gitBranch` exists, return it
|
1156
|
-
* * else,
|
1180
|
+
* * else, if `fallbackBranch` is provided and a branch with that name exists, return it
|
1181
|
+
* * else, return the default branch of the DB (`main` or the first branch)
|
1157
1182
|
*
|
1158
1183
|
* Example call:
|
1159
1184
|
*
|
@@ -2261,12 +2286,18 @@ declare type QueryTableVariables = {
|
|
2261
2286
|
* {
|
2262
2287
|
* "filter": {
|
2263
2288
|
* "<column_name>": {
|
2264
|
-
* "$pattern": "v*
|
2289
|
+
* "$pattern": "v*alu?"
|
2265
2290
|
* }
|
2266
2291
|
* }
|
2267
2292
|
* }
|
2268
2293
|
* ```
|
2269
2294
|
*
|
2295
|
+
* The `$pattern` operator accepts two wildcard characters:
|
2296
|
+
* * `*` matches zero or more characters
|
2297
|
+
* * `?` matches exactly one character
|
2298
|
+
*
|
2299
|
+
* If you want to match a string that contains a wildcard character, you can escape them using a backslash (`\`). You can escape a backslash by usign another backslash.
|
2300
|
+
*
|
2270
2301
|
* We could also have `$endsWith` and `$startsWith` operators:
|
2271
2302
|
*
|
2272
2303
|
* ```json
|
@@ -2573,6 +2604,39 @@ declare type QueryTableVariables = {
|
|
2573
2604
|
* ```
|
2574
2605
|
*/
|
2575
2606
|
declare const queryTable: (variables: QueryTableVariables) => Promise<QueryResponse>;
|
2607
|
+
declare type SearchTablePathParams = {
|
2608
|
+
dbBranchName: DBBranchName;
|
2609
|
+
tableName: TableName;
|
2610
|
+
workspace: string;
|
2611
|
+
};
|
2612
|
+
declare type SearchTableError = ErrorWrapper<{
|
2613
|
+
status: 400;
|
2614
|
+
payload: BadRequestError;
|
2615
|
+
} | {
|
2616
|
+
status: 401;
|
2617
|
+
payload: AuthError;
|
2618
|
+
} | {
|
2619
|
+
status: 404;
|
2620
|
+
payload: SimpleError;
|
2621
|
+
}>;
|
2622
|
+
declare type SearchTableRequestBody = {
|
2623
|
+
query: string;
|
2624
|
+
fuzziness?: FuzzinessExpression;
|
2625
|
+
filter?: FilterExpression;
|
2626
|
+
highlight?: HighlightExpression;
|
2627
|
+
};
|
2628
|
+
declare type SearchTableVariables = {
|
2629
|
+
body: SearchTableRequestBody;
|
2630
|
+
pathParams: SearchTablePathParams;
|
2631
|
+
} & FetcherExtraProps;
|
2632
|
+
/**
|
2633
|
+
* Run a free text search operation in a particular table.
|
2634
|
+
*
|
2635
|
+
* The endpoint accepts a `query` parameter that is used for the free text search and a set of structured filters (via the `filter` parameter) that are applied before the search. The `filter` parameter uses the same syntax as the [query endpoint](/api-reference/db/db_branch_name/tables/table_name/) with the following exceptions:
|
2636
|
+
* * filters `$contains`, `$startsWith`, `$endsWith` don't work on columns of type `text`
|
2637
|
+
* * filtering on columns of type `multiple` is currently unsupported
|
2638
|
+
*/
|
2639
|
+
declare const searchTable: (variables: SearchTableVariables) => Promise<SearchResponse>;
|
2576
2640
|
declare type SearchBranchPathParams = {
|
2577
2641
|
dbBranchName: DBBranchName;
|
2578
2642
|
workspace: string;
|
@@ -2588,9 +2652,13 @@ declare type SearchBranchError = ErrorWrapper<{
|
|
2588
2652
|
payload: SimpleError;
|
2589
2653
|
}>;
|
2590
2654
|
declare type SearchBranchRequestBody = {
|
2591
|
-
tables?: string
|
2655
|
+
tables?: (string | {
|
2656
|
+
table: string;
|
2657
|
+
filter?: FilterExpression;
|
2658
|
+
})[];
|
2592
2659
|
query: string;
|
2593
|
-
fuzziness?:
|
2660
|
+
fuzziness?: FuzzinessExpression;
|
2661
|
+
highlight?: HighlightExpression;
|
2594
2662
|
};
|
2595
2663
|
declare type SearchBranchVariables = {
|
2596
2664
|
body: SearchBranchRequestBody;
|
@@ -2665,6 +2733,7 @@ declare const operationsByTag: {
|
|
2665
2733
|
getRecord: (variables: GetRecordVariables) => Promise<XataRecord$1>;
|
2666
2734
|
bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables) => Promise<BulkInsertTableRecordsResponse>;
|
2667
2735
|
queryTable: (variables: QueryTableVariables) => Promise<QueryResponse>;
|
2736
|
+
searchTable: (variables: SearchTableVariables) => Promise<SearchResponse>;
|
2668
2737
|
searchBranch: (variables: SearchBranchVariables) => Promise<SearchResponse>;
|
2669
2738
|
};
|
2670
2739
|
};
|
@@ -2770,6 +2839,7 @@ declare class RecordsApi {
|
|
2770
2839
|
getRecord(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, recordId: RecordID, options?: GetRecordRequestBody): Promise<XataRecord$1>;
|
2771
2840
|
bulkInsertTableRecords(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, records: Record<string, any>[]): Promise<BulkInsertTableRecordsResponse>;
|
2772
2841
|
queryTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, query: QueryTableRequestBody): Promise<QueryResponse>;
|
2842
|
+
searchTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, query: SearchTableRequestBody): Promise<SearchResponse>;
|
2773
2843
|
searchBranch(workspace: WorkspaceID, database: DBName, branch: BranchName, query: SearchBranchRequestBody): Promise<SearchResponse>;
|
2774
2844
|
}
|
2775
2845
|
|
@@ -2797,24 +2867,25 @@ declare type SelectableColumn<O, RecursivePath extends any[] = []> = '*' | 'id'
|
|
2797
2867
|
declare type SelectedPick<O extends XataRecord, Key extends SelectableColumn<O>[]> = XataRecord & UnionToIntersection<Values<{
|
2798
2868
|
[K in Key[number]]: NestedValueAtColumn<O, K> & XataRecord;
|
2799
2869
|
}>>;
|
2800
|
-
declare type ValueAtColumn<O, P extends SelectableColumn<O>> = P extends '*' ? Values<O> : P extends 'id' ? string : P extends keyof O ? O[P] : P extends `${infer K}.${infer V}` ? K extends keyof O ? Values<O[K] extends
|
2801
|
-
V: ValueAtColumn<O[K]
|
2802
|
-
} : never
|
2870
|
+
declare type ValueAtColumn<O, P extends SelectableColumn<O>> = P extends '*' ? Values<O> : P extends 'id' ? string : P extends keyof O ? O[P] : P extends `${infer K}.${infer V}` ? K extends keyof O ? Values<RemoveNullable<O[K]> extends Record<string, any> ? V extends SelectableColumn<RemoveNullable<O[K]>> ? {
|
2871
|
+
V: ValueAtColumn<RemoveNullable<O[K]>, V>;
|
2872
|
+
} : never : O[K]> : never : never;
|
2803
2873
|
declare type MAX_RECURSION = 5;
|
2804
2874
|
declare type NestedColumns<O, RecursivePath extends any[]> = RecursivePath['length'] extends MAX_RECURSION ? never : If<IsObject<O>, Values<{
|
2805
|
-
[K in DataProps<O>]: If<IsArray<
|
2806
|
-
If<IsObject<
|
2875
|
+
[K in DataProps<O>]: If<IsArray<RemoveNullable<O[K]>>, K, // If the property is an array, we stop recursion. We don't support object arrays yet
|
2876
|
+
If<IsObject<RemoveNullable<O[K]>>, RemoveNullable<O[K]> extends XataRecord ? SelectableColumn<RemoveNullable<O[K]>, [...RecursivePath, O[K]]> extends infer Column ? Column extends string ? K | `${K}.${Column}` : never : never : `${K}.${StringKeys<RemoveNullable<O[K]>> | '*'}`, // This allows usage of objects that are not links
|
2807
2877
|
K>>;
|
2808
2878
|
}>, never>;
|
2809
2879
|
declare type DataProps<O> = Exclude<StringKeys<O>, StringKeys<XataRecord>>;
|
2810
2880
|
declare type NestedValueAtColumn<O, Key extends SelectableColumn<O>> = Key extends `${infer N}.${infer M}` ? N extends DataProps<O> ? {
|
2811
|
-
[K in N]: M extends SelectableColumn<
|
2881
|
+
[K in N]: M extends SelectableColumn<RemoveNullable<O[K]>> ? RemoveNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], NestedValueAtColumn<RemoveNullable<O[K]>, M> & XataRecord> : ForwardNullable<O[K], NestedValueAtColumn<RemoveNullable<O[K]>, M>> : unknown;
|
2812
2882
|
} : unknown : Key extends DataProps<O> ? {
|
2813
|
-
[K in Key]:
|
2883
|
+
[K in Key]: RemoveNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], SelectedPick<RemoveNullable<O[K]>, ['*']>> : O[K];
|
2814
2884
|
} : Key extends '*' ? {
|
2815
|
-
[K in StringKeys<O>]:
|
2885
|
+
[K in StringKeys<O>]: RemoveNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], Link<RemoveNullable<O[K]>>> : O[K];
|
2816
2886
|
} : unknown;
|
2817
|
-
declare type
|
2887
|
+
declare type RemoveNullable<T> = T extends null | undefined ? never : T;
|
2888
|
+
declare type ForwardNullable<T, R> = T extends RemoveNullable<T> ? R : R | null;
|
2818
2889
|
|
2819
2890
|
/**
|
2820
2891
|
* Represents an identifiable record from the database.
|
@@ -2831,16 +2902,11 @@ interface BaseData {
|
|
2831
2902
|
/**
|
2832
2903
|
* Represents a persisted record from the database.
|
2833
2904
|
*/
|
2834
|
-
interface XataRecord extends Identifiable {
|
2905
|
+
interface XataRecord<ExtraMetadata extends Record<string, unknown> = Record<string, unknown>> extends Identifiable {
|
2835
2906
|
/**
|
2836
|
-
*
|
2907
|
+
* Get metadata of this record.
|
2837
2908
|
*/
|
2838
|
-
|
2839
|
-
/**
|
2840
|
-
* Number that is increased every time the record is updated.
|
2841
|
-
*/
|
2842
|
-
version: number;
|
2843
|
-
};
|
2909
|
+
getMetadata(): XataRecordMetadata & ExtraMetadata;
|
2844
2910
|
/**
|
2845
2911
|
* Retrieves a refreshed copy of the current record from the database.
|
2846
2912
|
*/
|
@@ -2848,7 +2914,7 @@ interface XataRecord extends Identifiable {
|
|
2848
2914
|
/**
|
2849
2915
|
* Performs a partial update of the current record. On success a new object is
|
2850
2916
|
* returned and the current object is not mutated.
|
2851
|
-
* @param
|
2917
|
+
* @param partialUpdate The columns and their values that have to be updated.
|
2852
2918
|
* @returns A new record containing the latest values for all the columns of the current record.
|
2853
2919
|
*/
|
2854
2920
|
update(partialUpdate: Partial<EditableData<Omit<this, keyof XataRecord>>>): Promise<Readonly<SelectedPick<this, ['*']>>>;
|
@@ -2867,11 +2933,18 @@ declare type Link<Record extends XataRecord> = Omit<XataRecord, 'read' | 'update
|
|
2867
2933
|
/**
|
2868
2934
|
* Performs a partial update of the current record. On success a new object is
|
2869
2935
|
* returned and the current object is not mutated.
|
2870
|
-
* @param
|
2936
|
+
* @param partialUpdate The columns and their values that have to be updated.
|
2871
2937
|
* @returns A new record containing the latest values for all the columns of the current record.
|
2872
2938
|
*/
|
2873
2939
|
update(partialUpdate: Partial<EditableData<Omit<Record, keyof XataRecord>>>): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
2874
2940
|
};
|
2941
|
+
declare type XataRecordMetadata = {
|
2942
|
+
/**
|
2943
|
+
* Number that is increased every time the record is updated.
|
2944
|
+
*/
|
2945
|
+
version: number;
|
2946
|
+
warnings?: string[];
|
2947
|
+
};
|
2875
2948
|
declare function isIdentifiable(x: any): x is Identifiable & Record<string, unknown>;
|
2876
2949
|
declare function isXataRecord(x: any): x is XataRecord & Record<string, unknown>;
|
2877
2950
|
declare type EditableData<O extends BaseData> = {
|
@@ -2955,8 +3028,8 @@ declare type ValueTypeFilters<T> = T | T extends string ? StringTypeFilter : T e
|
|
2955
3028
|
],
|
2956
3029
|
}
|
2957
3030
|
*/
|
2958
|
-
declare type AggregatorFilter<
|
2959
|
-
[key in '$all' | '$any' | '$not' | '$none']?: SingleOrArray<Filter<
|
3031
|
+
declare type AggregatorFilter<T> = {
|
3032
|
+
[key in '$all' | '$any' | '$not' | '$none']?: SingleOrArray<Filter<T>>;
|
2960
3033
|
};
|
2961
3034
|
/**
|
2962
3035
|
* Existance filter
|
@@ -2971,10 +3044,10 @@ declare type BaseApiFilter<Record> = PropertyAccessFilter<Record> | AggregatorFi
|
|
2971
3044
|
* Injects the Api filters on nested properties
|
2972
3045
|
* Example: { filter: { settings: { plan: { $any: ['free', 'trial'] } } } }
|
2973
3046
|
*/
|
2974
|
-
declare type NestedApiFilter<T> =
|
3047
|
+
declare type NestedApiFilter<T> = {
|
2975
3048
|
[key in keyof T]?: T[key] extends Record<string, any> ? SingleOrArray<Filter<T[key]>> : PropertyFilter<T[key]>;
|
2976
|
-
}
|
2977
|
-
declare type Filter<
|
3049
|
+
};
|
3050
|
+
declare type Filter<T> = T extends Record<string, any> ? BaseApiFilter<T> | NestedApiFilter<T> : PropertyFilter<T>;
|
2978
3051
|
|
2979
3052
|
declare type SortDirection = 'asc' | 'desc';
|
2980
3053
|
declare type SortFilterExtended<T extends XataRecord> = {
|
@@ -3010,8 +3083,8 @@ declare type QueryOptions<T extends XataRecord> = BaseOptions<T> & (CursorQueryO
|
|
3010
3083
|
declare class Query<Record extends XataRecord, Result extends XataRecord = Record> implements Paginable<Record, Result> {
|
3011
3084
|
#private;
|
3012
3085
|
readonly meta: PaginationQueryMeta;
|
3013
|
-
readonly records: Result
|
3014
|
-
constructor(repository: Repository<Record> | null, table: string, data: Partial<QueryOptions<Record>>,
|
3086
|
+
readonly records: RecordArray<Result>;
|
3087
|
+
constructor(repository: Repository<Record> | null, table: string, data: Partial<QueryOptions<Record>>, rawParent?: Partial<QueryOptions<Record>>);
|
3015
3088
|
getQueryOptions(): QueryOptions<Record>;
|
3016
3089
|
key(): string;
|
3017
3090
|
/**
|
@@ -3043,18 +3116,28 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
3043
3116
|
*
|
3044
3117
|
* ```
|
3045
3118
|
* query.filter("columnName", columnValue)
|
3046
|
-
* query.filter(
|
3047
|
-
*
|
3048
|
-
*
|
3119
|
+
* query.filter("columnName", operator(columnValue)) // Use gt, gte, lt, lte, startsWith,...
|
3120
|
+
* ```
|
3121
|
+
*
|
3122
|
+
* @param column The name of the column to filter.
|
3123
|
+
* @param value The value to filter.
|
3124
|
+
* @returns A new Query object.
|
3125
|
+
*/
|
3126
|
+
filter<F extends SelectableColumn<Record>>(column: F, value: Filter<ValueAtColumn<Record, F>>): Query<Record, Result>;
|
3127
|
+
/**
|
3128
|
+
* Builds a new query object adding one or more constraints. Examples:
|
3129
|
+
*
|
3130
|
+
* ```
|
3131
|
+
* query.filter({ "columnName": columnValue })
|
3049
3132
|
* query.filter({
|
3050
3133
|
* "columnName": operator(columnValue) // Use gt, gte, lt, lte, startsWith,...
|
3051
3134
|
* })
|
3052
3135
|
* ```
|
3053
3136
|
*
|
3137
|
+
* @param filters A filter object
|
3054
3138
|
* @returns A new Query object.
|
3055
3139
|
*/
|
3056
3140
|
filter(filters: Filter<Record>): Query<Record, Result>;
|
3057
|
-
filter<F extends SelectableColumn<Record>>(column: F, value: Filter<ValueAtColumn<Record, F>>): Query<Record, Result>;
|
3058
3141
|
/**
|
3059
3142
|
* Builds a new query with a new sort option.
|
3060
3143
|
* @param column The column name.
|
@@ -3068,45 +3151,114 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
3068
3151
|
* @returns A new Query object.
|
3069
3152
|
*/
|
3070
3153
|
select<K extends SelectableColumn<Record>>(columns: NonEmptyArray<K>): Query<Record, SelectedPick<Record, NonEmptyArray<K>>>;
|
3154
|
+
/**
|
3155
|
+
* Get paginated results
|
3156
|
+
*
|
3157
|
+
* @returns A page of results
|
3158
|
+
*/
|
3071
3159
|
getPaginated(): Promise<Page<Record, Result>>;
|
3160
|
+
/**
|
3161
|
+
* Get paginated results
|
3162
|
+
*
|
3163
|
+
* @param options Pagination options
|
3164
|
+
* @returns A page of results
|
3165
|
+
*/
|
3072
3166
|
getPaginated(options: OmitBy<QueryOptions<Record>, 'columns'>): Promise<Page<Record, Result>>;
|
3167
|
+
/**
|
3168
|
+
* Get paginated results
|
3169
|
+
*
|
3170
|
+
* @param options Pagination options
|
3171
|
+
* @returns A page of results
|
3172
|
+
*/
|
3073
3173
|
getPaginated<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<Page<Record, SelectedPick<Record, typeof options['columns']>>>;
|
3174
|
+
/**
|
3175
|
+
* Get results in an iterator
|
3176
|
+
*
|
3177
|
+
* @async
|
3178
|
+
* @returns Async interable of results
|
3179
|
+
*/
|
3074
3180
|
[Symbol.asyncIterator](): AsyncIterableIterator<Result>;
|
3181
|
+
/**
|
3182
|
+
* Build an iterator of results
|
3183
|
+
*
|
3184
|
+
* @returns Async generator of results array
|
3185
|
+
*/
|
3075
3186
|
getIterator(): AsyncGenerator<Result[]>;
|
3187
|
+
/**
|
3188
|
+
* Build an iterator of results
|
3189
|
+
*
|
3190
|
+
* @param options Pagination options with batchSize
|
3191
|
+
* @returns Async generator of results array
|
3192
|
+
*/
|
3076
3193
|
getIterator(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'> & {
|
3077
3194
|
batchSize?: number;
|
3078
3195
|
}): AsyncGenerator<Result[]>;
|
3196
|
+
/**
|
3197
|
+
* Build an iterator of results
|
3198
|
+
*
|
3199
|
+
* @param options Pagination options with batchSize
|
3200
|
+
* @returns Async generator of results array
|
3201
|
+
*/
|
3079
3202
|
getIterator<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
|
3080
3203
|
batchSize?: number;
|
3081
3204
|
}>(options: Options): AsyncGenerator<SelectedPick<Record, typeof options['columns']>[]>;
|
3205
|
+
/**
|
3206
|
+
* Performs the query in the database and returns a set of results.
|
3207
|
+
* @returns An array of records from the database.
|
3208
|
+
*/
|
3209
|
+
getMany(): Promise<RecordArray<Result>>;
|
3082
3210
|
/**
|
3083
3211
|
* Performs the query in the database and returns a set of results.
|
3084
3212
|
* @param options Additional options to be used when performing the query.
|
3085
3213
|
* @returns An array of records from the database.
|
3086
3214
|
*/
|
3087
|
-
getMany(): Promise<Result
|
3088
|
-
|
3089
|
-
|
3215
|
+
getMany(options: OmitBy<QueryOptions<Record>, 'columns'>): Promise<RecordArray<Result>>;
|
3216
|
+
/**
|
3217
|
+
* Performs the query in the database and returns a set of results.
|
3218
|
+
* @param options Additional options to be used when performing the query.
|
3219
|
+
* @returns An array of records from the database.
|
3220
|
+
*/
|
3221
|
+
getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<RecordArray<SelectedPick<Record, typeof options['columns']>>>;
|
3090
3222
|
/**
|
3091
3223
|
* Performs the query in the database and returns all the results.
|
3092
3224
|
* Warning: If there are a large number of results, this method can have performance implications.
|
3093
|
-
* @param options Additional options to be used when performing the query.
|
3094
3225
|
* @returns An array of records from the database.
|
3095
3226
|
*/
|
3096
3227
|
getAll(): Promise<Result[]>;
|
3228
|
+
/**
|
3229
|
+
* Performs the query in the database and returns all the results.
|
3230
|
+
* Warning: If there are a large number of results, this method can have performance implications.
|
3231
|
+
* @param options Additional options to be used when performing the query.
|
3232
|
+
* @returns An array of records from the database.
|
3233
|
+
*/
|
3097
3234
|
getAll(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'> & {
|
3098
3235
|
batchSize?: number;
|
3099
3236
|
}): Promise<Result[]>;
|
3237
|
+
/**
|
3238
|
+
* Performs the query in the database and returns all the results.
|
3239
|
+
* Warning: If there are a large number of results, this method can have performance implications.
|
3240
|
+
* @param options Additional options to be used when performing the query.
|
3241
|
+
* @returns An array of records from the database.
|
3242
|
+
*/
|
3100
3243
|
getAll<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
|
3101
3244
|
batchSize?: number;
|
3102
3245
|
}>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>[]>;
|
3103
3246
|
/**
|
3104
3247
|
* Performs the query in the database and returns the first result.
|
3105
|
-
* @param options Additional options to be used when performing the query.
|
3106
3248
|
* @returns The first record that matches the query, or null if no record matched the query.
|
3107
3249
|
*/
|
3108
3250
|
getFirst(): Promise<Result | null>;
|
3251
|
+
/**
|
3252
|
+
* Performs the query in the database and returns the first result.
|
3253
|
+
* @param options Additional options to be used when performing the query.
|
3254
|
+
* @returns The first record that matches the query, or null if no record matched the query.
|
3255
|
+
*/
|
3109
3256
|
getFirst(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'>): Promise<Result | null>;
|
3257
|
+
/**
|
3258
|
+
* Performs the query in the database and returns the first result.
|
3259
|
+
* @param options Additional options to be used when performing the query.
|
3260
|
+
* @returns The first record that matches the query, or null if no record matched the query.
|
3261
|
+
*/
|
3110
3262
|
getFirst<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']> | null>;
|
3111
3263
|
/**
|
3112
3264
|
* Builds a new query object adding a cache TTL in milliseconds.
|
@@ -3114,10 +3266,33 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
|
|
3114
3266
|
* @returns A new Query object.
|
3115
3267
|
*/
|
3116
3268
|
cache(ttl: number): Query<Record, Result>;
|
3269
|
+
/**
|
3270
|
+
* Retrieve next page of records
|
3271
|
+
*
|
3272
|
+
* @returns A new page object.
|
3273
|
+
*/
|
3117
3274
|
nextPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
3275
|
+
/**
|
3276
|
+
* Retrieve previous page of records
|
3277
|
+
*
|
3278
|
+
* @returns A new page object
|
3279
|
+
*/
|
3118
3280
|
previousPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
3281
|
+
/**
|
3282
|
+
* Retrieve first page of records
|
3283
|
+
*
|
3284
|
+
* @returns A new page object
|
3285
|
+
*/
|
3119
3286
|
firstPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
3287
|
+
/**
|
3288
|
+
* Retrieve last page of records
|
3289
|
+
*
|
3290
|
+
* @returns A new page object
|
3291
|
+
*/
|
3120
3292
|
lastPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
3293
|
+
/**
|
3294
|
+
* @returns Boolean indicating if there is a next page
|
3295
|
+
*/
|
3121
3296
|
hasNextPage(): boolean;
|
3122
3297
|
}
|
3123
3298
|
|
@@ -3129,7 +3304,7 @@ declare type PaginationQueryMeta = {
|
|
3129
3304
|
};
|
3130
3305
|
interface Paginable<Record extends XataRecord, Result extends XataRecord = Record> {
|
3131
3306
|
meta: PaginationQueryMeta;
|
3132
|
-
records: Result
|
3307
|
+
records: RecordArray<Result>;
|
3133
3308
|
nextPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
3134
3309
|
previousPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
3135
3310
|
firstPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
|
@@ -3149,7 +3324,7 @@ declare class Page<Record extends XataRecord, Result extends XataRecord = Record
|
|
3149
3324
|
/**
|
3150
3325
|
* The set of results for this page.
|
3151
3326
|
*/
|
3152
|
-
readonly records: Result
|
3327
|
+
readonly records: RecordArray<Result>;
|
3153
3328
|
constructor(query: Query<Record, Result>, meta: PaginationQueryMeta, records?: Result[]);
|
3154
3329
|
/**
|
3155
3330
|
* Retrieves the next page of results.
|
@@ -3198,9 +3373,42 @@ declare type OffsetNavigationOptions = {
|
|
3198
3373
|
offset?: number;
|
3199
3374
|
};
|
3200
3375
|
declare const PAGINATION_MAX_SIZE = 200;
|
3201
|
-
declare const PAGINATION_DEFAULT_SIZE =
|
3376
|
+
declare const PAGINATION_DEFAULT_SIZE = 20;
|
3202
3377
|
declare const PAGINATION_MAX_OFFSET = 800;
|
3203
3378
|
declare const PAGINATION_DEFAULT_OFFSET = 0;
|
3379
|
+
declare function isCursorPaginationOptions(options: Record<string, unknown> | undefined | null): options is CursorNavigationOptions;
|
3380
|
+
declare class RecordArray<Result extends XataRecord> extends Array<Result> {
|
3381
|
+
#private;
|
3382
|
+
constructor(page: Paginable<any, Result>, overrideRecords?: Result[]);
|
3383
|
+
/**
|
3384
|
+
* Retrieve next page of records
|
3385
|
+
*
|
3386
|
+
* @returns A new array of objects
|
3387
|
+
*/
|
3388
|
+
nextPage(size?: number, offset?: number): Promise<RecordArray<Result>>;
|
3389
|
+
/**
|
3390
|
+
* Retrieve previous page of records
|
3391
|
+
*
|
3392
|
+
* @returns A new array of objects
|
3393
|
+
*/
|
3394
|
+
previousPage(size?: number, offset?: number): Promise<RecordArray<Result>>;
|
3395
|
+
/**
|
3396
|
+
* Retrieve first page of records
|
3397
|
+
*
|
3398
|
+
* @returns A new array of objects
|
3399
|
+
*/
|
3400
|
+
firstPage(size?: number, offset?: number): Promise<RecordArray<Result>>;
|
3401
|
+
/**
|
3402
|
+
* Retrieve last page of records
|
3403
|
+
*
|
3404
|
+
* @returns A new array of objects
|
3405
|
+
*/
|
3406
|
+
lastPage(size?: number, offset?: number): Promise<RecordArray<Result>>;
|
3407
|
+
/**
|
3408
|
+
* @returns Boolean indicating if there is a next page
|
3409
|
+
*/
|
3410
|
+
hasNextPage(): boolean;
|
3411
|
+
}
|
3204
3412
|
|
3205
3413
|
/**
|
3206
3414
|
* Common interface for performing operations on a table.
|
@@ -3226,6 +3434,12 @@ declare abstract class Repository<Data extends BaseData, Record extends XataReco
|
|
3226
3434
|
* @returns The persisted record for the given id or null if the record could not be found.
|
3227
3435
|
*/
|
3228
3436
|
abstract read(id: string): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
|
3437
|
+
/**
|
3438
|
+
* Queries multiple records from the table given their unique id.
|
3439
|
+
* @param ids The unique ids array.
|
3440
|
+
* @returns The persisted records for the given ids (if a record could not be found it is not returned).
|
3441
|
+
*/
|
3442
|
+
abstract read(ids: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
3229
3443
|
/**
|
3230
3444
|
* Partially update a single record.
|
3231
3445
|
* @param object An object with its id and the columns to be updated.
|
@@ -3298,7 +3512,9 @@ declare abstract class Repository<Data extends BaseData, Record extends XataReco
|
|
3298
3512
|
* @returns The found records.
|
3299
3513
|
*/
|
3300
3514
|
abstract search(query: string, options?: {
|
3301
|
-
fuzziness?:
|
3515
|
+
fuzziness?: FuzzinessExpression;
|
3516
|
+
highlight?: HighlightExpression;
|
3517
|
+
filter?: Filter<Record>;
|
3302
3518
|
}): Promise<SelectedPick<Record, ['*']>[]>;
|
3303
3519
|
abstract query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
|
3304
3520
|
}
|
@@ -3314,6 +3530,7 @@ declare class RestRepository<Data extends BaseData, Record extends XataRecord =
|
|
3314
3530
|
create(recordId: string, object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
|
3315
3531
|
create(objects: EditableData<Data>[]): Promise<SelectedPick<Record, ['*']>[]>;
|
3316
3532
|
read(recordId: string): Promise<SelectedPick<Record, ['*']> | null>;
|
3533
|
+
read(recordIds: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
3317
3534
|
update(object: Partial<EditableData<Data>> & Identifiable): Promise<SelectedPick<Record, ['*']>>;
|
3318
3535
|
update(recordId: string, object: Partial<EditableData<Data>>): Promise<SelectedPick<Record, ['*']>>;
|
3319
3536
|
update(objects: Array<Partial<EditableData<Data>> & Identifiable>): Promise<SelectedPick<Record, ['*']>[]>;
|
@@ -3322,7 +3539,9 @@ declare class RestRepository<Data extends BaseData, Record extends XataRecord =
|
|
3322
3539
|
createOrUpdate(objects: EditableData<Data>[]): Promise<SelectedPick<Record, ['*']>[]>;
|
3323
3540
|
delete(a: string | Identifiable | Array<string | Identifiable>): Promise<void>;
|
3324
3541
|
search(query: string, options?: {
|
3325
|
-
fuzziness?:
|
3542
|
+
fuzziness?: FuzzinessExpression;
|
3543
|
+
highlight?: HighlightExpression;
|
3544
|
+
filter?: Filter<Record>;
|
3326
3545
|
}): Promise<SelectedPick<Record, ['*']>[]>;
|
3327
3546
|
query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
|
3328
3547
|
}
|
@@ -3416,18 +3635,24 @@ declare class SchemaPlugin<Schemas extends Record<string, BaseData>> extends Xat
|
|
3416
3635
|
}
|
3417
3636
|
|
3418
3637
|
declare type SearchOptions<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>> = {
|
3419
|
-
fuzziness?:
|
3420
|
-
|
3638
|
+
fuzziness?: FuzzinessExpression;
|
3639
|
+
highlight?: HighlightExpression;
|
3640
|
+
tables?: Array<Tables | Values<{
|
3641
|
+
[Model in GetArrayInnerType<NonNullable<Tables[]>>]: {
|
3642
|
+
table: Model;
|
3643
|
+
filter?: Filter<SelectedPick<Schemas[Model] & SearchXataRecord, ['*']>>;
|
3644
|
+
};
|
3645
|
+
}>>;
|
3421
3646
|
};
|
3422
3647
|
declare type SearchPluginResult<Schemas extends Record<string, BaseData>> = {
|
3423
3648
|
all: <Tables extends StringKeys<Schemas>>(query: string, options?: SearchOptions<Schemas, Tables>) => Promise<Values<{
|
3424
|
-
[Model in GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']
|
3649
|
+
[Model in ExtractTables<Schemas, Tables, GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>>]: {
|
3425
3650
|
table: Model;
|
3426
3651
|
record: Awaited<SelectedPick<Schemas[Model] & SearchXataRecord, ['*']>>;
|
3427
3652
|
};
|
3428
3653
|
}>[]>;
|
3429
3654
|
byTable: <Tables extends StringKeys<Schemas>>(query: string, options?: SearchOptions<Schemas, Tables>) => Promise<{
|
3430
|
-
[Model in GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']
|
3655
|
+
[Model in ExtractTables<Schemas, Tables, GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>>]?: Awaited<SelectedPick<Schemas[Model] & SearchXataRecord, ['*']>[]>;
|
3431
3656
|
}>;
|
3432
3657
|
};
|
3433
3658
|
declare class SearchPlugin<Schemas extends Record<string, BaseData>> extends XataPlugin {
|
@@ -3436,11 +3661,19 @@ declare class SearchPlugin<Schemas extends Record<string, BaseData>> extends Xat
|
|
3436
3661
|
constructor(db: SchemaPluginResult<Schemas>);
|
3437
3662
|
build({ getFetchProps }: XataPluginOptions): SearchPluginResult<Schemas>;
|
3438
3663
|
}
|
3439
|
-
declare type SearchXataRecord = XataRecord
|
3440
|
-
|
3441
|
-
|
3664
|
+
declare type SearchXataRecord = XataRecord<SearchExtraProperties>;
|
3665
|
+
declare type SearchExtraProperties = {
|
3666
|
+
table: string;
|
3667
|
+
highlight?: {
|
3668
|
+
[key: string]: string[] | {
|
3669
|
+
[key: string]: any;
|
3670
|
+
};
|
3442
3671
|
};
|
3443
3672
|
};
|
3673
|
+
declare type ReturnTable<Table, Tables> = Table extends Tables ? Table : never;
|
3674
|
+
declare type ExtractTables<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>, TableOptions extends GetArrayInnerType<NonNullable<NonNullable<SearchOptions<Schemas, Tables>>['tables']>>> = TableOptions extends `${infer Table}` ? ReturnTable<Table, Tables> : TableOptions extends {
|
3675
|
+
table: infer Table;
|
3676
|
+
} ? ReturnTable<Table, Tables> : never;
|
3444
3677
|
|
3445
3678
|
declare type BranchStrategyValue = string | undefined | null;
|
3446
3679
|
declare type BranchStrategyBuilder = () => BranchStrategyValue | Promise<BranchStrategyValue>;
|
@@ -3467,13 +3700,12 @@ declare const BaseClient_base: ClientConstructor<{}>;
|
|
3467
3700
|
declare class BaseClient extends BaseClient_base<Record<string, any>> {
|
3468
3701
|
}
|
3469
3702
|
|
3470
|
-
declare const defaultBranch = "main";
|
3471
3703
|
declare type BranchResolutionOptions = {
|
3472
3704
|
databaseURL?: string;
|
3473
3705
|
apiKey?: string;
|
3474
3706
|
fetchImpl?: FetchImpl;
|
3475
3707
|
};
|
3476
|
-
declare function getCurrentBranchName(options?: BranchResolutionOptions): Promise<string
|
3708
|
+
declare function getCurrentBranchName(options?: BranchResolutionOptions): Promise<string>;
|
3477
3709
|
declare function getCurrentBranchDetails(options?: BranchResolutionOptions): Promise<DBBranch | null>;
|
3478
3710
|
declare function getDatabaseURL(): string | undefined;
|
3479
3711
|
|
@@ -3484,4 +3716,4 @@ declare class XataError extends Error {
|
|
3484
3716
|
constructor(message: string, status: number);
|
3485
3717
|
}
|
3486
3718
|
|
3487
|
-
export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, BaseClient, BaseClientOptions, BaseData, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsResponse, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, CreateBranchError, CreateBranchPathParams, CreateBranchQueryParams, CreateBranchRequestBody, CreateBranchVariables, CreateDatabaseError, CreateDatabasePathParams, CreateDatabaseRequestBody, CreateDatabaseResponse, CreateDatabaseVariables, CreateTableError, CreateTablePathParams, CreateTableVariables, CreateUserAPIKeyError, CreateUserAPIKeyPathParams, CreateUserAPIKeyResponse, CreateUserAPIKeyVariables, CreateWorkspaceError, CreateWorkspaceVariables, CursorNavigationOptions, DeleteBranchError, DeleteBranchPathParams, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabasePathParams, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, 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, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, GetDatabaseListError, GetDatabaseListPathParams, GetDatabaseListVariables, GetGitBranchesMappingError, GetGitBranchesMappingPathParams, GetGitBranchesMappingVariables, GetRecordError, GetRecordPathParams, GetRecordRequestBody, 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, InsertRecordResponse, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Paginable, PaginationQueryMeta, Query, QueryTableError, QueryTablePathParams, QueryTableRequestBody, QueryTableVariables, RemoveGitBranchesEntryError, RemoveGitBranchesEntryPathParams, RemoveGitBranchesEntryQueryParams, RemoveGitBranchesEntryVariables, RemoveWorkspaceMemberError, RemoveWorkspaceMemberPathParams, RemoveWorkspaceMemberVariables, Repository, ResendWorkspaceMemberInviteError, ResendWorkspaceMemberInvitePathParams, ResendWorkspaceMemberInviteVariables, ResolveBranchError, ResolveBranchPathParams, ResolveBranchQueryParams, ResolveBranchResponse, ResolveBranchVariables, responses as Responses, RestRepository, SchemaDefinition, SchemaPlugin, SchemaPluginResult, schemas as Schemas, SearchBranchError, SearchBranchPathParams, SearchBranchRequestBody, SearchBranchVariables, SearchOptions, SearchPlugin, SearchPluginResult, SelectableColumn, SelectedPick, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, UpdateRecordWithIDError, UpdateRecordWithIDPathParams, UpdateRecordWithIDQueryParams, UpdateRecordWithIDVariables, UpdateTableError, UpdateTablePathParams, UpdateTableRequestBody, UpdateTableVariables, UpdateUserError, UpdateUserVariables, UpdateWorkspaceError, UpdateWorkspaceMemberRoleError, UpdateWorkspaceMemberRolePathParams, UpdateWorkspaceMemberRoleRequestBody, UpdateWorkspaceMemberRoleVariables, UpdateWorkspacePathParams, UpdateWorkspaceVariables, UpsertRecordWithIDError, UpsertRecordWithIDPathParams, UpsertRecordWithIDQueryParams, UpsertRecordWithIDVariables, ValueAtColumn, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, buildClient, bulkInsertTableRecords, cancelWorkspaceMemberInvite, contains, createBranch, createDatabase, createTable, createUserAPIKey, createWorkspace,
|
3719
|
+
export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, BaseClient, BaseClientOptions, BaseData, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsResponse, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, CreateBranchError, CreateBranchPathParams, CreateBranchQueryParams, CreateBranchRequestBody, CreateBranchVariables, CreateDatabaseError, CreateDatabasePathParams, CreateDatabaseRequestBody, CreateDatabaseResponse, CreateDatabaseVariables, CreateTableError, CreateTablePathParams, CreateTableVariables, CreateUserAPIKeyError, CreateUserAPIKeyPathParams, CreateUserAPIKeyResponse, CreateUserAPIKeyVariables, CreateWorkspaceError, CreateWorkspaceVariables, CursorNavigationOptions, DeleteBranchError, DeleteBranchPathParams, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabasePathParams, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, 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, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, GetDatabaseListError, GetDatabaseListPathParams, GetDatabaseListVariables, GetGitBranchesMappingError, GetGitBranchesMappingPathParams, GetGitBranchesMappingVariables, GetRecordError, GetRecordPathParams, GetRecordRequestBody, 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, InsertRecordResponse, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Paginable, PaginationQueryMeta, 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, SchemaPlugin, SchemaPluginResult, schemas as Schemas, SearchBranchError, SearchBranchPathParams, SearchBranchRequestBody, SearchBranchVariables, SearchOptions, SearchPlugin, SearchPluginResult, SearchTableError, SearchTablePathParams, SearchTableRequestBody, SearchTableVariables, SelectableColumn, SelectedPick, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, UpdateRecordWithIDError, UpdateRecordWithIDPathParams, UpdateRecordWithIDQueryParams, UpdateRecordWithIDVariables, UpdateTableError, UpdateTablePathParams, UpdateTableRequestBody, UpdateTableVariables, UpdateUserError, UpdateUserVariables, UpdateWorkspaceError, UpdateWorkspaceMemberRoleError, UpdateWorkspaceMemberRolePathParams, UpdateWorkspaceMemberRoleRequestBody, UpdateWorkspaceMemberRoleVariables, UpdateWorkspacePathParams, UpdateWorkspaceVariables, UpsertRecordWithIDError, UpsertRecordWithIDPathParams, UpsertRecordWithIDQueryParams, UpsertRecordWithIDVariables, ValueAtColumn, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, buildClient, bulkInsertTableRecords, cancelWorkspaceMemberInvite, contains, createBranch, createDatabase, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, endsWith, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseList, getDatabaseURL, getGitBranchesMapping, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isIdentifiable, isNot, isXataRecord, le, lt, lte, notExists, operationsByTag, pattern, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, setTableSchema, startsWith, updateBranchMetadata, updateColumn, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberRole, upsertRecordWithID };
|