@xata.io/client 0.0.0-alpha.vf90263d → 0.0.0-alpha.vf9117073fa2d41de1cd4690157c24c67ca3a6650
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/.turbo/turbo-add-version.log +1 -1
- package/.turbo/turbo-build.log +4 -4
- package/CHANGELOG.md +15 -1
- package/dist/index.cjs +69 -1344
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +191 -842
- package/dist/index.mjs +68 -1344
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
@@ -55,6 +55,42 @@ type Response = {
|
|
55
55
|
};
|
56
56
|
type FetchImpl = (url: string, init?: RequestInit) => Promise<Response>;
|
57
57
|
|
58
|
+
type StringKeys<O> = Extract<keyof O, string>;
|
59
|
+
type Values<O> = O[StringKeys<O>];
|
60
|
+
type UnionToIntersection<T> = (T extends any ? (x: T) => any : never) extends (x: infer R) => any ? R : never;
|
61
|
+
type If<Condition, Then, Else> = Condition extends true ? Then : Else;
|
62
|
+
type IsObject<T> = T extends Record<string, any> ? true : false;
|
63
|
+
type IsArray<T> = T extends Array<any> ? true : false;
|
64
|
+
type RequiredBy<T, K extends keyof T> = T & {
|
65
|
+
[P in K]-?: NonNullable<T[P]>;
|
66
|
+
};
|
67
|
+
type GetArrayInnerType<T extends readonly any[]> = T[number];
|
68
|
+
type SingleOrArray<T> = T | T[];
|
69
|
+
type Dictionary<T> = Record<string, T>;
|
70
|
+
type OmitBy<T, K extends keyof T> = T extends any ? Omit<T, K> : never;
|
71
|
+
type Without<T, U> = {
|
72
|
+
[P in Exclude<keyof T, keyof U>]?: never;
|
73
|
+
};
|
74
|
+
type ExclusiveOr<T, U> = T | U extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
|
75
|
+
type Explode<T> = keyof T extends infer K ? K extends unknown ? {
|
76
|
+
[I in keyof T]: I extends K ? T[I] : never;
|
77
|
+
} : never : never;
|
78
|
+
type AtMostOne<T> = Explode<Partial<T>>;
|
79
|
+
type AtLeastOne<T, U = {
|
80
|
+
[K in keyof T]: Pick<T, K>;
|
81
|
+
}> = Partial<T> & U[keyof U];
|
82
|
+
type ExactlyOne<T> = AtMostOne<T> & AtLeastOne<T>;
|
83
|
+
type Fn = (...args: any[]) => any;
|
84
|
+
type NarrowRaw<A> = (A extends [] ? [] : never) | (A extends Narrowable ? A : never) | {
|
85
|
+
[K in keyof A]: A[K] extends Fn ? A[K] : NarrowRaw<A[K]>;
|
86
|
+
};
|
87
|
+
type Narrowable = string | number | bigint | boolean;
|
88
|
+
type Try<A1, A2, Catch = never> = A1 extends A2 ? A1 : Catch;
|
89
|
+
type Narrow<A> = Try<A, [], NarrowRaw<A>>;
|
90
|
+
type RequiredKeys<T> = {
|
91
|
+
[K in keyof T]-?: {} extends Pick<T, K> ? never : K;
|
92
|
+
}[keyof T];
|
93
|
+
|
58
94
|
declare class ErrorWithCause extends Error {
|
59
95
|
cause?: Error;
|
60
96
|
constructor(message?: string, options?: {
|
@@ -414,6 +450,10 @@ type DatabaseMetadata = {
|
|
414
450
|
* @x-internal true
|
415
451
|
*/
|
416
452
|
newMigrations?: boolean;
|
453
|
+
/**
|
454
|
+
* @x-internal true
|
455
|
+
*/
|
456
|
+
defaultClusterID?: string;
|
417
457
|
/**
|
418
458
|
* Metadata about the database for display in Xata user interfaces
|
419
459
|
*/
|
@@ -1313,7 +1353,7 @@ type CreateDatabaseRequestBody = {
|
|
1313
1353
|
*/
|
1314
1354
|
region: string;
|
1315
1355
|
/**
|
1316
|
-
* The dedicated cluster where branches from this database will be created. Defaults to '
|
1356
|
+
* The dedicated cluster where branches from this database will be created. Defaults to 'shared-cluster'.
|
1317
1357
|
*
|
1318
1358
|
* @minLength 1
|
1319
1359
|
* @x-internal true
|
@@ -1416,6 +1456,13 @@ type UpdateDatabaseMetadataRequestBody = {
|
|
1416
1456
|
*/
|
1417
1457
|
color?: string;
|
1418
1458
|
};
|
1459
|
+
/**
|
1460
|
+
* The dedicated cluster where branches from this database will be created. Defaults to 'shared-cluster'.
|
1461
|
+
*
|
1462
|
+
* @minLength 1
|
1463
|
+
* @x-internal true
|
1464
|
+
*/
|
1465
|
+
defaultClusterID?: string;
|
1419
1466
|
};
|
1420
1467
|
type UpdateDatabaseMetadataVariables = {
|
1421
1468
|
body?: UpdateDatabaseMetadataRequestBody;
|
@@ -1581,6 +1628,38 @@ declare const listRegions: (variables: ListRegionsVariables, signal?: AbortSigna
|
|
1581
1628
|
* @pattern [a-zA-Z0-9_\-~]+:[a-zA-Z0-9_\-~]+
|
1582
1629
|
*/
|
1583
1630
|
type DBBranchName = string;
|
1631
|
+
type PgRollApplyMigrationResponse = {
|
1632
|
+
/**
|
1633
|
+
* The id of the migration job
|
1634
|
+
*/
|
1635
|
+
jobID: string;
|
1636
|
+
};
|
1637
|
+
type PgRollJobType = 'apply' | 'start' | 'complete' | 'rollback';
|
1638
|
+
type PgRollJobStatus = 'pending' | 'in_progress' | 'completed' | 'failed';
|
1639
|
+
type PgRollJobStatusResponse = {
|
1640
|
+
/**
|
1641
|
+
* The id of the migration job
|
1642
|
+
*/
|
1643
|
+
jobID: string;
|
1644
|
+
/**
|
1645
|
+
* The type of the migration job
|
1646
|
+
*/
|
1647
|
+
type: PgRollJobType;
|
1648
|
+
/**
|
1649
|
+
* The status of the migration job
|
1650
|
+
*/
|
1651
|
+
status: PgRollJobStatus;
|
1652
|
+
/**
|
1653
|
+
* The error message associated with the migration job
|
1654
|
+
*/
|
1655
|
+
error?: string;
|
1656
|
+
};
|
1657
|
+
/**
|
1658
|
+
* @maxLength 255
|
1659
|
+
* @minLength 1
|
1660
|
+
* @pattern [a-zA-Z0-9_\-~]+
|
1661
|
+
*/
|
1662
|
+
type PgRollMigrationJobID = string;
|
1584
1663
|
/**
|
1585
1664
|
* @maxLength 255
|
1586
1665
|
* @minLength 1
|
@@ -1594,6 +1673,13 @@ type DBName = string;
|
|
1594
1673
|
type DateTime = string;
|
1595
1674
|
type Branch = {
|
1596
1675
|
name: string;
|
1676
|
+
/**
|
1677
|
+
* The cluster where this branch resides. Value of 'shared-cluster' for branches in shared clusters
|
1678
|
+
*
|
1679
|
+
* @minLength 1
|
1680
|
+
* @x-internal true
|
1681
|
+
*/
|
1682
|
+
clusterID?: string;
|
1597
1683
|
createdAt: DateTime;
|
1598
1684
|
};
|
1599
1685
|
type ListBranchesResponse = {
|
@@ -1680,6 +1766,13 @@ type DBBranch = {
|
|
1680
1766
|
branchName: BranchName;
|
1681
1767
|
createdAt: DateTime;
|
1682
1768
|
id: string;
|
1769
|
+
/**
|
1770
|
+
* The cluster where this branch resides. Value of 'shared-cluster' for branches in shared clusters
|
1771
|
+
*
|
1772
|
+
* @minLength 1
|
1773
|
+
* @x-internal true
|
1774
|
+
*/
|
1775
|
+
clusterID?: string;
|
1683
1776
|
version: number;
|
1684
1777
|
lastMigrationID: string;
|
1685
1778
|
metadata?: BranchMetadata;
|
@@ -2957,7 +3050,55 @@ type ApplyMigrationVariables = {
|
|
2957
3050
|
/**
|
2958
3051
|
* Applies a pgroll migration to the specified database.
|
2959
3052
|
*/
|
2960
|
-
declare const applyMigration: (variables: ApplyMigrationVariables, signal?: AbortSignal) => Promise<
|
3053
|
+
declare const applyMigration: (variables: ApplyMigrationVariables, signal?: AbortSignal) => Promise<PgRollApplyMigrationResponse>;
|
3054
|
+
type PgRollStatusPathParams = {
|
3055
|
+
/**
|
3056
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3057
|
+
*/
|
3058
|
+
dbBranchName: DBBranchName;
|
3059
|
+
workspace: string;
|
3060
|
+
region: string;
|
3061
|
+
};
|
3062
|
+
type PgRollStatusError = ErrorWrapper<{
|
3063
|
+
status: 400;
|
3064
|
+
payload: BadRequestError;
|
3065
|
+
} | {
|
3066
|
+
status: 401;
|
3067
|
+
payload: AuthError;
|
3068
|
+
} | {
|
3069
|
+
status: 404;
|
3070
|
+
payload: SimpleError;
|
3071
|
+
}>;
|
3072
|
+
type PgRollStatusVariables = {
|
3073
|
+
pathParams: PgRollStatusPathParams;
|
3074
|
+
} & DataPlaneFetcherExtraProps;
|
3075
|
+
declare const pgRollStatus: (variables: PgRollStatusVariables, signal?: AbortSignal) => Promise<PgRollJobStatusResponse>;
|
3076
|
+
type PgRollJobStatusPathParams = {
|
3077
|
+
/**
|
3078
|
+
* The DBBranchName matches the pattern `{db_name}:{branch_name}`.
|
3079
|
+
*/
|
3080
|
+
dbBranchName: DBBranchName;
|
3081
|
+
/**
|
3082
|
+
* The id of the migration job
|
3083
|
+
*/
|
3084
|
+
jobId: PgRollMigrationJobID;
|
3085
|
+
workspace: string;
|
3086
|
+
region: string;
|
3087
|
+
};
|
3088
|
+
type PgRollJobStatusError = ErrorWrapper<{
|
3089
|
+
status: 400;
|
3090
|
+
payload: BadRequestError;
|
3091
|
+
} | {
|
3092
|
+
status: 401;
|
3093
|
+
payload: AuthError;
|
3094
|
+
} | {
|
3095
|
+
status: 404;
|
3096
|
+
payload: SimpleError;
|
3097
|
+
}>;
|
3098
|
+
type PgRollJobStatusVariables = {
|
3099
|
+
pathParams: PgRollJobStatusPathParams;
|
3100
|
+
} & DataPlaneFetcherExtraProps;
|
3101
|
+
declare const pgRollJobStatus: (variables: PgRollJobStatusVariables, signal?: AbortSignal) => Promise<PgRollJobStatusResponse>;
|
2961
3102
|
type GetBranchListPathParams = {
|
2962
3103
|
/**
|
2963
3104
|
* The Database Name
|
@@ -6316,7 +6457,9 @@ declare const sqlQuery: (variables: SqlQueryVariables, signal?: AbortSignal) =>
|
|
6316
6457
|
|
6317
6458
|
declare const operationsByTag: {
|
6318
6459
|
branch: {
|
6319
|
-
applyMigration: (variables: ApplyMigrationVariables, signal?: AbortSignal | undefined) => Promise<
|
6460
|
+
applyMigration: (variables: ApplyMigrationVariables, signal?: AbortSignal | undefined) => Promise<PgRollApplyMigrationResponse>;
|
6461
|
+
pgRollStatus: (variables: PgRollStatusVariables, signal?: AbortSignal | undefined) => Promise<PgRollJobStatusResponse>;
|
6462
|
+
pgRollJobStatus: (variables: PgRollJobStatusVariables, signal?: AbortSignal | undefined) => Promise<PgRollJobStatusResponse>;
|
6320
6463
|
getBranchList: (variables: GetBranchListVariables, signal?: AbortSignal | undefined) => Promise<ListBranchesResponse>;
|
6321
6464
|
getBranchDetails: (variables: GetBranchDetailsVariables, signal?: AbortSignal | undefined) => Promise<DBBranch>;
|
6322
6465
|
createBranch: (variables: CreateBranchVariables, signal?: AbortSignal | undefined) => Promise<CreateBranchResponse>;
|
@@ -6469,6 +6612,27 @@ declare function parseWorkspacesUrlParts(url: string): {
|
|
6469
6612
|
region: string;
|
6470
6613
|
} | null;
|
6471
6614
|
|
6615
|
+
type ApiExtraProps = Omit<FetcherExtraProps, 'endpoint'>;
|
6616
|
+
interface XataApiClientOptions {
|
6617
|
+
fetch?: FetchImpl;
|
6618
|
+
apiKey?: string;
|
6619
|
+
host?: HostProvider;
|
6620
|
+
trace?: TraceFunction;
|
6621
|
+
clientName?: string;
|
6622
|
+
xataAgentExtra?: Record<string, string>;
|
6623
|
+
}
|
6624
|
+
type UserProps = {
|
6625
|
+
headers?: Record<string, unknown>;
|
6626
|
+
};
|
6627
|
+
type XataApiProxy = {
|
6628
|
+
[Tag in keyof typeof operationsByTag]: {
|
6629
|
+
[Method in keyof (typeof operationsByTag)[Tag]]: (typeof operationsByTag)[Tag][Method] extends infer Operation extends (...args: any) => any ? Omit<Parameters<Operation>[0], keyof ApiExtraProps> extends infer Params ? RequiredKeys<Params> extends never ? (params?: Params & UserProps) => ReturnType<Operation> : (params: Params & UserProps) => ReturnType<Operation> : never : never;
|
6630
|
+
};
|
6631
|
+
};
|
6632
|
+
declare const XataApiClient_base: new (options?: XataApiClientOptions | undefined) => XataApiProxy;
|
6633
|
+
declare class XataApiClient extends XataApiClient_base {
|
6634
|
+
}
|
6635
|
+
|
6472
6636
|
type responses_AggResponse = AggResponse;
|
6473
6637
|
type responses_AuthError = AuthError;
|
6474
6638
|
type responses_BadRequestError = BadRequestError;
|
@@ -6583,6 +6747,11 @@ type schemas_OAuthScope = OAuthScope;
|
|
6583
6747
|
type schemas_ObjectValue = ObjectValue;
|
6584
6748
|
type schemas_PageConfig = PageConfig;
|
6585
6749
|
type schemas_PercentilesAgg = PercentilesAgg;
|
6750
|
+
type schemas_PgRollApplyMigrationResponse = PgRollApplyMigrationResponse;
|
6751
|
+
type schemas_PgRollJobStatus = PgRollJobStatus;
|
6752
|
+
type schemas_PgRollJobStatusResponse = PgRollJobStatusResponse;
|
6753
|
+
type schemas_PgRollJobType = PgRollJobType;
|
6754
|
+
type schemas_PgRollMigrationJobID = PgRollMigrationJobID;
|
6586
6755
|
type schemas_PrefixExpression = PrefixExpression;
|
6587
6756
|
type schemas_ProjectionConfig = ProjectionConfig;
|
6588
6757
|
type schemas_QueryColumnsProjection = QueryColumnsProjection;
|
@@ -6636,753 +6805,13 @@ type schemas_WorkspaceMembers = WorkspaceMembers;
|
|
6636
6805
|
type schemas_WorkspaceMeta = WorkspaceMeta;
|
6637
6806
|
type schemas_WorkspacePlan = WorkspacePlan;
|
6638
6807
|
declare namespace schemas {
|
6639
|
-
export type { schemas_APIKeyName as APIKeyName, schemas_AccessToken as AccessToken, schemas_AggExpression as AggExpression, schemas_AggExpressionMap as AggExpressionMap, AggResponse$1 as AggResponse, schemas_AuthorizationCodeRequest as AuthorizationCodeRequest, schemas_AuthorizationCodeResponse as AuthorizationCodeResponse, schemas_AutoscalingConfig as AutoscalingConfig, schemas_AverageAgg as AverageAgg, schemas_BoosterExpression as BoosterExpression, schemas_Branch as Branch, schemas_BranchMetadata as BranchMetadata, schemas_BranchMigration as BranchMigration, schemas_BranchName as BranchName, schemas_BranchOp as BranchOp, schemas_BranchWithCopyID as BranchWithCopyID, schemas_ClusterConfiguration as ClusterConfiguration, schemas_ClusterCreateDetails as ClusterCreateDetails, schemas_ClusterID as ClusterID, schemas_ClusterMetadata as ClusterMetadata, schemas_ClusterResponse as ClusterResponse, schemas_ClusterShortMetadata as ClusterShortMetadata, schemas_ClusterUpdateDetails as ClusterUpdateDetails, schemas_Column as Column, schemas_ColumnFile as ColumnFile, schemas_ColumnLink as ColumnLink, schemas_ColumnMigration as ColumnMigration, schemas_ColumnName as ColumnName, schemas_ColumnOpAdd as ColumnOpAdd, schemas_ColumnOpRemove as ColumnOpRemove, schemas_ColumnOpRename as ColumnOpRename, schemas_ColumnVector as ColumnVector, schemas_ColumnsProjection as ColumnsProjection, schemas_Commit as Commit, schemas_CountAgg as CountAgg, schemas_DBBranch as DBBranch, schemas_DBBranchName as DBBranchName, schemas_DBName as DBName, schemas_DailyTimeWindow as DailyTimeWindow, schemas_DataInputRecord as DataInputRecord, schemas_DatabaseGithubSettings as DatabaseGithubSettings, schemas_DatabaseMetadata as DatabaseMetadata, DateBooster$1 as DateBooster, schemas_DateHistogramAgg as DateHistogramAgg, schemas_DateTime as DateTime, schemas_FileAccessID as FileAccessID, schemas_FileItemID as FileItemID, schemas_FileName as FileName, schemas_FileResponse as FileResponse, schemas_FileSignature as FileSignature, schemas_FilterColumn as FilterColumn, schemas_FilterColumnIncludes as FilterColumnIncludes, schemas_FilterExpression as FilterExpression, schemas_FilterList as FilterList, schemas_FilterPredicate as FilterPredicate, schemas_FilterPredicateOp as FilterPredicateOp, schemas_FilterPredicateRangeOp as FilterPredicateRangeOp, schemas_FilterRangeValue as FilterRangeValue, schemas_FilterValue as FilterValue, schemas_FuzzinessExpression as FuzzinessExpression, schemas_HighlightExpression as HighlightExpression, schemas_InputFile as InputFile, schemas_InputFileArray as InputFileArray, schemas_InputFileEntry as InputFileEntry, schemas_InviteID as InviteID, schemas_InviteKey as InviteKey, schemas_ListBranchesResponse as ListBranchesResponse, schemas_ListClustersResponse as ListClustersResponse, schemas_ListDatabasesResponse as ListDatabasesResponse, schemas_ListGitBranchesResponse as ListGitBranchesResponse, schemas_ListRegionsResponse as ListRegionsResponse, schemas_MaintenanceConfig as MaintenanceConfig, schemas_MaxAgg as MaxAgg, schemas_MediaType as MediaType, schemas_MetricsDatapoint as MetricsDatapoint, schemas_MetricsLatency as MetricsLatency, schemas_Migration as Migration, schemas_MigrationColumnOp as MigrationColumnOp, schemas_MigrationObject as MigrationObject, schemas_MigrationOp as MigrationOp, schemas_MigrationRequest as MigrationRequest, schemas_MigrationRequestNumber as MigrationRequestNumber, schemas_MigrationStatus as MigrationStatus, schemas_MigrationTableOp as MigrationTableOp, schemas_MinAgg as MinAgg, NumericBooster$1 as NumericBooster, schemas_NumericHistogramAgg as NumericHistogramAgg, schemas_OAuthAccessToken as OAuthAccessToken, schemas_OAuthClientID as OAuthClientID, schemas_OAuthClientPublicDetails as OAuthClientPublicDetails, schemas_OAuthResponseType as OAuthResponseType, schemas_OAuthScope as OAuthScope, schemas_ObjectValue as ObjectValue, schemas_PageConfig as PageConfig, schemas_PercentilesAgg as PercentilesAgg, schemas_PrefixExpression as PrefixExpression, schemas_ProjectionConfig as ProjectionConfig, schemas_QueryColumnsProjection as QueryColumnsProjection, schemas_RecordID as RecordID, schemas_RecordMeta as RecordMeta, schemas_RecordsMetadata as RecordsMetadata, schemas_Region as Region, schemas_RevLink as RevLink, schemas_Role as Role, schemas_SQLRecord as SQLRecord, schemas_Schema as Schema, schemas_SchemaEditScript as SchemaEditScript, schemas_SearchPageConfig as SearchPageConfig, schemas_SortExpression as SortExpression, schemas_SortOrder as SortOrder, schemas_StartedFromMetadata as StartedFromMetadata, schemas_SumAgg as SumAgg, schemas_SummaryExpression as SummaryExpression, schemas_SummaryExpressionList as SummaryExpressionList, schemas_Table as Table, schemas_TableMigration as TableMigration, schemas_TableName as TableName, schemas_TableOpAdd as TableOpAdd, schemas_TableOpRemove as TableOpRemove, schemas_TableOpRename as TableOpRename, schemas_TableRename as TableRename, schemas_TargetExpression as TargetExpression, schemas_TopValuesAgg as TopValuesAgg, schemas_TransactionDeleteOp as TransactionDeleteOp, schemas_TransactionError as TransactionError, schemas_TransactionFailure as TransactionFailure, schemas_TransactionGetOp as TransactionGetOp, schemas_TransactionInsertOp as TransactionInsertOp, TransactionOperation$1 as TransactionOperation, schemas_TransactionResultColumns as TransactionResultColumns, schemas_TransactionResultDelete as TransactionResultDelete, schemas_TransactionResultGet as TransactionResultGet, schemas_TransactionResultInsert as TransactionResultInsert, schemas_TransactionResultUpdate as TransactionResultUpdate, schemas_TransactionSuccess as TransactionSuccess, schemas_TransactionUpdateOp as TransactionUpdateOp, schemas_UniqueCountAgg as UniqueCountAgg, schemas_User as User, schemas_UserID as UserID, schemas_UserWithID as UserWithID, ValueBooster$1 as ValueBooster, schemas_WeeklyTimeWindow as WeeklyTimeWindow, schemas_Workspace as Workspace, schemas_WorkspaceID as WorkspaceID, schemas_WorkspaceInvite as WorkspaceInvite, schemas_WorkspaceMember as WorkspaceMember, schemas_WorkspaceMembers as WorkspaceMembers, schemas_WorkspaceMeta as WorkspaceMeta, schemas_WorkspacePlan as WorkspacePlan, XataRecord$1 as XataRecord };
|
6640
|
-
}
|
6641
|
-
|
6642
|
-
type ApiExtraProps = Omit<FetcherExtraProps, 'endpoint'>;
|
6643
|
-
interface XataApiClientOptions {
|
6644
|
-
fetch?: FetchImpl;
|
6645
|
-
apiKey?: string;
|
6646
|
-
host?: HostProvider;
|
6647
|
-
trace?: TraceFunction;
|
6648
|
-
clientName?: string;
|
6649
|
-
xataAgentExtra?: Record<string, string>;
|
6650
|
-
}
|
6651
|
-
declare class XataApiClient {
|
6652
|
-
#private;
|
6653
|
-
constructor(options?: XataApiClientOptions);
|
6654
|
-
get user(): UserApi;
|
6655
|
-
get authentication(): AuthenticationApi;
|
6656
|
-
get workspaces(): WorkspaceApi;
|
6657
|
-
get invites(): InvitesApi;
|
6658
|
-
get database(): DatabaseApi;
|
6659
|
-
get branches(): BranchApi;
|
6660
|
-
get migrations(): MigrationsApi;
|
6661
|
-
get migrationRequests(): MigrationRequestsApi;
|
6662
|
-
get tables(): TableApi;
|
6663
|
-
get records(): RecordsApi;
|
6664
|
-
get files(): FilesApi;
|
6665
|
-
get searchAndFilter(): SearchAndFilterApi;
|
6666
|
-
}
|
6667
|
-
declare class UserApi {
|
6668
|
-
private extraProps;
|
6669
|
-
constructor(extraProps: ApiExtraProps);
|
6670
|
-
getUser(): Promise<UserWithID>;
|
6671
|
-
updateUser({ user }: {
|
6672
|
-
user: User;
|
6673
|
-
}): Promise<UserWithID>;
|
6674
|
-
deleteUser(): Promise<void>;
|
6675
|
-
}
|
6676
|
-
declare class AuthenticationApi {
|
6677
|
-
private extraProps;
|
6678
|
-
constructor(extraProps: ApiExtraProps);
|
6679
|
-
getUserAPIKeys(): Promise<GetUserAPIKeysResponse>;
|
6680
|
-
createUserAPIKey({ name }: {
|
6681
|
-
name: APIKeyName;
|
6682
|
-
}): Promise<CreateUserAPIKeyResponse>;
|
6683
|
-
deleteUserAPIKey({ name }: {
|
6684
|
-
name: APIKeyName;
|
6685
|
-
}): Promise<void>;
|
6686
|
-
}
|
6687
|
-
declare class WorkspaceApi {
|
6688
|
-
private extraProps;
|
6689
|
-
constructor(extraProps: ApiExtraProps);
|
6690
|
-
getWorkspacesList(): Promise<GetWorkspacesListResponse>;
|
6691
|
-
createWorkspace({ data }: {
|
6692
|
-
data: WorkspaceMeta;
|
6693
|
-
}): Promise<Workspace>;
|
6694
|
-
getWorkspace({ workspace }: {
|
6695
|
-
workspace: WorkspaceID;
|
6696
|
-
}): Promise<Workspace>;
|
6697
|
-
updateWorkspace({ workspace, update }: {
|
6698
|
-
workspace: WorkspaceID;
|
6699
|
-
update: WorkspaceMeta;
|
6700
|
-
}): Promise<Workspace>;
|
6701
|
-
deleteWorkspace({ workspace }: {
|
6702
|
-
workspace: WorkspaceID;
|
6703
|
-
}): Promise<void>;
|
6704
|
-
getWorkspaceMembersList({ workspace }: {
|
6705
|
-
workspace: WorkspaceID;
|
6706
|
-
}): Promise<WorkspaceMembers>;
|
6707
|
-
updateWorkspaceMemberRole({ workspace, user, role }: {
|
6708
|
-
workspace: WorkspaceID;
|
6709
|
-
user: UserID;
|
6710
|
-
role: Role;
|
6711
|
-
}): Promise<void>;
|
6712
|
-
removeWorkspaceMember({ workspace, user }: {
|
6713
|
-
workspace: WorkspaceID;
|
6714
|
-
user: UserID;
|
6715
|
-
}): Promise<void>;
|
6716
|
-
}
|
6717
|
-
declare class InvitesApi {
|
6718
|
-
private extraProps;
|
6719
|
-
constructor(extraProps: ApiExtraProps);
|
6720
|
-
inviteWorkspaceMember({ workspace, email, role }: {
|
6721
|
-
workspace: WorkspaceID;
|
6722
|
-
email: string;
|
6723
|
-
role: Role;
|
6724
|
-
}): Promise<WorkspaceInvite>;
|
6725
|
-
updateWorkspaceMemberInvite({ workspace, invite, role }: {
|
6726
|
-
workspace: WorkspaceID;
|
6727
|
-
invite: InviteID;
|
6728
|
-
role: Role;
|
6729
|
-
}): Promise<WorkspaceInvite>;
|
6730
|
-
cancelWorkspaceMemberInvite({ workspace, invite }: {
|
6731
|
-
workspace: WorkspaceID;
|
6732
|
-
invite: InviteID;
|
6733
|
-
}): Promise<void>;
|
6734
|
-
acceptWorkspaceMemberInvite({ workspace, key }: {
|
6735
|
-
workspace: WorkspaceID;
|
6736
|
-
key: InviteKey;
|
6737
|
-
}): Promise<void>;
|
6738
|
-
resendWorkspaceMemberInvite({ workspace, invite }: {
|
6739
|
-
workspace: WorkspaceID;
|
6740
|
-
invite: InviteID;
|
6741
|
-
}): Promise<void>;
|
6742
|
-
}
|
6743
|
-
declare class BranchApi {
|
6744
|
-
private extraProps;
|
6745
|
-
constructor(extraProps: ApiExtraProps);
|
6746
|
-
getBranchList({ workspace, region, database }: {
|
6747
|
-
workspace: WorkspaceID;
|
6748
|
-
region: string;
|
6749
|
-
database: DBName;
|
6750
|
-
}): Promise<ListBranchesResponse>;
|
6751
|
-
getBranchDetails({ workspace, region, database, branch }: {
|
6752
|
-
workspace: WorkspaceID;
|
6753
|
-
region: string;
|
6754
|
-
database: DBName;
|
6755
|
-
branch: BranchName;
|
6756
|
-
}): Promise<DBBranch>;
|
6757
|
-
createBranch({ workspace, region, database, branch, from, metadata }: {
|
6758
|
-
workspace: WorkspaceID;
|
6759
|
-
region: string;
|
6760
|
-
database: DBName;
|
6761
|
-
branch: BranchName;
|
6762
|
-
from?: string;
|
6763
|
-
metadata?: BranchMetadata;
|
6764
|
-
}): Promise<CreateBranchResponse>;
|
6765
|
-
deleteBranch({ workspace, region, database, branch }: {
|
6766
|
-
workspace: WorkspaceID;
|
6767
|
-
region: string;
|
6768
|
-
database: DBName;
|
6769
|
-
branch: BranchName;
|
6770
|
-
}): Promise<DeleteBranchResponse>;
|
6771
|
-
copyBranch({ workspace, region, database, branch, destinationBranch, limit }: {
|
6772
|
-
workspace: WorkspaceID;
|
6773
|
-
region: string;
|
6774
|
-
database: DBName;
|
6775
|
-
branch: BranchName;
|
6776
|
-
destinationBranch: BranchName;
|
6777
|
-
limit?: number;
|
6778
|
-
}): Promise<BranchWithCopyID>;
|
6779
|
-
updateBranchMetadata({ workspace, region, database, branch, metadata }: {
|
6780
|
-
workspace: WorkspaceID;
|
6781
|
-
region: string;
|
6782
|
-
database: DBName;
|
6783
|
-
branch: BranchName;
|
6784
|
-
metadata: BranchMetadata;
|
6785
|
-
}): Promise<void>;
|
6786
|
-
getBranchMetadata({ workspace, region, database, branch }: {
|
6787
|
-
workspace: WorkspaceID;
|
6788
|
-
region: string;
|
6789
|
-
database: DBName;
|
6790
|
-
branch: BranchName;
|
6791
|
-
}): Promise<BranchMetadata>;
|
6792
|
-
getBranchStats({ workspace, region, database, branch }: {
|
6793
|
-
workspace: WorkspaceID;
|
6794
|
-
region: string;
|
6795
|
-
database: DBName;
|
6796
|
-
branch: BranchName;
|
6797
|
-
}): Promise<GetBranchStatsResponse>;
|
6798
|
-
getGitBranchesMapping({ workspace, region, database }: {
|
6799
|
-
workspace: WorkspaceID;
|
6800
|
-
region: string;
|
6801
|
-
database: DBName;
|
6802
|
-
}): Promise<ListGitBranchesResponse>;
|
6803
|
-
addGitBranchesEntry({ workspace, region, database, gitBranch, xataBranch }: {
|
6804
|
-
workspace: WorkspaceID;
|
6805
|
-
region: string;
|
6806
|
-
database: DBName;
|
6807
|
-
gitBranch: string;
|
6808
|
-
xataBranch: BranchName;
|
6809
|
-
}): Promise<AddGitBranchesEntryResponse>;
|
6810
|
-
removeGitBranchesEntry({ workspace, region, database, gitBranch }: {
|
6811
|
-
workspace: WorkspaceID;
|
6812
|
-
region: string;
|
6813
|
-
database: DBName;
|
6814
|
-
gitBranch: string;
|
6815
|
-
}): Promise<void>;
|
6816
|
-
resolveBranch({ workspace, region, database, gitBranch, fallbackBranch }: {
|
6817
|
-
workspace: WorkspaceID;
|
6818
|
-
region: string;
|
6819
|
-
database: DBName;
|
6820
|
-
gitBranch?: string;
|
6821
|
-
fallbackBranch?: string;
|
6822
|
-
}): Promise<ResolveBranchResponse>;
|
6823
|
-
}
|
6824
|
-
declare class TableApi {
|
6825
|
-
private extraProps;
|
6826
|
-
constructor(extraProps: ApiExtraProps);
|
6827
|
-
createTable({ workspace, region, database, branch, table }: {
|
6828
|
-
workspace: WorkspaceID;
|
6829
|
-
region: string;
|
6830
|
-
database: DBName;
|
6831
|
-
branch: BranchName;
|
6832
|
-
table: TableName;
|
6833
|
-
}): Promise<CreateTableResponse>;
|
6834
|
-
deleteTable({ workspace, region, database, branch, table }: {
|
6835
|
-
workspace: WorkspaceID;
|
6836
|
-
region: string;
|
6837
|
-
database: DBName;
|
6838
|
-
branch: BranchName;
|
6839
|
-
table: TableName;
|
6840
|
-
}): Promise<DeleteTableResponse>;
|
6841
|
-
updateTable({ workspace, region, database, branch, table, update }: {
|
6842
|
-
workspace: WorkspaceID;
|
6843
|
-
region: string;
|
6844
|
-
database: DBName;
|
6845
|
-
branch: BranchName;
|
6846
|
-
table: TableName;
|
6847
|
-
update: UpdateTableRequestBody;
|
6848
|
-
}): Promise<SchemaUpdateResponse>;
|
6849
|
-
getTableSchema({ workspace, region, database, branch, table }: {
|
6850
|
-
workspace: WorkspaceID;
|
6851
|
-
region: string;
|
6852
|
-
database: DBName;
|
6853
|
-
branch: BranchName;
|
6854
|
-
table: TableName;
|
6855
|
-
}): Promise<GetTableSchemaResponse>;
|
6856
|
-
setTableSchema({ workspace, region, database, branch, table, schema }: {
|
6857
|
-
workspace: WorkspaceID;
|
6858
|
-
region: string;
|
6859
|
-
database: DBName;
|
6860
|
-
branch: BranchName;
|
6861
|
-
table: TableName;
|
6862
|
-
schema: SetTableSchemaRequestBody;
|
6863
|
-
}): Promise<SchemaUpdateResponse>;
|
6864
|
-
getTableColumns({ workspace, region, database, branch, table }: {
|
6865
|
-
workspace: WorkspaceID;
|
6866
|
-
region: string;
|
6867
|
-
database: DBName;
|
6868
|
-
branch: BranchName;
|
6869
|
-
table: TableName;
|
6870
|
-
}): Promise<GetTableColumnsResponse>;
|
6871
|
-
addTableColumn({ workspace, region, database, branch, table, column }: {
|
6872
|
-
workspace: WorkspaceID;
|
6873
|
-
region: string;
|
6874
|
-
database: DBName;
|
6875
|
-
branch: BranchName;
|
6876
|
-
table: TableName;
|
6877
|
-
column: Column;
|
6878
|
-
}): Promise<SchemaUpdateResponse>;
|
6879
|
-
getColumn({ workspace, region, database, branch, table, column }: {
|
6880
|
-
workspace: WorkspaceID;
|
6881
|
-
region: string;
|
6882
|
-
database: DBName;
|
6883
|
-
branch: BranchName;
|
6884
|
-
table: TableName;
|
6885
|
-
column: ColumnName;
|
6886
|
-
}): Promise<Column>;
|
6887
|
-
updateColumn({ workspace, region, database, branch, table, column, update }: {
|
6888
|
-
workspace: WorkspaceID;
|
6889
|
-
region: string;
|
6890
|
-
database: DBName;
|
6891
|
-
branch: BranchName;
|
6892
|
-
table: TableName;
|
6893
|
-
column: ColumnName;
|
6894
|
-
update: UpdateColumnRequestBody;
|
6895
|
-
}): Promise<SchemaUpdateResponse>;
|
6896
|
-
deleteColumn({ workspace, region, database, branch, table, column }: {
|
6897
|
-
workspace: WorkspaceID;
|
6898
|
-
region: string;
|
6899
|
-
database: DBName;
|
6900
|
-
branch: BranchName;
|
6901
|
-
table: TableName;
|
6902
|
-
column: ColumnName;
|
6903
|
-
}): Promise<SchemaUpdateResponse>;
|
6904
|
-
}
|
6905
|
-
declare class RecordsApi {
|
6906
|
-
private extraProps;
|
6907
|
-
constructor(extraProps: ApiExtraProps);
|
6908
|
-
insertRecord({ workspace, region, database, branch, table, record, columns }: {
|
6909
|
-
workspace: WorkspaceID;
|
6910
|
-
region: string;
|
6911
|
-
database: DBName;
|
6912
|
-
branch: BranchName;
|
6913
|
-
table: TableName;
|
6914
|
-
record: Record<string, any>;
|
6915
|
-
columns?: ColumnsProjection;
|
6916
|
-
}): Promise<RecordUpdateResponse>;
|
6917
|
-
getRecord({ workspace, region, database, branch, table, id, columns }: {
|
6918
|
-
workspace: WorkspaceID;
|
6919
|
-
region: string;
|
6920
|
-
database: DBName;
|
6921
|
-
branch: BranchName;
|
6922
|
-
table: TableName;
|
6923
|
-
id: RecordID;
|
6924
|
-
columns?: ColumnsProjection;
|
6925
|
-
}): Promise<XataRecord$1>;
|
6926
|
-
insertRecordWithID({ workspace, region, database, branch, table, id, record, columns, createOnly, ifVersion }: {
|
6927
|
-
workspace: WorkspaceID;
|
6928
|
-
region: string;
|
6929
|
-
database: DBName;
|
6930
|
-
branch: BranchName;
|
6931
|
-
table: TableName;
|
6932
|
-
id: RecordID;
|
6933
|
-
record: Record<string, any>;
|
6934
|
-
columns?: ColumnsProjection;
|
6935
|
-
createOnly?: boolean;
|
6936
|
-
ifVersion?: number;
|
6937
|
-
}): Promise<RecordUpdateResponse>;
|
6938
|
-
updateRecordWithID({ workspace, region, database, branch, table, id, record, columns, ifVersion }: {
|
6939
|
-
workspace: WorkspaceID;
|
6940
|
-
region: string;
|
6941
|
-
database: DBName;
|
6942
|
-
branch: BranchName;
|
6943
|
-
table: TableName;
|
6944
|
-
id: RecordID;
|
6945
|
-
record: Record<string, any>;
|
6946
|
-
columns?: ColumnsProjection;
|
6947
|
-
ifVersion?: number;
|
6948
|
-
}): Promise<RecordUpdateResponse>;
|
6949
|
-
upsertRecordWithID({ workspace, region, database, branch, table, id, record, columns, ifVersion }: {
|
6950
|
-
workspace: WorkspaceID;
|
6951
|
-
region: string;
|
6952
|
-
database: DBName;
|
6953
|
-
branch: BranchName;
|
6954
|
-
table: TableName;
|
6955
|
-
id: RecordID;
|
6956
|
-
record: Record<string, any>;
|
6957
|
-
columns?: ColumnsProjection;
|
6958
|
-
ifVersion?: number;
|
6959
|
-
}): Promise<RecordUpdateResponse>;
|
6960
|
-
deleteRecord({ workspace, region, database, branch, table, id, columns }: {
|
6961
|
-
workspace: WorkspaceID;
|
6962
|
-
region: string;
|
6963
|
-
database: DBName;
|
6964
|
-
branch: BranchName;
|
6965
|
-
table: TableName;
|
6966
|
-
id: RecordID;
|
6967
|
-
columns?: ColumnsProjection;
|
6968
|
-
}): Promise<RecordUpdateResponse>;
|
6969
|
-
bulkInsertTableRecords({ workspace, region, database, branch, table, records, columns }: {
|
6970
|
-
workspace: WorkspaceID;
|
6971
|
-
region: string;
|
6972
|
-
database: DBName;
|
6973
|
-
branch: BranchName;
|
6974
|
-
table: TableName;
|
6975
|
-
records: Record<string, any>[];
|
6976
|
-
columns?: ColumnsProjection;
|
6977
|
-
}): Promise<BulkInsertResponse>;
|
6978
|
-
branchTransaction({ workspace, region, database, branch, operations }: {
|
6979
|
-
workspace: WorkspaceID;
|
6980
|
-
region: string;
|
6981
|
-
database: DBName;
|
6982
|
-
branch: BranchName;
|
6983
|
-
operations: TransactionOperation$1[];
|
6984
|
-
}): Promise<TransactionSuccess>;
|
6985
|
-
}
|
6986
|
-
declare class FilesApi {
|
6987
|
-
private extraProps;
|
6988
|
-
constructor(extraProps: ApiExtraProps);
|
6989
|
-
getFileItem({ workspace, region, database, branch, table, record, column, fileId }: {
|
6990
|
-
workspace: WorkspaceID;
|
6991
|
-
region: string;
|
6992
|
-
database: DBName;
|
6993
|
-
branch: BranchName;
|
6994
|
-
table: TableName;
|
6995
|
-
record: RecordID;
|
6996
|
-
column: ColumnName;
|
6997
|
-
fileId: string;
|
6998
|
-
}): Promise<any>;
|
6999
|
-
putFileItem({ workspace, region, database, branch, table, record, column, fileId, file }: {
|
7000
|
-
workspace: WorkspaceID;
|
7001
|
-
region: string;
|
7002
|
-
database: DBName;
|
7003
|
-
branch: BranchName;
|
7004
|
-
table: TableName;
|
7005
|
-
record: RecordID;
|
7006
|
-
column: ColumnName;
|
7007
|
-
fileId: string;
|
7008
|
-
file: any;
|
7009
|
-
}): Promise<PutFileResponse>;
|
7010
|
-
deleteFileItem({ workspace, region, database, branch, table, record, column, fileId }: {
|
7011
|
-
workspace: WorkspaceID;
|
7012
|
-
region: string;
|
7013
|
-
database: DBName;
|
7014
|
-
branch: BranchName;
|
7015
|
-
table: TableName;
|
7016
|
-
record: RecordID;
|
7017
|
-
column: ColumnName;
|
7018
|
-
fileId: string;
|
7019
|
-
}): Promise<PutFileResponse>;
|
7020
|
-
getFile({ workspace, region, database, branch, table, record, column }: {
|
7021
|
-
workspace: WorkspaceID;
|
7022
|
-
region: string;
|
7023
|
-
database: DBName;
|
7024
|
-
branch: BranchName;
|
7025
|
-
table: TableName;
|
7026
|
-
record: RecordID;
|
7027
|
-
column: ColumnName;
|
7028
|
-
}): Promise<any>;
|
7029
|
-
putFile({ workspace, region, database, branch, table, record, column, file }: {
|
7030
|
-
workspace: WorkspaceID;
|
7031
|
-
region: string;
|
7032
|
-
database: DBName;
|
7033
|
-
branch: BranchName;
|
7034
|
-
table: TableName;
|
7035
|
-
record: RecordID;
|
7036
|
-
column: ColumnName;
|
7037
|
-
file: Blob;
|
7038
|
-
}): Promise<PutFileResponse>;
|
7039
|
-
deleteFile({ workspace, region, database, branch, table, record, column }: {
|
7040
|
-
workspace: WorkspaceID;
|
7041
|
-
region: string;
|
7042
|
-
database: DBName;
|
7043
|
-
branch: BranchName;
|
7044
|
-
table: TableName;
|
7045
|
-
record: RecordID;
|
7046
|
-
column: ColumnName;
|
7047
|
-
}): Promise<PutFileResponse>;
|
7048
|
-
fileAccess({ workspace, region, fileId, verify }: {
|
7049
|
-
workspace: WorkspaceID;
|
7050
|
-
region: string;
|
7051
|
-
fileId: string;
|
7052
|
-
verify?: FileSignature;
|
7053
|
-
}): Promise<any>;
|
7054
|
-
}
|
7055
|
-
declare class SearchAndFilterApi {
|
7056
|
-
private extraProps;
|
7057
|
-
constructor(extraProps: ApiExtraProps);
|
7058
|
-
queryTable({ workspace, region, database, branch, table, filter, sort, page, columns, consistency }: {
|
7059
|
-
workspace: WorkspaceID;
|
7060
|
-
region: string;
|
7061
|
-
database: DBName;
|
7062
|
-
branch: BranchName;
|
7063
|
-
table: TableName;
|
7064
|
-
filter?: FilterExpression;
|
7065
|
-
sort?: SortExpression;
|
7066
|
-
page?: PageConfig;
|
7067
|
-
columns?: ColumnsProjection;
|
7068
|
-
consistency?: 'strong' | 'eventual';
|
7069
|
-
}): Promise<QueryResponse>;
|
7070
|
-
searchTable({ workspace, region, database, branch, table, query, fuzziness, target, prefix, filter, highlight, boosters }: {
|
7071
|
-
workspace: WorkspaceID;
|
7072
|
-
region: string;
|
7073
|
-
database: DBName;
|
7074
|
-
branch: BranchName;
|
7075
|
-
table: TableName;
|
7076
|
-
query: string;
|
7077
|
-
fuzziness?: FuzzinessExpression;
|
7078
|
-
target?: TargetExpression;
|
7079
|
-
prefix?: PrefixExpression;
|
7080
|
-
filter?: FilterExpression;
|
7081
|
-
highlight?: HighlightExpression;
|
7082
|
-
boosters?: BoosterExpression[];
|
7083
|
-
}): Promise<SearchResponse>;
|
7084
|
-
searchBranch({ workspace, region, database, branch, tables, query, fuzziness, prefix, highlight }: {
|
7085
|
-
workspace: WorkspaceID;
|
7086
|
-
region: string;
|
7087
|
-
database: DBName;
|
7088
|
-
branch: BranchName;
|
7089
|
-
tables?: (string | {
|
7090
|
-
table: string;
|
7091
|
-
filter?: FilterExpression;
|
7092
|
-
target?: TargetExpression;
|
7093
|
-
boosters?: BoosterExpression[];
|
7094
|
-
})[];
|
7095
|
-
query: string;
|
7096
|
-
fuzziness?: FuzzinessExpression;
|
7097
|
-
prefix?: PrefixExpression;
|
7098
|
-
highlight?: HighlightExpression;
|
7099
|
-
}): Promise<SearchResponse>;
|
7100
|
-
vectorSearchTable({ workspace, region, database, branch, table, queryVector, column, similarityFunction, size, filter }: {
|
7101
|
-
workspace: WorkspaceID;
|
7102
|
-
region: string;
|
7103
|
-
database: DBName;
|
7104
|
-
branch: BranchName;
|
7105
|
-
table: TableName;
|
7106
|
-
queryVector: number[];
|
7107
|
-
column: string;
|
7108
|
-
similarityFunction?: string;
|
7109
|
-
size?: number;
|
7110
|
-
filter?: FilterExpression;
|
7111
|
-
}): Promise<SearchResponse>;
|
7112
|
-
askTable({ workspace, region, database, branch, table, options }: {
|
7113
|
-
workspace: WorkspaceID;
|
7114
|
-
region: string;
|
7115
|
-
database: DBName;
|
7116
|
-
branch: BranchName;
|
7117
|
-
table: TableName;
|
7118
|
-
options: AskTableRequestBody;
|
7119
|
-
}): Promise<AskTableResponse>;
|
7120
|
-
askTableSession({ workspace, region, database, branch, table, sessionId, message }: {
|
7121
|
-
workspace: WorkspaceID;
|
7122
|
-
region: string;
|
7123
|
-
database: DBName;
|
7124
|
-
branch: BranchName;
|
7125
|
-
table: TableName;
|
7126
|
-
sessionId: string;
|
7127
|
-
message: string;
|
7128
|
-
}): Promise<AskTableSessionResponse>;
|
7129
|
-
summarizeTable({ workspace, region, database, branch, table, filter, columns, summaries, sort, summariesFilter, page, consistency }: {
|
7130
|
-
workspace: WorkspaceID;
|
7131
|
-
region: string;
|
7132
|
-
database: DBName;
|
7133
|
-
branch: BranchName;
|
7134
|
-
table: TableName;
|
7135
|
-
filter?: FilterExpression;
|
7136
|
-
columns?: ColumnsProjection;
|
7137
|
-
summaries?: SummaryExpressionList;
|
7138
|
-
sort?: SortExpression;
|
7139
|
-
summariesFilter?: FilterExpression;
|
7140
|
-
page?: {
|
7141
|
-
size?: number;
|
7142
|
-
};
|
7143
|
-
consistency?: 'strong' | 'eventual';
|
7144
|
-
}): Promise<SummarizeResponse>;
|
7145
|
-
aggregateTable({ workspace, region, database, branch, table, filter, aggs }: {
|
7146
|
-
workspace: WorkspaceID;
|
7147
|
-
region: string;
|
7148
|
-
database: DBName;
|
7149
|
-
branch: BranchName;
|
7150
|
-
table: TableName;
|
7151
|
-
filter?: FilterExpression;
|
7152
|
-
aggs?: AggExpressionMap;
|
7153
|
-
}): Promise<AggResponse>;
|
7154
|
-
}
|
7155
|
-
declare class MigrationRequestsApi {
|
7156
|
-
private extraProps;
|
7157
|
-
constructor(extraProps: ApiExtraProps);
|
7158
|
-
queryMigrationRequests({ workspace, region, database, filter, sort, page, columns }: {
|
7159
|
-
workspace: WorkspaceID;
|
7160
|
-
region: string;
|
7161
|
-
database: DBName;
|
7162
|
-
filter?: FilterExpression;
|
7163
|
-
sort?: SortExpression;
|
7164
|
-
page?: PageConfig;
|
7165
|
-
columns?: ColumnsProjection;
|
7166
|
-
}): Promise<QueryMigrationRequestsResponse>;
|
7167
|
-
createMigrationRequest({ workspace, region, database, migration }: {
|
7168
|
-
workspace: WorkspaceID;
|
7169
|
-
region: string;
|
7170
|
-
database: DBName;
|
7171
|
-
migration: CreateMigrationRequestRequestBody;
|
7172
|
-
}): Promise<CreateMigrationRequestResponse>;
|
7173
|
-
getMigrationRequest({ workspace, region, database, migrationRequest }: {
|
7174
|
-
workspace: WorkspaceID;
|
7175
|
-
region: string;
|
7176
|
-
database: DBName;
|
7177
|
-
migrationRequest: MigrationRequestNumber;
|
7178
|
-
}): Promise<MigrationRequest>;
|
7179
|
-
updateMigrationRequest({ workspace, region, database, migrationRequest, update }: {
|
7180
|
-
workspace: WorkspaceID;
|
7181
|
-
region: string;
|
7182
|
-
database: DBName;
|
7183
|
-
migrationRequest: MigrationRequestNumber;
|
7184
|
-
update: UpdateMigrationRequestRequestBody;
|
7185
|
-
}): Promise<void>;
|
7186
|
-
listMigrationRequestsCommits({ workspace, region, database, migrationRequest, page }: {
|
7187
|
-
workspace: WorkspaceID;
|
7188
|
-
region: string;
|
7189
|
-
database: DBName;
|
7190
|
-
migrationRequest: MigrationRequestNumber;
|
7191
|
-
page?: {
|
7192
|
-
after?: string;
|
7193
|
-
before?: string;
|
7194
|
-
size?: number;
|
7195
|
-
};
|
7196
|
-
}): Promise<ListMigrationRequestsCommitsResponse>;
|
7197
|
-
compareMigrationRequest({ workspace, region, database, migrationRequest }: {
|
7198
|
-
workspace: WorkspaceID;
|
7199
|
-
region: string;
|
7200
|
-
database: DBName;
|
7201
|
-
migrationRequest: MigrationRequestNumber;
|
7202
|
-
}): Promise<SchemaCompareResponse>;
|
7203
|
-
getMigrationRequestIsMerged({ workspace, region, database, migrationRequest }: {
|
7204
|
-
workspace: WorkspaceID;
|
7205
|
-
region: string;
|
7206
|
-
database: DBName;
|
7207
|
-
migrationRequest: MigrationRequestNumber;
|
7208
|
-
}): Promise<GetMigrationRequestIsMergedResponse>;
|
7209
|
-
mergeMigrationRequest({ workspace, region, database, migrationRequest }: {
|
7210
|
-
workspace: WorkspaceID;
|
7211
|
-
region: string;
|
7212
|
-
database: DBName;
|
7213
|
-
migrationRequest: MigrationRequestNumber;
|
7214
|
-
}): Promise<BranchOp>;
|
7215
|
-
}
|
7216
|
-
declare class MigrationsApi {
|
7217
|
-
private extraProps;
|
7218
|
-
constructor(extraProps: ApiExtraProps);
|
7219
|
-
getBranchMigrationHistory({ workspace, region, database, branch, limit, startFrom }: {
|
7220
|
-
workspace: WorkspaceID;
|
7221
|
-
region: string;
|
7222
|
-
database: DBName;
|
7223
|
-
branch: BranchName;
|
7224
|
-
limit?: number;
|
7225
|
-
startFrom?: string;
|
7226
|
-
}): Promise<GetBranchMigrationHistoryResponse>;
|
7227
|
-
getBranchMigrationPlan({ workspace, region, database, branch, schema }: {
|
7228
|
-
workspace: WorkspaceID;
|
7229
|
-
region: string;
|
7230
|
-
database: DBName;
|
7231
|
-
branch: BranchName;
|
7232
|
-
schema: Schema;
|
7233
|
-
}): Promise<BranchMigrationPlan>;
|
7234
|
-
executeBranchMigrationPlan({ workspace, region, database, branch, plan }: {
|
7235
|
-
workspace: WorkspaceID;
|
7236
|
-
region: string;
|
7237
|
-
database: DBName;
|
7238
|
-
branch: BranchName;
|
7239
|
-
plan: ExecuteBranchMigrationPlanRequestBody;
|
7240
|
-
}): Promise<SchemaUpdateResponse>;
|
7241
|
-
getBranchSchemaHistory({ workspace, region, database, branch, page }: {
|
7242
|
-
workspace: WorkspaceID;
|
7243
|
-
region: string;
|
7244
|
-
database: DBName;
|
7245
|
-
branch: BranchName;
|
7246
|
-
page?: {
|
7247
|
-
after?: string;
|
7248
|
-
before?: string;
|
7249
|
-
size?: number;
|
7250
|
-
};
|
7251
|
-
}): Promise<GetBranchSchemaHistoryResponse>;
|
7252
|
-
compareBranchWithUserSchema({ workspace, region, database, branch, schema, schemaOperations, branchOperations }: {
|
7253
|
-
workspace: WorkspaceID;
|
7254
|
-
region: string;
|
7255
|
-
database: DBName;
|
7256
|
-
branch: BranchName;
|
7257
|
-
schema: Schema;
|
7258
|
-
schemaOperations?: MigrationOp[];
|
7259
|
-
branchOperations?: MigrationOp[];
|
7260
|
-
}): Promise<SchemaCompareResponse>;
|
7261
|
-
compareBranchSchemas({ workspace, region, database, branch, compare, sourceBranchOperations, targetBranchOperations }: {
|
7262
|
-
workspace: WorkspaceID;
|
7263
|
-
region: string;
|
7264
|
-
database: DBName;
|
7265
|
-
branch: BranchName;
|
7266
|
-
compare: BranchName;
|
7267
|
-
sourceBranchOperations?: MigrationOp[];
|
7268
|
-
targetBranchOperations?: MigrationOp[];
|
7269
|
-
}): Promise<SchemaCompareResponse>;
|
7270
|
-
updateBranchSchema({ workspace, region, database, branch, migration }: {
|
7271
|
-
workspace: WorkspaceID;
|
7272
|
-
region: string;
|
7273
|
-
database: DBName;
|
7274
|
-
branch: BranchName;
|
7275
|
-
migration: Migration;
|
7276
|
-
}): Promise<SchemaUpdateResponse>;
|
7277
|
-
previewBranchSchemaEdit({ workspace, region, database, branch, data }: {
|
7278
|
-
workspace: WorkspaceID;
|
7279
|
-
region: string;
|
7280
|
-
database: DBName;
|
7281
|
-
branch: BranchName;
|
7282
|
-
data: {
|
7283
|
-
edits?: SchemaEditScript;
|
7284
|
-
};
|
7285
|
-
}): Promise<PreviewBranchSchemaEditResponse>;
|
7286
|
-
applyBranchSchemaEdit({ workspace, region, database, branch, edits }: {
|
7287
|
-
workspace: WorkspaceID;
|
7288
|
-
region: string;
|
7289
|
-
database: DBName;
|
7290
|
-
branch: BranchName;
|
7291
|
-
edits: SchemaEditScript;
|
7292
|
-
}): Promise<SchemaUpdateResponse>;
|
7293
|
-
pushBranchMigrations({ workspace, region, database, branch, migrations }: {
|
7294
|
-
workspace: WorkspaceID;
|
7295
|
-
region: string;
|
7296
|
-
database: DBName;
|
7297
|
-
branch: BranchName;
|
7298
|
-
migrations: MigrationObject[];
|
7299
|
-
}): Promise<SchemaUpdateResponse>;
|
7300
|
-
}
|
7301
|
-
declare class DatabaseApi {
|
7302
|
-
private extraProps;
|
7303
|
-
constructor(extraProps: ApiExtraProps);
|
7304
|
-
getDatabaseList({ workspace }: {
|
7305
|
-
workspace: WorkspaceID;
|
7306
|
-
}): Promise<ListDatabasesResponse>;
|
7307
|
-
createDatabase({ workspace, database, data, headers }: {
|
7308
|
-
workspace: WorkspaceID;
|
7309
|
-
database: DBName;
|
7310
|
-
data: CreateDatabaseRequestBody;
|
7311
|
-
headers?: Record<string, string>;
|
7312
|
-
}): Promise<CreateDatabaseResponse>;
|
7313
|
-
deleteDatabase({ workspace, database }: {
|
7314
|
-
workspace: WorkspaceID;
|
7315
|
-
database: DBName;
|
7316
|
-
}): Promise<DeleteDatabaseResponse>;
|
7317
|
-
getDatabaseMetadata({ workspace, database }: {
|
7318
|
-
workspace: WorkspaceID;
|
7319
|
-
database: DBName;
|
7320
|
-
}): Promise<DatabaseMetadata>;
|
7321
|
-
updateDatabaseMetadata({ workspace, database, metadata }: {
|
7322
|
-
workspace: WorkspaceID;
|
7323
|
-
database: DBName;
|
7324
|
-
metadata: DatabaseMetadata;
|
7325
|
-
}): Promise<DatabaseMetadata>;
|
7326
|
-
renameDatabase({ workspace, database, newName }: {
|
7327
|
-
workspace: WorkspaceID;
|
7328
|
-
database: DBName;
|
7329
|
-
newName: DBName;
|
7330
|
-
}): Promise<DatabaseMetadata>;
|
7331
|
-
getDatabaseGithubSettings({ workspace, database }: {
|
7332
|
-
workspace: WorkspaceID;
|
7333
|
-
database: DBName;
|
7334
|
-
}): Promise<DatabaseGithubSettings>;
|
7335
|
-
updateDatabaseGithubSettings({ workspace, database, settings }: {
|
7336
|
-
workspace: WorkspaceID;
|
7337
|
-
database: DBName;
|
7338
|
-
settings: DatabaseGithubSettings;
|
7339
|
-
}): Promise<DatabaseGithubSettings>;
|
7340
|
-
deleteDatabaseGithubSettings({ workspace, database }: {
|
7341
|
-
workspace: WorkspaceID;
|
7342
|
-
database: DBName;
|
7343
|
-
}): Promise<void>;
|
7344
|
-
listRegions({ workspace }: {
|
7345
|
-
workspace: WorkspaceID;
|
7346
|
-
}): Promise<ListRegionsResponse>;
|
6808
|
+
export type { schemas_APIKeyName as APIKeyName, schemas_AccessToken as AccessToken, schemas_AggExpression as AggExpression, schemas_AggExpressionMap as AggExpressionMap, AggResponse$1 as AggResponse, schemas_AuthorizationCodeRequest as AuthorizationCodeRequest, schemas_AuthorizationCodeResponse as AuthorizationCodeResponse, schemas_AutoscalingConfig as AutoscalingConfig, schemas_AverageAgg as AverageAgg, schemas_BoosterExpression as BoosterExpression, schemas_Branch as Branch, schemas_BranchMetadata as BranchMetadata, schemas_BranchMigration as BranchMigration, schemas_BranchName as BranchName, schemas_BranchOp as BranchOp, schemas_BranchWithCopyID as BranchWithCopyID, schemas_ClusterConfiguration as ClusterConfiguration, schemas_ClusterCreateDetails as ClusterCreateDetails, schemas_ClusterID as ClusterID, schemas_ClusterMetadata as ClusterMetadata, schemas_ClusterResponse as ClusterResponse, schemas_ClusterShortMetadata as ClusterShortMetadata, schemas_ClusterUpdateDetails as ClusterUpdateDetails, schemas_Column as Column, schemas_ColumnFile as ColumnFile, schemas_ColumnLink as ColumnLink, schemas_ColumnMigration as ColumnMigration, schemas_ColumnName as ColumnName, schemas_ColumnOpAdd as ColumnOpAdd, schemas_ColumnOpRemove as ColumnOpRemove, schemas_ColumnOpRename as ColumnOpRename, schemas_ColumnVector as ColumnVector, schemas_ColumnsProjection as ColumnsProjection, schemas_Commit as Commit, schemas_CountAgg as CountAgg, schemas_DBBranch as DBBranch, schemas_DBBranchName as DBBranchName, schemas_DBName as DBName, schemas_DailyTimeWindow as DailyTimeWindow, schemas_DataInputRecord as DataInputRecord, schemas_DatabaseGithubSettings as DatabaseGithubSettings, schemas_DatabaseMetadata as DatabaseMetadata, DateBooster$1 as DateBooster, schemas_DateHistogramAgg as DateHistogramAgg, schemas_DateTime as DateTime, schemas_FileAccessID as FileAccessID, schemas_FileItemID as FileItemID, schemas_FileName as FileName, schemas_FileResponse as FileResponse, schemas_FileSignature as FileSignature, schemas_FilterColumn as FilterColumn, schemas_FilterColumnIncludes as FilterColumnIncludes, schemas_FilterExpression as FilterExpression, schemas_FilterList as FilterList, schemas_FilterPredicate as FilterPredicate, schemas_FilterPredicateOp as FilterPredicateOp, schemas_FilterPredicateRangeOp as FilterPredicateRangeOp, schemas_FilterRangeValue as FilterRangeValue, schemas_FilterValue as FilterValue, schemas_FuzzinessExpression as FuzzinessExpression, schemas_HighlightExpression as HighlightExpression, schemas_InputFile as InputFile, schemas_InputFileArray as InputFileArray, schemas_InputFileEntry as InputFileEntry, schemas_InviteID as InviteID, schemas_InviteKey as InviteKey, schemas_ListBranchesResponse as ListBranchesResponse, schemas_ListClustersResponse as ListClustersResponse, schemas_ListDatabasesResponse as ListDatabasesResponse, schemas_ListGitBranchesResponse as ListGitBranchesResponse, schemas_ListRegionsResponse as ListRegionsResponse, schemas_MaintenanceConfig as MaintenanceConfig, schemas_MaxAgg as MaxAgg, schemas_MediaType as MediaType, schemas_MetricsDatapoint as MetricsDatapoint, schemas_MetricsLatency as MetricsLatency, schemas_Migration as Migration, schemas_MigrationColumnOp as MigrationColumnOp, schemas_MigrationObject as MigrationObject, schemas_MigrationOp as MigrationOp, schemas_MigrationRequest as MigrationRequest, schemas_MigrationRequestNumber as MigrationRequestNumber, schemas_MigrationStatus as MigrationStatus, schemas_MigrationTableOp as MigrationTableOp, schemas_MinAgg as MinAgg, NumericBooster$1 as NumericBooster, schemas_NumericHistogramAgg as NumericHistogramAgg, schemas_OAuthAccessToken as OAuthAccessToken, schemas_OAuthClientID as OAuthClientID, schemas_OAuthClientPublicDetails as OAuthClientPublicDetails, schemas_OAuthResponseType as OAuthResponseType, schemas_OAuthScope as OAuthScope, schemas_ObjectValue as ObjectValue, schemas_PageConfig as PageConfig, schemas_PercentilesAgg as PercentilesAgg, schemas_PgRollApplyMigrationResponse as PgRollApplyMigrationResponse, schemas_PgRollJobStatus as PgRollJobStatus, schemas_PgRollJobStatusResponse as PgRollJobStatusResponse, schemas_PgRollJobType as PgRollJobType, schemas_PgRollMigrationJobID as PgRollMigrationJobID, schemas_PrefixExpression as PrefixExpression, schemas_ProjectionConfig as ProjectionConfig, schemas_QueryColumnsProjection as QueryColumnsProjection, schemas_RecordID as RecordID, schemas_RecordMeta as RecordMeta, schemas_RecordsMetadata as RecordsMetadata, schemas_Region as Region, schemas_RevLink as RevLink, schemas_Role as Role, schemas_SQLRecord as SQLRecord, schemas_Schema as Schema, schemas_SchemaEditScript as SchemaEditScript, schemas_SearchPageConfig as SearchPageConfig, schemas_SortExpression as SortExpression, schemas_SortOrder as SortOrder, schemas_StartedFromMetadata as StartedFromMetadata, schemas_SumAgg as SumAgg, schemas_SummaryExpression as SummaryExpression, schemas_SummaryExpressionList as SummaryExpressionList, schemas_Table as Table, schemas_TableMigration as TableMigration, schemas_TableName as TableName, schemas_TableOpAdd as TableOpAdd, schemas_TableOpRemove as TableOpRemove, schemas_TableOpRename as TableOpRename, schemas_TableRename as TableRename, schemas_TargetExpression as TargetExpression, schemas_TopValuesAgg as TopValuesAgg, schemas_TransactionDeleteOp as TransactionDeleteOp, schemas_TransactionError as TransactionError, schemas_TransactionFailure as TransactionFailure, schemas_TransactionGetOp as TransactionGetOp, schemas_TransactionInsertOp as TransactionInsertOp, TransactionOperation$1 as TransactionOperation, schemas_TransactionResultColumns as TransactionResultColumns, schemas_TransactionResultDelete as TransactionResultDelete, schemas_TransactionResultGet as TransactionResultGet, schemas_TransactionResultInsert as TransactionResultInsert, schemas_TransactionResultUpdate as TransactionResultUpdate, schemas_TransactionSuccess as TransactionSuccess, schemas_TransactionUpdateOp as TransactionUpdateOp, schemas_UniqueCountAgg as UniqueCountAgg, schemas_User as User, schemas_UserID as UserID, schemas_UserWithID as UserWithID, ValueBooster$1 as ValueBooster, schemas_WeeklyTimeWindow as WeeklyTimeWindow, schemas_Workspace as Workspace, schemas_WorkspaceID as WorkspaceID, schemas_WorkspaceInvite as WorkspaceInvite, schemas_WorkspaceMember as WorkspaceMember, schemas_WorkspaceMembers as WorkspaceMembers, schemas_WorkspaceMeta as WorkspaceMeta, schemas_WorkspacePlan as WorkspacePlan, XataRecord$1 as XataRecord };
|
7347
6809
|
}
|
7348
6810
|
|
7349
6811
|
declare class XataApiPlugin implements XataPlugin {
|
7350
6812
|
build(options: XataPluginOptions): XataApiClient;
|
7351
6813
|
}
|
7352
6814
|
|
7353
|
-
type StringKeys<O> = Extract<keyof O, string>;
|
7354
|
-
type Values<O> = O[StringKeys<O>];
|
7355
|
-
type UnionToIntersection<T> = (T extends any ? (x: T) => any : never) extends (x: infer R) => any ? R : never;
|
7356
|
-
type If<Condition, Then, Else> = Condition extends true ? Then : Else;
|
7357
|
-
type IsObject<T> = T extends Record<string, any> ? true : false;
|
7358
|
-
type IsArray<T> = T extends Array<any> ? true : false;
|
7359
|
-
type RequiredBy<T, K extends keyof T> = T & {
|
7360
|
-
[P in K]-?: NonNullable<T[P]>;
|
7361
|
-
};
|
7362
|
-
type GetArrayInnerType<T extends readonly any[]> = T[number];
|
7363
|
-
type SingleOrArray<T> = T | T[];
|
7364
|
-
type Dictionary<T> = Record<string, T>;
|
7365
|
-
type OmitBy<T, K extends keyof T> = T extends any ? Omit<T, K> : never;
|
7366
|
-
type Without<T, U> = {
|
7367
|
-
[P in Exclude<keyof T, keyof U>]?: never;
|
7368
|
-
};
|
7369
|
-
type ExclusiveOr<T, U> = T | U extends object ? (Without<T, U> & U) | (Without<U, T> & T) : T | U;
|
7370
|
-
type Explode<T> = keyof T extends infer K ? K extends unknown ? {
|
7371
|
-
[I in keyof T]: I extends K ? T[I] : never;
|
7372
|
-
} : never : never;
|
7373
|
-
type AtMostOne<T> = Explode<Partial<T>>;
|
7374
|
-
type AtLeastOne<T, U = {
|
7375
|
-
[K in keyof T]: Pick<T, K>;
|
7376
|
-
}> = Partial<T> & U[keyof U];
|
7377
|
-
type ExactlyOne<T> = AtMostOne<T> & AtLeastOne<T>;
|
7378
|
-
type Fn = (...args: any[]) => any;
|
7379
|
-
type NarrowRaw<A> = (A extends [] ? [] : never) | (A extends Narrowable ? A : never) | {
|
7380
|
-
[K in keyof A]: A[K] extends Fn ? A[K] : NarrowRaw<A[K]>;
|
7381
|
-
};
|
7382
|
-
type Narrowable = string | number | bigint | boolean;
|
7383
|
-
type Try<A1, A2, Catch = never> = A1 extends A2 ? A1 : Catch;
|
7384
|
-
type Narrow<A> = Try<A, [], NarrowRaw<A>>;
|
7385
|
-
|
7386
6815
|
interface ImageTransformations {
|
7387
6816
|
/**
|
7388
6817
|
* Whether to preserve animation frames from input files. Default is true.
|
@@ -7560,11 +6989,11 @@ declare class XataFile {
|
|
7560
6989
|
/**
|
7561
6990
|
* Name of the file.
|
7562
6991
|
*/
|
7563
|
-
name
|
6992
|
+
name?: string;
|
7564
6993
|
/**
|
7565
6994
|
* Media type of the file.
|
7566
6995
|
*/
|
7567
|
-
mediaType
|
6996
|
+
mediaType?: string;
|
7568
6997
|
/**
|
7569
6998
|
* Base64 encoded content of the file.
|
7570
6999
|
*/
|
@@ -7572,11 +7001,11 @@ declare class XataFile {
|
|
7572
7001
|
/**
|
7573
7002
|
* Whether to enable public url for the file.
|
7574
7003
|
*/
|
7575
|
-
enablePublicUrl
|
7004
|
+
enablePublicUrl?: boolean;
|
7576
7005
|
/**
|
7577
7006
|
* Timeout for the signed url.
|
7578
7007
|
*/
|
7579
|
-
signedUrlTimeout
|
7008
|
+
signedUrlTimeout?: number;
|
7580
7009
|
/**
|
7581
7010
|
* Size of the file.
|
7582
7011
|
*/
|
@@ -7584,11 +7013,11 @@ declare class XataFile {
|
|
7584
7013
|
/**
|
7585
7014
|
* Version of the file.
|
7586
7015
|
*/
|
7587
|
-
version
|
7016
|
+
version?: number;
|
7588
7017
|
/**
|
7589
7018
|
* Url of the file.
|
7590
7019
|
*/
|
7591
|
-
url
|
7020
|
+
url?: string;
|
7592
7021
|
/**
|
7593
7022
|
* Signed url of the file.
|
7594
7023
|
*/
|
@@ -7596,7 +7025,7 @@ declare class XataFile {
|
|
7596
7025
|
/**
|
7597
7026
|
* Attributes of the file.
|
7598
7027
|
*/
|
7599
|
-
attributes
|
7028
|
+
attributes?: Record<string, any>;
|
7600
7029
|
constructor(file: Partial<XataFile>);
|
7601
7030
|
static fromBuffer(buffer: Buffer, options?: XataFileEditableFields): XataFile;
|
7602
7031
|
toBuffer(): Buffer;
|
@@ -7611,9 +7040,9 @@ declare class XataFile {
|
|
7611
7040
|
static fromBase64(base64Content: string, options?: XataFileEditableFields): XataFile;
|
7612
7041
|
toBase64(): string;
|
7613
7042
|
transform(...options: ImageTransformations[]): {
|
7614
|
-
url: string;
|
7043
|
+
url: string | undefined;
|
7615
7044
|
signedUrl: string | undefined;
|
7616
|
-
metadataUrl: string;
|
7045
|
+
metadataUrl: string | undefined;
|
7617
7046
|
metadataSignedUrl: string | undefined;
|
7618
7047
|
};
|
7619
7048
|
}
|
@@ -8809,13 +8238,13 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
8809
8238
|
* @param columns Array of columns to be returned. If not specified, first level columns will be returned.
|
8810
8239
|
* @returns The persisted records for the given ids in order (if a record could not be found null is returned).
|
8811
8240
|
*/
|
8812
|
-
abstract read<K extends SelectableColumn<Record>>(ids: Identifier
|
8241
|
+
abstract read<K extends SelectableColumn<Record>>(ids: ReadonlyArray<Identifier>, columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
|
8813
8242
|
/**
|
8814
8243
|
* Queries multiple records from the table given their unique id.
|
8815
8244
|
* @param ids The unique ids array.
|
8816
8245
|
* @returns The persisted records for the given ids in order (if a record could not be found null is returned).
|
8817
8246
|
*/
|
8818
|
-
abstract read(ids: Identifier
|
8247
|
+
abstract read(ids: ReadonlyArray<Identifier>): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
|
8819
8248
|
/**
|
8820
8249
|
* Queries a single record from the table by the id in the object.
|
8821
8250
|
* @param object Object containing the id of the record.
|
@@ -8864,14 +8293,14 @@ declare abstract class Repository<Record extends XataRecord> extends Query<Recor
|
|
8864
8293
|
* @returns The persisted records for the given ids in order.
|
8865
8294
|
* @throws If one or more records could not be found.
|
8866
8295
|
*/
|
8867
|
-
abstract readOrThrow<K extends SelectableColumn<Record>>(ids: Identifier
|
8296
|
+
abstract readOrThrow<K extends SelectableColumn<Record>>(ids: ReadonlyArray<Identifier>, columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
8868
8297
|
/**
|
8869
8298
|
* Queries multiple records from the table given their unique id.
|
8870
8299
|
* @param ids The unique ids array.
|
8871
8300
|
* @returns The persisted records for the given ids in order.
|
8872
8301
|
* @throws If one or more records could not be found.
|
8873
8302
|
*/
|
8874
|
-
abstract readOrThrow(ids: Identifier
|
8303
|
+
abstract readOrThrow(ids: ReadonlyArray<Identifier>): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
8875
8304
|
/**
|
8876
8305
|
* Queries a single record from the table by the id in the object.
|
8877
8306
|
* @param object Object containing the id of the record.
|
@@ -9318,16 +8747,16 @@ declare class RestRepository<Record extends XataRecord> extends Query<Record, Se
|
|
9318
8747
|
create(objects: Array<EditableData<Record> & Partial<Identifiable>>): Promise<Readonly<SelectedPick<Record, ['*']>>[]>;
|
9319
8748
|
read<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns> | null>>;
|
9320
8749
|
read(id: string): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
|
9321
|
-
read<K extends SelectableColumn<Record>>(ids: Identifier
|
9322
|
-
read(ids: Identifier
|
8750
|
+
read<K extends SelectableColumn<Record>>(ids: ReadonlyArray<Identifier>, columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
|
8751
|
+
read(ids: ReadonlyArray<Identifier>): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
|
9323
8752
|
read<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns> | null>>;
|
9324
8753
|
read(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
|
9325
8754
|
read<K extends SelectableColumn<Record>>(objects: Identifiable[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>> | null>>;
|
9326
8755
|
read(objects: Identifiable[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>> | null>>;
|
9327
8756
|
readOrThrow<K extends SelectableColumn<Record>>(id: Identifier, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
9328
8757
|
readOrThrow(id: Identifier): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
9329
|
-
readOrThrow<K extends SelectableColumn<Record>>(ids: Identifier
|
9330
|
-
readOrThrow(ids: Identifier
|
8758
|
+
readOrThrow<K extends SelectableColumn<Record>>(ids: ReadonlyArray<Identifier>, columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
8759
|
+
readOrThrow(ids: ReadonlyArray<Identifier>): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
|
9331
8760
|
readOrThrow<K extends SelectableColumn<Record>>(object: Identifiable, columns: K[]): Promise<Readonly<SelectedPick<Record, typeof columns>>>;
|
9332
8761
|
readOrThrow(object: Identifiable): Promise<Readonly<SelectedPick<Record, ['*']>>>;
|
9333
8762
|
readOrThrow<K extends SelectableColumn<Record>>(objects: Identifiable[], columns: K[]): Promise<Array<Readonly<SelectedPick<Record, typeof columns>>>>;
|
@@ -9804,89 +9233,9 @@ declare function buildPreviewBranchName({ org, branch }: {
|
|
9804
9233
|
}): string;
|
9805
9234
|
declare function getPreviewBranch(): string | undefined;
|
9806
9235
|
|
9807
|
-
interface Body {
|
9808
|
-
arrayBuffer(): Promise<ArrayBuffer>;
|
9809
|
-
blob(): Promise<Blob$1>;
|
9810
|
-
formData(): Promise<FormData>;
|
9811
|
-
json(): Promise<any>;
|
9812
|
-
text(): Promise<string>;
|
9813
|
-
}
|
9814
|
-
interface Blob$1 {
|
9815
|
-
readonly size: number;
|
9816
|
-
readonly type: string;
|
9817
|
-
arrayBuffer(): Promise<ArrayBuffer>;
|
9818
|
-
slice(start?: number, end?: number, contentType?: string): Blob$1;
|
9819
|
-
text(): Promise<string>;
|
9820
|
-
}
|
9821
|
-
/** Provides information about files and allows JavaScript in a web page to access their content. */
|
9822
|
-
interface File extends Blob$1 {
|
9823
|
-
readonly lastModified: number;
|
9824
|
-
readonly name: string;
|
9825
|
-
readonly webkitRelativePath: string;
|
9826
|
-
}
|
9827
|
-
type FormDataEntryValue = File | string;
|
9828
|
-
/** Provides a way to easily construct a set of key/value pairs representing form fields and their values, which can then be easily sent using the XMLHttpRequest.send() method. It uses the same format a form would use if the encoding type were set to "multipart/form-data". */
|
9829
|
-
interface FormData {
|
9830
|
-
append(name: string, value: string | Blob$1, fileName?: string): void;
|
9831
|
-
delete(name: string): void;
|
9832
|
-
get(name: string): FormDataEntryValue | null;
|
9833
|
-
getAll(name: string): FormDataEntryValue[];
|
9834
|
-
has(name: string): boolean;
|
9835
|
-
set(name: string, value: string | Blob$1, fileName?: string): void;
|
9836
|
-
forEach(callbackfn: (value: FormDataEntryValue, key: string, parent: FormData) => void, thisArg?: any): void;
|
9837
|
-
}
|
9838
|
-
/** This Fetch API interface allows you to perform various actions on HTTP request and response headers. These actions include retrieving, setting, adding to, and removing. A Headers object has an associated header list, which is initially empty and consists of zero or more name and value pairs. You can add to this using methods like append() (see Examples.) In all methods of this interface, header names are matched by case-insensitive byte sequence. */
|
9839
|
-
interface Headers {
|
9840
|
-
append(name: string, value: string): void;
|
9841
|
-
delete(name: string): void;
|
9842
|
-
get(name: string): string | null;
|
9843
|
-
has(name: string): boolean;
|
9844
|
-
set(name: string, value: string): void;
|
9845
|
-
forEach(callbackfn: (value: string, key: string, parent: Headers) => void, thisArg?: any): void;
|
9846
|
-
}
|
9847
|
-
interface Request extends Body {
|
9848
|
-
/** Returns the cache mode associated with request, which is a string indicating how the request will interact with the browser's cache when fetching. */
|
9849
|
-
readonly cache: 'default' | 'force-cache' | 'no-cache' | 'no-store' | 'only-if-cached' | 'reload';
|
9850
|
-
/** Returns the credentials mode associated with request, which is a string indicating whether credentials will be sent with the request always, never, or only when sent to a same-origin URL. */
|
9851
|
-
readonly credentials: 'include' | 'omit' | 'same-origin';
|
9852
|
-
/** Returns the kind of resource requested by request, e.g., "document" or "script". */
|
9853
|
-
readonly destination: '' | 'audio' | 'audioworklet' | 'document' | 'embed' | 'font' | 'frame' | 'iframe' | 'image' | 'manifest' | 'object' | 'paintworklet' | 'report' | 'script' | 'sharedworker' | 'style' | 'track' | 'video' | 'worker' | 'xslt';
|
9854
|
-
/** Returns a Headers object consisting of the headers associated with request. Note that headers added in the network layer by the user agent will not be accounted for in this object, e.g., the "Host" header. */
|
9855
|
-
readonly headers: Headers;
|
9856
|
-
/** Returns request's subresource integrity metadata, which is a cryptographic hash of the resource being fetched. Its value consists of multiple hashes separated by whitespace. [SRI] */
|
9857
|
-
readonly integrity: string;
|
9858
|
-
/** Returns a boolean indicating whether or not request can outlive the global in which it was created. */
|
9859
|
-
readonly keepalive: boolean;
|
9860
|
-
/** Returns request's HTTP method, which is "GET" by default. */
|
9861
|
-
readonly method: string;
|
9862
|
-
/** Returns the mode associated with request, which is a string indicating whether the request will use CORS, or will be restricted to same-origin URLs. */
|
9863
|
-
readonly mode: 'cors' | 'navigate' | 'no-cors' | 'same-origin';
|
9864
|
-
/** Returns the redirect mode associated with request, which is a string indicating how redirects for the request will be handled during fetching. A request will follow redirects by default. */
|
9865
|
-
readonly redirect: 'error' | 'follow' | 'manual';
|
9866
|
-
/** Returns the referrer of request. Its value can be a same-origin URL if explicitly set in init, the empty string to indicate no referrer, and "about:client" when defaulting to the global's default. This is used during fetching to determine the value of the `Referer` header of the request being made. */
|
9867
|
-
readonly referrer: string;
|
9868
|
-
/** Returns the referrer policy associated with request. This is used during fetching to compute the value of the request's referrer. */
|
9869
|
-
readonly referrerPolicy: '' | 'no-referrer' | 'no-referrer-when-downgrade' | 'origin' | 'origin-when-cross-origin' | 'same-origin' | 'strict-origin' | 'strict-origin-when-cross-origin' | 'unsafe-url';
|
9870
|
-
/** Returns the URL of request as a string. */
|
9871
|
-
readonly url: string;
|
9872
|
-
clone(): Request;
|
9873
|
-
}
|
9874
|
-
|
9875
|
-
type XataWorkerContext<XataClient> = {
|
9876
|
-
xata: XataClient;
|
9877
|
-
request: Request;
|
9878
|
-
env: Record<string, string | undefined>;
|
9879
|
-
};
|
9880
|
-
type RemoveFirst<T> = T extends [any, ...infer U] ? U : never;
|
9881
|
-
type WorkerRunnerConfig = {
|
9882
|
-
workspace: string;
|
9883
|
-
worker: string;
|
9884
|
-
};
|
9885
|
-
declare function buildWorkerRunner<XataClient>(config: WorkerRunnerConfig): <WorkerFunction extends (ctx: XataWorkerContext<XataClient>, ...args: any[]) => any>(name: string, worker: WorkerFunction) => (...args: RemoveFirst<Parameters<WorkerFunction>>) => Promise<SerializerResult<Awaited<ReturnType<WorkerFunction>>>>;
|
9886
|
-
|
9887
9236
|
declare class XataError extends Error {
|
9888
9237
|
readonly status: number;
|
9889
9238
|
constructor(message: string, status: number);
|
9890
9239
|
}
|
9891
9240
|
|
9892
|
-
export { type AcceptWorkspaceMemberInviteError, type AcceptWorkspaceMemberInvitePathParams, type AcceptWorkspaceMemberInviteVariables, type AddGitBranchesEntryError, type AddGitBranchesEntryPathParams, type AddGitBranchesEntryRequestBody, type AddGitBranchesEntryResponse, type AddGitBranchesEntryVariables, type AddTableColumnError, type AddTableColumnPathParams, type AddTableColumnVariables, type AggregateTableError, type AggregateTablePathParams, type AggregateTableRequestBody, type AggregateTableVariables, type ApiExtraProps, type ApplyBranchSchemaEditError, type ApplyBranchSchemaEditPathParams, type ApplyBranchSchemaEditRequestBody, type ApplyBranchSchemaEditVariables, type ApplyMigrationError, type ApplyMigrationPathParams, type ApplyMigrationRequestBody, type ApplyMigrationVariables, type AskOptions, type AskResult, type AskTableError, type AskTablePathParams, type AskTableRequestBody, type AskTableResponse, type AskTableSessionError, type AskTableSessionPathParams, type AskTableSessionRequestBody, type AskTableSessionResponse, type AskTableSessionVariables, type AskTableVariables, BaseClient, type BaseClientOptions, type BaseData, type BaseSchema, type BinaryFile, type BranchTransactionError, type BranchTransactionPathParams, type BranchTransactionRequestBody, type BranchTransactionVariables, type BulkInsertTableRecordsError, type BulkInsertTableRecordsPathParams, type BulkInsertTableRecordsQueryParams, type BulkInsertTableRecordsRequestBody, type BulkInsertTableRecordsVariables, type CacheImpl, type CancelWorkspaceMemberInviteError, type CancelWorkspaceMemberInvitePathParams, type CancelWorkspaceMemberInviteVariables, type ClientConstructor, type ColumnsByValue, type CompareBranchSchemasError, type CompareBranchSchemasPathParams, type CompareBranchSchemasRequestBody, type CompareBranchSchemasVariables, type CompareBranchWithUserSchemaError, type CompareBranchWithUserSchemaPathParams, type CompareBranchWithUserSchemaRequestBody, type CompareBranchWithUserSchemaVariables, type CompareMigrationRequestError, type CompareMigrationRequestPathParams, type CompareMigrationRequestVariables, type CopyBranchError, type CopyBranchPathParams, type CopyBranchRequestBody, type CopyBranchVariables, type CreateBranchError, type CreateBranchPathParams, type CreateBranchQueryParams, type CreateBranchRequestBody, type CreateBranchResponse, type CreateBranchVariables, type CreateClusterError, type CreateClusterPathParams, type CreateClusterVariables, type CreateDatabaseError, type CreateDatabasePathParams, type CreateDatabaseRequestBody, type CreateDatabaseResponse, type CreateDatabaseVariables, type CreateMigrationRequestError, type CreateMigrationRequestPathParams, type CreateMigrationRequestRequestBody, type CreateMigrationRequestResponse, type CreateMigrationRequestVariables, type CreateTableError, type CreateTablePathParams, type CreateTableResponse, type CreateTableVariables, type CreateUserAPIKeyError, type CreateUserAPIKeyPathParams, type CreateUserAPIKeyResponse, type CreateUserAPIKeyVariables, type CreateWorkspaceError, type CreateWorkspaceVariables, type CursorNavigationOptions, type DeleteBranchError, type DeleteBranchPathParams, type DeleteBranchResponse, type DeleteBranchVariables, type DeleteColumnError, type DeleteColumnPathParams, type DeleteColumnVariables, type DeleteDatabaseError, type DeleteDatabaseGithubSettingsError, type DeleteDatabaseGithubSettingsPathParams, type DeleteDatabaseGithubSettingsVariables, type DeleteDatabasePathParams, type DeleteDatabaseResponse, type DeleteDatabaseVariables, type DeleteFileError, type DeleteFileItemError, type DeleteFileItemPathParams, type DeleteFileItemVariables, type DeleteFilePathParams, type DeleteFileVariables, type DeleteOAuthAccessTokenError, type DeleteOAuthAccessTokenPathParams, type DeleteOAuthAccessTokenVariables, type DeleteRecordError, type DeleteRecordPathParams, type DeleteRecordQueryParams, type DeleteRecordVariables, type DeleteTableError, type DeleteTablePathParams, type DeleteTableResponse, type DeleteTableVariables, type DeleteTransactionOperation, type DeleteUserAPIKeyError, type DeleteUserAPIKeyPathParams, type DeleteUserAPIKeyVariables, type DeleteUserError, type DeleteUserOAuthClientError, type DeleteUserOAuthClientPathParams, type DeleteUserOAuthClientVariables, type DeleteUserVariables, type DeleteWorkspaceError, type DeleteWorkspacePathParams, type DeleteWorkspaceVariables, type DeserializedType, type DownloadDestination, type EditableData, type ExecuteBranchMigrationPlanError, type ExecuteBranchMigrationPlanPathParams, type ExecuteBranchMigrationPlanRequestBody, type ExecuteBranchMigrationPlanVariables, type FetchImpl, FetcherError, type FetcherExtraProps, type FileAccessError, type FileAccessPathParams, type FileAccessQueryParams, type FileAccessVariables, FilesPlugin, type FilesPluginResult, type GetAuthorizationCodeError, type GetAuthorizationCodeQueryParams, type GetAuthorizationCodeVariables, type GetBranchDetailsError, type GetBranchDetailsPathParams, type GetBranchDetailsVariables, type GetBranchListError, type GetBranchListPathParams, type GetBranchListVariables, type GetBranchMetadataError, type GetBranchMetadataPathParams, type GetBranchMetadataVariables, type GetBranchMigrationHistoryError, type GetBranchMigrationHistoryPathParams, type GetBranchMigrationHistoryRequestBody, type GetBranchMigrationHistoryResponse, type GetBranchMigrationHistoryVariables, type GetBranchMigrationPlanError, type GetBranchMigrationPlanPathParams, type GetBranchMigrationPlanVariables, type GetBranchSchemaHistoryError, type GetBranchSchemaHistoryPathParams, type GetBranchSchemaHistoryRequestBody, type GetBranchSchemaHistoryResponse, type GetBranchSchemaHistoryVariables, type GetBranchStatsError, type GetBranchStatsPathParams, type GetBranchStatsResponse, type GetBranchStatsVariables, type GetClusterError, type GetClusterPathParams, type GetClusterVariables, type GetColumnError, type GetColumnPathParams, type GetColumnVariables, type GetDatabaseGithubSettingsError, type GetDatabaseGithubSettingsPathParams, type GetDatabaseGithubSettingsVariables, type GetDatabaseListError, type GetDatabaseListPathParams, type GetDatabaseListVariables, type GetDatabaseMetadataError, type GetDatabaseMetadataPathParams, type GetDatabaseMetadataVariables, type GetFileError, type GetFileItemError, type GetFileItemPathParams, type GetFileItemVariables, type GetFilePathParams, type GetFileVariables, type GetGitBranchesMappingError, type GetGitBranchesMappingPathParams, type GetGitBranchesMappingVariables, type GetMigrationRequestError, type GetMigrationRequestIsMergedError, type GetMigrationRequestIsMergedPathParams, type GetMigrationRequestIsMergedResponse, type GetMigrationRequestIsMergedVariables, type GetMigrationRequestPathParams, type GetMigrationRequestVariables, type GetRecordError, type GetRecordPathParams, type GetRecordQueryParams, type GetRecordVariables, type GetSchemaError, type GetSchemaPathParams, type GetSchemaResponse, type GetSchemaVariables, type GetTableColumnsError, type GetTableColumnsPathParams, type GetTableColumnsResponse, type GetTableColumnsVariables, type GetTableSchemaError, type GetTableSchemaPathParams, type GetTableSchemaResponse, type GetTableSchemaVariables, type GetUserAPIKeysError, type GetUserAPIKeysResponse, type GetUserAPIKeysVariables, type GetUserError, type GetUserOAuthAccessTokensError, type GetUserOAuthAccessTokensResponse, type GetUserOAuthAccessTokensVariables, type GetUserOAuthClientsError, type GetUserOAuthClientsResponse, type GetUserOAuthClientsVariables, type GetUserVariables, type GetWorkspaceError, type GetWorkspaceMembersListError, type GetWorkspaceMembersListPathParams, type GetWorkspaceMembersListVariables, type GetWorkspacePathParams, type GetWorkspaceVariables, type GetWorkspacesListError, type GetWorkspacesListResponse, type GetWorkspacesListVariables, type GrantAuthorizationCodeError, type GrantAuthorizationCodeVariables, type HostProvider, type Identifiable, type ImageTransformations, type InsertRecordError, type InsertRecordPathParams, type InsertRecordQueryParams, type InsertRecordVariables, type InsertRecordWithIDError, type InsertRecordWithIDPathParams, type InsertRecordWithIDQueryParams, type InsertRecordWithIDVariables, type InsertTransactionOperation, type InviteWorkspaceMemberError, type InviteWorkspaceMemberPathParams, type InviteWorkspaceMemberRequestBody, type InviteWorkspaceMemberVariables, type JSONData, type KeywordAskOptions, type Link, type ListClustersError, type ListClustersPathParams, type ListClustersVariables, type ListMigrationRequestsCommitsError, type ListMigrationRequestsCommitsPathParams, type ListMigrationRequestsCommitsRequestBody, type ListMigrationRequestsCommitsResponse, type ListMigrationRequestsCommitsVariables, type ListRegionsError, type ListRegionsPathParams, type ListRegionsVariables, type MergeMigrationRequestError, type MergeMigrationRequestPathParams, type MergeMigrationRequestVariables, type OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, type Paginable, type PaginationQueryMeta, type PreviewBranchSchemaEditError, type PreviewBranchSchemaEditPathParams, type PreviewBranchSchemaEditRequestBody, type PreviewBranchSchemaEditResponse, type PreviewBranchSchemaEditVariables, type PushBranchMigrationsError, type PushBranchMigrationsPathParams, type PushBranchMigrationsRequestBody, type PushBranchMigrationsVariables, type PutFileError, type PutFileItemError, type PutFileItemPathParams, type PutFileItemVariables, type PutFilePathParams, type PutFileVariables, Query, type QueryMigrationRequestsError, type QueryMigrationRequestsPathParams, type QueryMigrationRequestsRequestBody, type QueryMigrationRequestsResponse, type QueryMigrationRequestsVariables, type QueryTableError, type QueryTablePathParams, type QueryTableRequestBody, type QueryTableVariables, RecordArray, RecordColumnTypes, type RemoveGitBranchesEntryError, type RemoveGitBranchesEntryPathParams, type RemoveGitBranchesEntryQueryParams, type RemoveGitBranchesEntryVariables, type RemoveWorkspaceMemberError, type RemoveWorkspaceMemberPathParams, type RemoveWorkspaceMemberVariables, type RenameDatabaseError, type RenameDatabasePathParams, type RenameDatabaseRequestBody, type RenameDatabaseVariables, Repository, type ResendWorkspaceMemberInviteError, type ResendWorkspaceMemberInvitePathParams, type ResendWorkspaceMemberInviteVariables, type ResolveBranchError, type ResolveBranchPathParams, type ResolveBranchQueryParams, type ResolveBranchResponse, type ResolveBranchVariables, responses as Responses, RestRepository, SQLPlugin, type SQLPluginResult, type SQLQuery, type SQLQueryParams, type SchemaDefinition, type SchemaInference, SchemaPlugin, type SchemaPluginResult, schemas as Schemas, type SearchBranchError, type SearchBranchPathParams, type SearchBranchRequestBody, type SearchBranchVariables, type SearchOptions, SearchPlugin, type SearchPluginResult, type SearchTableError, type SearchTablePathParams, type SearchTableRequestBody, type SearchTableVariables, type SearchXataRecord, type SelectableColumn, type SelectableColumnWithObjectNotation, type SelectedPick, type SerializedString, Serializer, type SerializerResult, type SetTableSchemaError, type SetTableSchemaPathParams, type SetTableSchemaRequestBody, type SetTableSchemaVariables, SimpleCache, type SimpleCacheOptions, type SqlQueryError, type SqlQueryPathParams, type SqlQueryRequestBody, type SqlQueryVariables, type SummarizeTableError, type SummarizeTablePathParams, type SummarizeTableRequestBody, type SummarizeTableVariables, type TotalCount, type TransactionOperation, TransactionPlugin, type TransactionPluginResult, type TransactionResults, type UpdateBranchMetadataError, type UpdateBranchMetadataPathParams, type UpdateBranchMetadataVariables, type UpdateBranchSchemaError, type UpdateBranchSchemaPathParams, type UpdateBranchSchemaVariables, type UpdateClusterError, type UpdateClusterPathParams, type UpdateClusterVariables, type UpdateColumnError, type UpdateColumnPathParams, type UpdateColumnRequestBody, type UpdateColumnVariables, type UpdateDatabaseGithubSettingsError, type UpdateDatabaseGithubSettingsPathParams, type UpdateDatabaseGithubSettingsVariables, type UpdateDatabaseMetadataError, type UpdateDatabaseMetadataPathParams, type UpdateDatabaseMetadataRequestBody, type UpdateDatabaseMetadataVariables, type UpdateMigrationRequestError, type UpdateMigrationRequestPathParams, type UpdateMigrationRequestRequestBody, type UpdateMigrationRequestVariables, type UpdateOAuthAccessTokenError, type UpdateOAuthAccessTokenPathParams, type UpdateOAuthAccessTokenRequestBody, type UpdateOAuthAccessTokenVariables, type UpdateRecordWithIDError, type UpdateRecordWithIDPathParams, type UpdateRecordWithIDQueryParams, type UpdateRecordWithIDVariables, type UpdateTableError, type UpdateTablePathParams, type UpdateTableRequestBody, type UpdateTableVariables, type UpdateTransactionOperation, type UpdateUserError, type UpdateUserVariables, type UpdateWorkspaceError, type UpdateWorkspaceMemberInviteError, type UpdateWorkspaceMemberInvitePathParams, type UpdateWorkspaceMemberInviteRequestBody, type UpdateWorkspaceMemberInviteVariables, type UpdateWorkspaceMemberRoleError, type UpdateWorkspaceMemberRolePathParams, type UpdateWorkspaceMemberRoleRequestBody, type UpdateWorkspaceMemberRoleVariables, type UpdateWorkspacePathParams, type UpdateWorkspaceVariables, type UploadDestination, type UpsertRecordWithIDError, type UpsertRecordWithIDPathParams, type UpsertRecordWithIDQueryParams, type UpsertRecordWithIDVariables, type ValueAtColumn, type VectorAskOptions, type VectorSearchTableError, type VectorSearchTablePathParams, type VectorSearchTableRequestBody, type VectorSearchTableVariables, XataApiClient, type XataApiClientOptions, XataApiPlugin, type XataArrayFile, XataError, XataFile, XataPlugin, type XataPluginOptions, type XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, applyMigration, askTable, askTableSession, branchTransaction, buildClient, buildPreviewBranchName, buildProviderString, buildWorkerRunner, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, copyBranch, createBranch, createCluster, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteFile, deleteFileItem, deleteOAuthAccessToken, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteUserOAuthClient, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, fileAccess, ge, getAPIKey, getAuthorizationCode, getBranch, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getCluster, getColumn, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getFile, getFileItem, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getPreviewBranch, getRecord, getSchema, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getUserOAuthAccessTokens, getUserOAuthClients, getWorkspace, getWorkspaceMembersList, getWorkspacesList, grantAuthorizationCode, greaterEquals, greaterThan, greaterThanEquals, gt, gte, iContains, iPattern, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isValidExpandedColumn, isValidSelectableColumns, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listClusters, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, previewBranchSchemaEdit, pushBranchMigrations, putFile, putFileItem, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, renameDatabase, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, sqlQuery, startsWith, summarizeTable, transformImage, updateBranchMetadata, updateBranchSchema, updateCluster, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateMigrationRequest, updateOAuthAccessToken, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID, vectorSearchTable };
|
9241
|
+
export { type AcceptWorkspaceMemberInviteError, type AcceptWorkspaceMemberInvitePathParams, type AcceptWorkspaceMemberInviteVariables, type AddGitBranchesEntryError, type AddGitBranchesEntryPathParams, type AddGitBranchesEntryRequestBody, type AddGitBranchesEntryResponse, type AddGitBranchesEntryVariables, type AddTableColumnError, type AddTableColumnPathParams, type AddTableColumnVariables, type AggregateTableError, type AggregateTablePathParams, type AggregateTableRequestBody, type AggregateTableVariables, type ApiExtraProps, type ApplyBranchSchemaEditError, type ApplyBranchSchemaEditPathParams, type ApplyBranchSchemaEditRequestBody, type ApplyBranchSchemaEditVariables, type ApplyMigrationError, type ApplyMigrationPathParams, type ApplyMigrationRequestBody, type ApplyMigrationVariables, type AskOptions, type AskResult, type AskTableError, type AskTablePathParams, type AskTableRequestBody, type AskTableResponse, type AskTableSessionError, type AskTableSessionPathParams, type AskTableSessionRequestBody, type AskTableSessionResponse, type AskTableSessionVariables, type AskTableVariables, BaseClient, type BaseClientOptions, type BaseData, type BaseSchema, type BinaryFile, type BranchTransactionError, type BranchTransactionPathParams, type BranchTransactionRequestBody, type BranchTransactionVariables, type BulkInsertTableRecordsError, type BulkInsertTableRecordsPathParams, type BulkInsertTableRecordsQueryParams, type BulkInsertTableRecordsRequestBody, type BulkInsertTableRecordsVariables, type CacheImpl, type CancelWorkspaceMemberInviteError, type CancelWorkspaceMemberInvitePathParams, type CancelWorkspaceMemberInviteVariables, type ClientConstructor, type ColumnsByValue, type CompareBranchSchemasError, type CompareBranchSchemasPathParams, type CompareBranchSchemasRequestBody, type CompareBranchSchemasVariables, type CompareBranchWithUserSchemaError, type CompareBranchWithUserSchemaPathParams, type CompareBranchWithUserSchemaRequestBody, type CompareBranchWithUserSchemaVariables, type CompareMigrationRequestError, type CompareMigrationRequestPathParams, type CompareMigrationRequestVariables, type CopyBranchError, type CopyBranchPathParams, type CopyBranchRequestBody, type CopyBranchVariables, type CreateBranchError, type CreateBranchPathParams, type CreateBranchQueryParams, type CreateBranchRequestBody, type CreateBranchResponse, type CreateBranchVariables, type CreateClusterError, type CreateClusterPathParams, type CreateClusterVariables, type CreateDatabaseError, type CreateDatabasePathParams, type CreateDatabaseRequestBody, type CreateDatabaseResponse, type CreateDatabaseVariables, type CreateMigrationRequestError, type CreateMigrationRequestPathParams, type CreateMigrationRequestRequestBody, type CreateMigrationRequestResponse, type CreateMigrationRequestVariables, type CreateTableError, type CreateTablePathParams, type CreateTableResponse, type CreateTableVariables, type CreateUserAPIKeyError, type CreateUserAPIKeyPathParams, type CreateUserAPIKeyResponse, type CreateUserAPIKeyVariables, type CreateWorkspaceError, type CreateWorkspaceVariables, type CursorNavigationOptions, type DeleteBranchError, type DeleteBranchPathParams, type DeleteBranchResponse, type DeleteBranchVariables, type DeleteColumnError, type DeleteColumnPathParams, type DeleteColumnVariables, type DeleteDatabaseError, type DeleteDatabaseGithubSettingsError, type DeleteDatabaseGithubSettingsPathParams, type DeleteDatabaseGithubSettingsVariables, type DeleteDatabasePathParams, type DeleteDatabaseResponse, type DeleteDatabaseVariables, type DeleteFileError, type DeleteFileItemError, type DeleteFileItemPathParams, type DeleteFileItemVariables, type DeleteFilePathParams, type DeleteFileVariables, type DeleteOAuthAccessTokenError, type DeleteOAuthAccessTokenPathParams, type DeleteOAuthAccessTokenVariables, type DeleteRecordError, type DeleteRecordPathParams, type DeleteRecordQueryParams, type DeleteRecordVariables, type DeleteTableError, type DeleteTablePathParams, type DeleteTableResponse, type DeleteTableVariables, type DeleteTransactionOperation, type DeleteUserAPIKeyError, type DeleteUserAPIKeyPathParams, type DeleteUserAPIKeyVariables, type DeleteUserError, type DeleteUserOAuthClientError, type DeleteUserOAuthClientPathParams, type DeleteUserOAuthClientVariables, type DeleteUserVariables, type DeleteWorkspaceError, type DeleteWorkspacePathParams, type DeleteWorkspaceVariables, type DeserializedType, type DownloadDestination, type EditableData, type ExecuteBranchMigrationPlanError, type ExecuteBranchMigrationPlanPathParams, type ExecuteBranchMigrationPlanRequestBody, type ExecuteBranchMigrationPlanVariables, type FetchImpl, FetcherError, type FetcherExtraProps, type FileAccessError, type FileAccessPathParams, type FileAccessQueryParams, type FileAccessVariables, FilesPlugin, type FilesPluginResult, type GetAuthorizationCodeError, type GetAuthorizationCodeQueryParams, type GetAuthorizationCodeVariables, type GetBranchDetailsError, type GetBranchDetailsPathParams, type GetBranchDetailsVariables, type GetBranchListError, type GetBranchListPathParams, type GetBranchListVariables, type GetBranchMetadataError, type GetBranchMetadataPathParams, type GetBranchMetadataVariables, type GetBranchMigrationHistoryError, type GetBranchMigrationHistoryPathParams, type GetBranchMigrationHistoryRequestBody, type GetBranchMigrationHistoryResponse, type GetBranchMigrationHistoryVariables, type GetBranchMigrationPlanError, type GetBranchMigrationPlanPathParams, type GetBranchMigrationPlanVariables, type GetBranchSchemaHistoryError, type GetBranchSchemaHistoryPathParams, type GetBranchSchemaHistoryRequestBody, type GetBranchSchemaHistoryResponse, type GetBranchSchemaHistoryVariables, type GetBranchStatsError, type GetBranchStatsPathParams, type GetBranchStatsResponse, type GetBranchStatsVariables, type GetClusterError, type GetClusterPathParams, type GetClusterVariables, type GetColumnError, type GetColumnPathParams, type GetColumnVariables, type GetDatabaseGithubSettingsError, type GetDatabaseGithubSettingsPathParams, type GetDatabaseGithubSettingsVariables, type GetDatabaseListError, type GetDatabaseListPathParams, type GetDatabaseListVariables, type GetDatabaseMetadataError, type GetDatabaseMetadataPathParams, type GetDatabaseMetadataVariables, type GetFileError, type GetFileItemError, type GetFileItemPathParams, type GetFileItemVariables, type GetFilePathParams, type GetFileVariables, type GetGitBranchesMappingError, type GetGitBranchesMappingPathParams, type GetGitBranchesMappingVariables, type GetMigrationRequestError, type GetMigrationRequestIsMergedError, type GetMigrationRequestIsMergedPathParams, type GetMigrationRequestIsMergedResponse, type GetMigrationRequestIsMergedVariables, type GetMigrationRequestPathParams, type GetMigrationRequestVariables, type GetRecordError, type GetRecordPathParams, type GetRecordQueryParams, type GetRecordVariables, type GetSchemaError, type GetSchemaPathParams, type GetSchemaResponse, type GetSchemaVariables, type GetTableColumnsError, type GetTableColumnsPathParams, type GetTableColumnsResponse, type GetTableColumnsVariables, type GetTableSchemaError, type GetTableSchemaPathParams, type GetTableSchemaResponse, type GetTableSchemaVariables, type GetUserAPIKeysError, type GetUserAPIKeysResponse, type GetUserAPIKeysVariables, type GetUserError, type GetUserOAuthAccessTokensError, type GetUserOAuthAccessTokensResponse, type GetUserOAuthAccessTokensVariables, type GetUserOAuthClientsError, type GetUserOAuthClientsResponse, type GetUserOAuthClientsVariables, type GetUserVariables, type GetWorkspaceError, type GetWorkspaceMembersListError, type GetWorkspaceMembersListPathParams, type GetWorkspaceMembersListVariables, type GetWorkspacePathParams, type GetWorkspaceVariables, type GetWorkspacesListError, type GetWorkspacesListResponse, type GetWorkspacesListVariables, type GrantAuthorizationCodeError, type GrantAuthorizationCodeVariables, type HostProvider, type Identifiable, type ImageTransformations, type InsertRecordError, type InsertRecordPathParams, type InsertRecordQueryParams, type InsertRecordVariables, type InsertRecordWithIDError, type InsertRecordWithIDPathParams, type InsertRecordWithIDQueryParams, type InsertRecordWithIDVariables, type InsertTransactionOperation, type InviteWorkspaceMemberError, type InviteWorkspaceMemberPathParams, type InviteWorkspaceMemberRequestBody, type InviteWorkspaceMemberVariables, type JSONData, type KeywordAskOptions, type Link, type ListClustersError, type ListClustersPathParams, type ListClustersVariables, type ListMigrationRequestsCommitsError, type ListMigrationRequestsCommitsPathParams, type ListMigrationRequestsCommitsRequestBody, type ListMigrationRequestsCommitsResponse, type ListMigrationRequestsCommitsVariables, type ListRegionsError, type ListRegionsPathParams, type ListRegionsVariables, type MergeMigrationRequestError, type MergeMigrationRequestPathParams, type MergeMigrationRequestVariables, type OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, type Paginable, type PaginationQueryMeta, type PgRollJobStatusError, type PgRollJobStatusPathParams, type PgRollJobStatusVariables, type PgRollStatusError, type PgRollStatusPathParams, type PgRollStatusVariables, type PreviewBranchSchemaEditError, type PreviewBranchSchemaEditPathParams, type PreviewBranchSchemaEditRequestBody, type PreviewBranchSchemaEditResponse, type PreviewBranchSchemaEditVariables, type PushBranchMigrationsError, type PushBranchMigrationsPathParams, type PushBranchMigrationsRequestBody, type PushBranchMigrationsVariables, type PutFileError, type PutFileItemError, type PutFileItemPathParams, type PutFileItemVariables, type PutFilePathParams, type PutFileVariables, Query, type QueryMigrationRequestsError, type QueryMigrationRequestsPathParams, type QueryMigrationRequestsRequestBody, type QueryMigrationRequestsResponse, type QueryMigrationRequestsVariables, type QueryTableError, type QueryTablePathParams, type QueryTableRequestBody, type QueryTableVariables, RecordArray, RecordColumnTypes, type RemoveGitBranchesEntryError, type RemoveGitBranchesEntryPathParams, type RemoveGitBranchesEntryQueryParams, type RemoveGitBranchesEntryVariables, type RemoveWorkspaceMemberError, type RemoveWorkspaceMemberPathParams, type RemoveWorkspaceMemberVariables, type RenameDatabaseError, type RenameDatabasePathParams, type RenameDatabaseRequestBody, type RenameDatabaseVariables, Repository, type ResendWorkspaceMemberInviteError, type ResendWorkspaceMemberInvitePathParams, type ResendWorkspaceMemberInviteVariables, type ResolveBranchError, type ResolveBranchPathParams, type ResolveBranchQueryParams, type ResolveBranchResponse, type ResolveBranchVariables, responses as Responses, RestRepository, SQLPlugin, type SQLPluginResult, type SQLQuery, type SQLQueryParams, type SchemaDefinition, type SchemaInference, SchemaPlugin, type SchemaPluginResult, schemas as Schemas, type SearchBranchError, type SearchBranchPathParams, type SearchBranchRequestBody, type SearchBranchVariables, type SearchOptions, SearchPlugin, type SearchPluginResult, type SearchTableError, type SearchTablePathParams, type SearchTableRequestBody, type SearchTableVariables, type SearchXataRecord, type SelectableColumn, type SelectableColumnWithObjectNotation, type SelectedPick, type SerializedString, Serializer, type SerializerResult, type SetTableSchemaError, type SetTableSchemaPathParams, type SetTableSchemaRequestBody, type SetTableSchemaVariables, SimpleCache, type SimpleCacheOptions, type SqlQueryError, type SqlQueryPathParams, type SqlQueryRequestBody, type SqlQueryVariables, type SummarizeTableError, type SummarizeTablePathParams, type SummarizeTableRequestBody, type SummarizeTableVariables, type TotalCount, type TransactionOperation, TransactionPlugin, type TransactionPluginResult, type TransactionResults, type UpdateBranchMetadataError, type UpdateBranchMetadataPathParams, type UpdateBranchMetadataVariables, type UpdateBranchSchemaError, type UpdateBranchSchemaPathParams, type UpdateBranchSchemaVariables, type UpdateClusterError, type UpdateClusterPathParams, type UpdateClusterVariables, type UpdateColumnError, type UpdateColumnPathParams, type UpdateColumnRequestBody, type UpdateColumnVariables, type UpdateDatabaseGithubSettingsError, type UpdateDatabaseGithubSettingsPathParams, type UpdateDatabaseGithubSettingsVariables, type UpdateDatabaseMetadataError, type UpdateDatabaseMetadataPathParams, type UpdateDatabaseMetadataRequestBody, type UpdateDatabaseMetadataVariables, type UpdateMigrationRequestError, type UpdateMigrationRequestPathParams, type UpdateMigrationRequestRequestBody, type UpdateMigrationRequestVariables, type UpdateOAuthAccessTokenError, type UpdateOAuthAccessTokenPathParams, type UpdateOAuthAccessTokenRequestBody, type UpdateOAuthAccessTokenVariables, type UpdateRecordWithIDError, type UpdateRecordWithIDPathParams, type UpdateRecordWithIDQueryParams, type UpdateRecordWithIDVariables, type UpdateTableError, type UpdateTablePathParams, type UpdateTableRequestBody, type UpdateTableVariables, type UpdateTransactionOperation, type UpdateUserError, type UpdateUserVariables, type UpdateWorkspaceError, type UpdateWorkspaceMemberInviteError, type UpdateWorkspaceMemberInvitePathParams, type UpdateWorkspaceMemberInviteRequestBody, type UpdateWorkspaceMemberInviteVariables, type UpdateWorkspaceMemberRoleError, type UpdateWorkspaceMemberRolePathParams, type UpdateWorkspaceMemberRoleRequestBody, type UpdateWorkspaceMemberRoleVariables, type UpdateWorkspacePathParams, type UpdateWorkspaceVariables, type UploadDestination, type UpsertRecordWithIDError, type UpsertRecordWithIDPathParams, type UpsertRecordWithIDQueryParams, type UpsertRecordWithIDVariables, type ValueAtColumn, type VectorAskOptions, type VectorSearchTableError, type VectorSearchTablePathParams, type VectorSearchTableRequestBody, type VectorSearchTableVariables, XataApiClient, type XataApiClientOptions, XataApiPlugin, type XataArrayFile, XataError, XataFile, XataPlugin, type XataPluginOptions, type XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, aggregateTable, applyBranchSchemaEdit, applyMigration, askTable, askTableSession, branchTransaction, buildClient, buildPreviewBranchName, buildProviderString, bulkInsertTableRecords, cancelWorkspaceMemberInvite, compareBranchSchemas, compareBranchWithUserSchema, compareMigrationRequest, contains, copyBranch, createBranch, createCluster, createDatabase, createMigrationRequest, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteDatabaseGithubSettings, deleteFile, deleteFileItem, deleteOAuthAccessToken, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteUserOAuthClient, deleteWorkspace, deserialize, endsWith, equals, executeBranchMigrationPlan, exists, fileAccess, ge, getAPIKey, getAuthorizationCode, getBranch, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchSchemaHistory, getBranchStats, getCluster, getColumn, getDatabaseGithubSettings, getDatabaseList, getDatabaseMetadata, getDatabaseURL, getFile, getFileItem, getGitBranchesMapping, getHostUrl, getMigrationRequest, getMigrationRequestIsMerged, getPreviewBranch, getRecord, getSchema, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getUserOAuthAccessTokens, getUserOAuthClients, getWorkspace, getWorkspaceMembersList, getWorkspacesList, grantAuthorizationCode, greaterEquals, greaterThan, greaterThanEquals, gt, gte, iContains, iPattern, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isHostProviderAlias, isHostProviderBuilder, isIdentifiable, isNot, isValidExpandedColumn, isValidSelectableColumns, isXataRecord, le, lessEquals, lessThan, lessThanEquals, listClusters, listMigrationRequestsCommits, listRegions, lt, lte, mergeMigrationRequest, notExists, operationsByTag, parseProviderString, parseWorkspacesUrlParts, pattern, pgRollJobStatus, pgRollStatus, previewBranchSchemaEdit, pushBranchMigrations, putFile, putFileItem, queryMigrationRequests, queryTable, removeGitBranchesEntry, removeWorkspaceMember, renameDatabase, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, serialize, setTableSchema, sqlQuery, startsWith, summarizeTable, transformImage, updateBranchMetadata, updateBranchSchema, updateCluster, updateColumn, updateDatabaseGithubSettings, updateDatabaseMetadata, updateMigrationRequest, updateOAuthAccessToken, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberInvite, updateWorkspaceMemberRole, upsertRecordWithID, vectorSearchTable };
|