@xata.io/client 0.0.0-alpha.vf89b33e → 0.0.0-alpha.vf95371f

package/dist/index.d.ts

@@ -19,11 +19,39 @@ declare type ErrorWrapper<TError> = TError | {
     payload: string;
 };
 
+interface CacheImpl {
+    cacheRecords: boolean;
+    defaultQueryTTL: number;
+    getAll(): Promise<Record<string, unknown>>;
+    get: <T>(key: string) => Promise<T | null>;
+    set: <T>(key: string, value: T) => Promise<void>;
+    delete: (key: string) => Promise<void>;
+    clear: () => Promise<void>;
+}
+interface SimpleCacheOptions {
+    max?: number;
+    cacheRecords?: boolean;
+    defaultQueryTTL?: number;
+}
+declare class SimpleCache implements CacheImpl {
+    #private;
+    capacity: number;
+    cacheRecords: boolean;
+    defaultQueryTTL: number;
+    constructor(options?: SimpleCacheOptions);
+    getAll(): Promise<Record<string, unknown>>;
+    get<T>(key: string): Promise<T | null>;
+    set<T>(key: string, value: T): Promise<void>;
+    delete(key: string): Promise<void>;
+    clear(): Promise<void>;
+}
+
 declare abstract class XataPlugin {
     abstract build(options: XataPluginOptions): unknown | Promise<unknown>;
 }
 declare type XataPluginOptions = {
     getFetchProps: () => Promise<FetcherExtraProps>;
+    cache: CacheImpl;
 };
 
 /**
@@ -110,6 +138,12 @@ declare type ListBranchesResponse = {
     displayName: string;
     branches: Branch[];
 };
+declare type ListGitBranchesResponse = {
+    mapping: {
+        gitBranch: string;
+        xataBranch: string;
+    }[];
+};
 declare type Branch = {
     name: string;
     createdAt: DateTime;
@@ -158,7 +192,7 @@ declare type Table = {
  */
 declare type Column = {
     name: string;
-    type: 'bool' | 'int' | 'float' | 'string' | 'text' | 'email' | 'multiple' | 'link' | 'object';
+    type: 'bool' | 'int' | 'float' | 'string' | 'text' | 'email' | 'multiple' | 'link' | 'object' | 'datetime';
     link?: {
         table: string;
     };
@@ -354,6 +388,7 @@ type schemas_WorkspaceMembers = WorkspaceMembers;
 type schemas_InviteKey = InviteKey;
 type schemas_ListDatabasesResponse = ListDatabasesResponse;
 type schemas_ListBranchesResponse = ListBranchesResponse;
+type schemas_ListGitBranchesResponse = ListGitBranchesResponse;
 type schemas_Branch = Branch;
 type schemas_BranchMetadata = BranchMetadata;
 type schemas_DBBranch = DBBranch;
@@ -406,6 +441,7 @@ declare namespace schemas {
     schemas_InviteKey as InviteKey,
     schemas_ListDatabasesResponse as ListDatabasesResponse,
     schemas_ListBranchesResponse as ListBranchesResponse,
+    schemas_ListGitBranchesResponse as ListGitBranchesResponse,
     schemas_Branch as Branch,
     schemas_BranchMetadata as BranchMetadata,
     schemas_DBBranch as DBBranch,
@@ -982,6 +1018,163 @@ declare type DeleteDatabaseVariables = {
  * Delete a database and all of its branches and tables permanently.
  */
 declare const deleteDatabase: (variables: DeleteDatabaseVariables) => Promise<undefined>;
+declare type GetGitBranchesMappingPathParams = {
+    dbName: DBName;
+    workspace: string;
+};
+declare type GetGitBranchesMappingError = ErrorWrapper<{
+    status: 400;
+    payload: BadRequestError;
+} | {
+    status: 401;
+    payload: AuthError;
+}>;
+declare type GetGitBranchesMappingVariables = {
+    pathParams: GetGitBranchesMappingPathParams;
+} & FetcherExtraProps;
+/**
+ * Lists all the git branches in the mapping, and their associated Xata branches.
+ *
+ * Example response:
+ *
+ * ```json
+ * {
+ *   "mappings": [
+ *       {
+ *         "gitBranch": "main",
+ *         "xataBranch": "main"
+ *       },
+ *       {
+ *         "gitBranch": "gitBranch1",
+ *         "xataBranch": "xataBranch1"
+ *       }
+ *       {
+ *         "gitBranch": "xataBranch2",
+ *         "xataBranch": "xataBranch2"
+ *       }
+ *   ]
+ * }
+ * ```
+ */
+declare const getGitBranchesMapping: (variables: GetGitBranchesMappingVariables) => Promise<ListGitBranchesResponse>;
+declare type AddGitBranchesEntryPathParams = {
+    dbName: DBName;
+    workspace: string;
+};
+declare type AddGitBranchesEntryError = ErrorWrapper<{
+    status: 400;
+    payload: BadRequestError;
+} | {
+    status: 401;
+    payload: AuthError;
+}>;
+declare type AddGitBranchesEntryResponse = {
+    warning?: string;
+};
+declare type AddGitBranchesEntryRequestBody = {
+    gitBranch: string;
+    xataBranch: BranchName;
+};
+declare type AddGitBranchesEntryVariables = {
+    body: AddGitBranchesEntryRequestBody;
+    pathParams: AddGitBranchesEntryPathParams;
+} & FetcherExtraProps;
+/**
+ * Adds an entry to the mapping of git branches to Xata branches. The git branch and the Xata branch must be present in the body of the request. If the Xata branch doesn't exist, a 400 error is returned.
+ *
+ * If the git branch is already present in the mapping, the old entry is overwritten, and a warning message is included in the response. If the git branch is added and didn't exist before, the response code is 204. If the git branch existed and it was overwritten, the response code is 201.
+ *
+ * Example request:
+ *
+ * ```json
+ * // POST https://tutorial-ng7s8c.xata.sh/dbs/demo/gitBranches
+ * {
+ *   "gitBranch": "fix/bug123",
+ *   "xataBranch": "fix_bug"
+ * }
+ * ```
+ */
+declare const addGitBranchesEntry: (variables: AddGitBranchesEntryVariables) => Promise<AddGitBranchesEntryResponse>;
+declare type RemoveGitBranchesEntryPathParams = {
+    dbName: DBName;
+    workspace: string;
+};
+declare type RemoveGitBranchesEntryQueryParams = {
+    gitBranch: string;
+};
+declare type RemoveGitBranchesEntryError = ErrorWrapper<{
+    status: 400;
+    payload: BadRequestError;
+} | {
+    status: 401;
+    payload: AuthError;
+}>;
+declare type RemoveGitBranchesEntryVariables = {
+    pathParams: RemoveGitBranchesEntryPathParams;
+    queryParams: RemoveGitBranchesEntryQueryParams;
+} & FetcherExtraProps;
+/**
+ * Removes an entry from the mapping of git branches to Xata branches. The name of the git branch must be passed as a query parameter. If the git branch is not found, the endpoint returns a 404 status code.
+ *
+ * Example request:
+ *
+ * ```json
+ * // DELETE https://tutorial-ng7s8c.xata.sh/dbs/demo/gitBranches?gitBranch=fix%2Fbug123
+ * ```
+ */
+declare const removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables) => Promise<undefined>;
+declare type ResolveBranchPathParams = {
+    dbName: DBName;
+    workspace: string;
+};
+declare type ResolveBranchQueryParams = {
+    gitBranch?: string;
+    fallbackBranch?: string;
+};
+declare type ResolveBranchError = ErrorWrapper<{
+    status: 400;
+    payload: BadRequestError;
+} | {
+    status: 401;
+    payload: AuthError;
+}>;
+declare type ResolveBranchResponse = {
+    branch: string;
+    reason: {
+        code: 'FOUND_IN_MAPPING' | 'BRANCH_EXISTS' | 'FALLBACK_BRANCH' | 'DEFAULT_BRANCH';
+        message: string;
+    };
+};
+declare type ResolveBranchVariables = {
+    pathParams: ResolveBranchPathParams;
+    queryParams?: ResolveBranchQueryParams;
+} & FetcherExtraProps;
+/**
+ * In order to resolve the database branch, the following algorithm is used:
+ * * if the `gitBranch` was provided and is found in the [git branches mapping](/api-reference/dbs/db_name/gitBranches), the associated Xata branch is returned
+ * * else, if a Xata branch with the exact same name as `gitBranch` exists, return it
+ * * else, if `fallbackBranch` is provided and a branch with that name exists, return it
+ * * else, return the default branch of the DB (`main` or the first branch)
+ *
+ * Example call:
+ *
+ * ```json
+ * // GET https://tutorial-ng7s8c.xata.sh/dbs/demo/dbs/demo/resolveBranch?gitBranch=test&fallbackBranch=tsg
+ * ```
+ *
+ * Example response:
+ *
+ * ```json
+ * {
+ *   "branch": "main",
+ *   "reason": {
+ *     "code": "DEFAULT_BRANCH",
+ *     "message": "Default branch for this database (main)"
+ *   }
+ * }
+ * ```
+ */
+declare const resolveBranch: (variables: ResolveBranchVariables) => Promise<ResolveBranchResponse>;
 declare type GetBranchDetailsPathParams = {
     dbBranchName: DBBranchName;
     workspace: string;
@@ -1266,8 +1459,9 @@ declare type UpdateTableVariables = {
  *
  * In the example below, we rename a table from “users” to “people”:
  *
- * ```jsx
- * PATCH /db/test:main/tables/users
+ * ```json
+ * // PATCH /db/test:main/tables/users
+ *
  * {
  *   "name": "people"
  * }
@@ -1675,7 +1869,7 @@ declare type QueryTableVariables = {
  * {
  *   "columns": [...],
  *   "filter": {
- *     "$all": [...]
+ *     "$all": [...],
  *     "$any": [...]
  *     ...
  *   },
@@ -1721,7 +1915,11 @@ declare type QueryTableVariables = {
  *           "link": {
  *             "table": "users"
  *           }
- *         }
+ *         },
+ *         {
+ *           "name": "foundedDate",
+ *           "type": "datetime"
+ *         },
  *       ]
  *     },
  *     {
@@ -1809,7 +2007,7 @@ declare type QueryTableVariables = {
  * {
  *   "name": "Kilian",
  *   "address": {
- *     "street": "New street",
+ *     "street": "New street"
  *   }
  * }
  * ```
@@ -1818,10 +2016,7 @@ declare type QueryTableVariables = {
  *
  * ```json
  * {
- *   "columns": [
- *     "*",
- *     "team.name"
- *   ]
+ *   "columns": ["*", "team.name"]
  * }
  * ```
  *
@@ -1839,7 +2034,7 @@ declare type QueryTableVariables = {
  *   "team": {
  *     "id": "XX",
  *     "xata": {
- *       "version": 0,
+ *       "version": 0
  *     },
  *     "name": "first team"
  *   }
@@ -1850,10 +2045,7 @@ declare type QueryTableVariables = {
  *
  * ```json
  * {
- *   "columns": [
- *     "*",
- *     "team.*"
- *   ]
+ *   "columns": ["*", "team.*"]
  * }
  * ```
  *
@@ -1871,10 +2063,11 @@ declare type QueryTableVariables = {
  *   "team": {
  *     "id": "XX",
  *     "xata": {
- *       "version": 0,
+ *       "version": 0
  *     },
  *     "name": "first team",
- *     "code": "A1"
+ *     "code": "A1",
+ *     "foundedDate": "2020-03-04T10:43:54.32Z"
  *   }
  * }
  * ```
@@ -1889,7 +2082,7 @@ declare type QueryTableVariables = {
  *   `$none`, etc.
  *
  * All operators start with an `$` to differentiate them from column names
- * (which are not allowed to start with an dollar sign).
+ * (which are not allowed to start with a dollar sign).
  *
  * #### Exact matching and control operators
  *
@@ -1920,7 +2113,7 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *       "name": "r2",
+ *     "name": "r2"
  *   }
  * }
  * ```
@@ -1942,7 +2135,7 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *       "settings.plan": "free",
+ *     "settings.plan": "free"
  *   }
  * }
  * ```
@@ -1952,8 +2145,8 @@ declare type QueryTableVariables = {
  *   "filter": {
  *     "settings": {
  *       "plan": "free"
- *     },
- *   },
+ *     }
+ *   }
  * }
  * ```
  *
@@ -1962,8 +2155,8 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *     "settings.plan": {"$any": ["free", "paid"]}
- *   },
+ *     "settings.plan": { "$any": ["free", "paid"] }
+ *   }
  * }
  * ```
  *
@@ -1972,9 +2165,9 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *       "settings.dark": true,
- *       "settings.plan": "free",
- *   },
+ *     "settings.dark": true,
+ *     "settings.plan": "free"
+ *   }
  * }
  * ```
  *
@@ -1985,11 +2178,11 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *       "$any": {
- *         "settings.dark": true,
- *         "settings.plan": "free"
- *       }
- *   },
+ *     "$any": {
+ *       "settings.dark": true,
+ *       "settings.plan": "free"
+ *     }
+ *   }
  * }
  * ```
  *
@@ -2000,10 +2193,10 @@ declare type QueryTableVariables = {
  *   "filter": {
  *     "$any": [
  *       {
- *         "name": "r1",
+ *         "name": "r1"
  *       },
  *       {
- *         "name": "r2",
+ *         "name": "r2"
  *       }
  *     ]
  *   }
@@ -2015,7 +2208,7 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *     "$exists": "settings",
+ *     "$exists": "settings"
  *   }
  * }
  * ```
@@ -2027,10 +2220,10 @@ declare type QueryTableVariables = {
  *   "filter": {
  *     "$all": [
  *       {
- *         "$exists": "settings",
+ *         "$exists": "settings"
  *       },
  *       {
- *         "$exists": "name",
+ *         "$exists": "name"
  *       }
  *     ]
  *   }
@@ -2042,7 +2235,7 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *     "$notExists": "settings",
+ *     "$notExists": "settings"
  *   }
  * }
  * ```
@@ -2069,7 +2262,7 @@ declare type QueryTableVariables = {
  * {
  *   "filter": {
  *     "<column_name>": {
- *         "$pattern": "v*alue*"
+ *       "$pattern": "v*alue*"
  *     }
  *   }
  * }
@@ -2081,31 +2274,41 @@ declare type QueryTableVariables = {
  * {
  *   "filter": {
  *     "<column_name>": {
- *         "$endsWith": ".gz"
+ *       "$endsWith": ".gz"
  *     },
  *     "<column_name>": {
- *         "$startsWith": "tmp-"
+ *       "$startsWith": "tmp-"
  *     }
  *   }
  * }
  * ```
  *
- * #### Numeric ranges
+ * #### Numeric or datetime ranges
  *
  * ```json
  * {
  *   "filter": {
- *       "<column_name>": {
- *         "$ge": 0,
- *         "$lt": 100
- *       }
+ *     "<column_name>": {
+ *       "$ge": 0,
+ *       "$lt": 100
+ *     }
+ *   }
+ * }
+ * ```
+ * Date ranges support the same operators, with the date using the format defined in
+ * [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339):
+ * ```json
+ * {
+ *   "filter": {
+ *     "<column_name>": {
+ *       "$gt": "2019-10-12T07:20:50.52Z",
+ *       "$lt": "2021-10-12T07:20:50.52Z"
+ *     }
  *   }
  * }
  * ```
- *
  * The supported operators are `$gt`, `$lt`, `$ge`, `$le`.
  *
- *
  * #### Negations
  *
  * A general `$not` operator can inverse any operation.
@@ -2130,15 +2333,21 @@ declare type QueryTableVariables = {
  * {
  *   "filter": {
  *     "$not": {
- *       "$any": [{
- *         "<column_name1>": "value1"
- *       }, {
- *         "$all": [{
- *           "<column_name2>": "value2"
- *         }, {
- *           "<column_name3>": "value3"
- *         }]
- *       }]
+ *       "$any": [
+ *         {
+ *           "<column_name1>": "value1"
+ *         },
+ *         {
+ *           "$all": [
+ *             {
+ *               "<column_name2>": "value2"
+ *             },
+ *             {
+ *               "<column_name3>": "value3"
+ *             }
+ *           ]
+ *         }
+ *       ]
  *     }
  *   }
  * }
@@ -2193,8 +2402,8 @@ declare type QueryTableVariables = {
  *     "<array name>": {
  *       "$includes": {
  *         "$all": [
- *           {"$contains": "label"},
- *           {"$not": {"$endsWith": "-debug"}}
+ *           { "$contains": "label" },
+ *           { "$not": { "$endsWith": "-debug" } }
  *         ]
  *       }
  *     }
@@ -2214,9 +2423,7 @@ declare type QueryTableVariables = {
  * {
  *   "filter": {
  *     "settings.labels": {
- *       "$includesAll": [
- *         {"$contains": "label"},
- *       ]
+ *       "$includesAll": [{ "$contains": "label" }]
  *     }
  *   }
  * }
@@ -2264,7 +2471,6 @@ declare type QueryTableVariables = {
  * }
  * ```
  *
- *
  * ### Pagination
  *
  * We offer cursor pagination and offset pagination. The offset pagination is limited
@@ -2330,8 +2536,8 @@ declare type QueryTableVariables = {
  * can be queried by update `page.after` to the returned cursor while keeping the
  * `page.before` cursor from the first range query.
  *
- * The `filter` , `columns`,  `sort` , and `page.size` configuration will be
- * encoded with the cursor.  The pagination request will be invalid if
+ * The `filter` , `columns`, `sort` , and `page.size` configuration will be
+ * encoded with the cursor. The pagination request will be invalid if
  * `filter` or `sort` is set. The columns returned and page size can be changed
  * anytime by passing the `columns` or `page.size` settings to the next query.
  *
@@ -2422,6 +2628,10 @@ declare const operationsByTag: {
         getDatabaseList: (variables: GetDatabaseListVariables) => Promise<ListDatabasesResponse>;
         createDatabase: (variables: CreateDatabaseVariables) => Promise<CreateDatabaseResponse>;
         deleteDatabase: (variables: DeleteDatabaseVariables) => Promise<undefined>;
+        getGitBranchesMapping: (variables: GetGitBranchesMappingVariables) => Promise<ListGitBranchesResponse>;
+        addGitBranchesEntry: (variables: AddGitBranchesEntryVariables) => Promise<AddGitBranchesEntryResponse>;
+        removeGitBranchesEntry: (variables: RemoveGitBranchesEntryVariables) => Promise<undefined>;
+        resolveBranch: (variables: ResolveBranchVariables) => Promise<ResolveBranchResponse>;
     };
     branch: {
         getBranchList: (variables: GetBranchListVariables) => Promise<ListBranchesResponse>;
@@ -2472,6 +2682,9 @@ interface XataApiClientOptions {
     apiKey?: string;
     host?: HostProvider;
 }
+/**
+ * @deprecated Use XataApiPlugin instead
+ */
 declare class XataApiClient {
     #private;
     constructor(options?: XataApiClientOptions);
@@ -2514,6 +2727,10 @@ declare class DatabaseApi {
     getDatabaseList(workspace: WorkspaceID): Promise<ListDatabasesResponse>;
     createDatabase(workspace: WorkspaceID, dbName: DBName, options?: CreateDatabaseRequestBody): Promise<CreateDatabaseResponse>;
     deleteDatabase(workspace: WorkspaceID, dbName: DBName): Promise<void>;
+    getGitBranchesMapping(workspace: WorkspaceID, dbName: DBName): Promise<ListGitBranchesResponse>;
+    addGitBranchesEntry(workspace: WorkspaceID, dbName: DBName, body: AddGitBranchesEntryRequestBody): Promise<AddGitBranchesEntryResponse>;
+    removeGitBranchesEntry(workspace: WorkspaceID, dbName: DBName, gitBranch: string): Promise<void>;
+    resolveBranch(workspace: WorkspaceID, dbName: DBName, gitBranch: string): Promise<ResolveBranchResponse>;
 }
 declare class BranchApi {
     private extraProps;
@@ -2575,7 +2792,7 @@ declare type RequiredBy<T, K extends keyof T> = T & {
 };
 declare type GetArrayInnerType<T extends readonly any[]> = T[number];
 declare type SingleOrArray<T> = T | T[];
-declare type Dictionary<T> = Record<string, T>;
+declare type OmitBy<T, K extends keyof T> = T extends any ? Omit<T, K> : never;
 
 declare type SelectableColumn<O, RecursivePath extends any[] = []> = '*' | 'id' | DataProps<O> | NestedColumns<O, RecursivePath>;
 declare type SelectedPick<O extends XataRecord, Key extends SelectableColumn<O>[]> = XataRecord & UnionToIntersection<Values<{
@@ -2770,12 +2987,21 @@ declare type SortFilterBase<T extends XataRecord> = {
     [Key in StringKeys<T>]: SortDirection;
 };
 
-declare type QueryOptions<T extends XataRecord> = {
-    page?: PaginationOptions;
+declare type BaseOptions<T extends XataRecord> = {
     columns?: NonEmptyArray<SelectableColumn<T>>;
+    cache?: number;
+};
+declare type CursorQueryOptions = {
+    pagination?: CursorNavigationOptions & OffsetNavigationOptions;
+    filter?: never;
+    sort?: never;
+};
+declare type OffsetQueryOptions<T extends XataRecord> = {
+    pagination?: OffsetNavigationOptions;
     filter?: FilterExpression;
     sort?: SortFilter<T> | SortFilter<T>[];
 };
+declare type QueryOptions<T extends XataRecord> = BaseOptions<T> & (CursorQueryOptions | OffsetQueryOptions<T>);
 /**
  * Query objects contain the information of all filters, sorting, etc. to be included in the database query.
  *
@@ -2788,6 +3014,7 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
     readonly records: Result[];
     constructor(repository: Repository<Record> | null, table: string, data: Partial<QueryOptions<Record>>, parent?: Partial<QueryOptions<Record>>);
     getQueryOptions(): QueryOptions<Record>;
+    key(): string;
     /**
      * Builds a new query object representing a logical OR between the given subqueries.
      * @param queries An array of subqueries.
@@ -2843,19 +3070,23 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
      */
     select<K extends SelectableColumn<Record>>(columns: NonEmptyArray<K>): Query<Record, SelectedPick<Record, NonEmptyArray<K>>>;
     getPaginated(): Promise<Page<Record, Result>>;
-    getPaginated(options: Omit<QueryOptions<Record>, 'columns'>): Promise<Page<Record, Result>>;
+    getPaginated(options: OmitBy<QueryOptions<Record>, 'columns'>): Promise<Page<Record, Result>>;
     getPaginated<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<Page<Record, SelectedPick<Record, typeof options['columns']>>>;
     [Symbol.asyncIterator](): AsyncIterableIterator<Result>;
-    getIterator(chunk: number): AsyncGenerator<Result[]>;
-    getIterator(chunk: number, options: Omit<QueryOptions<Record>, 'columns' | 'page'>): AsyncGenerator<Result[]>;
-    getIterator<Options extends RequiredBy<Omit<QueryOptions<Record>, 'page'>, 'columns'>>(chunk: number, options: Options): AsyncGenerator<SelectedPick<Record, typeof options['columns']>[]>;
+    getIterator(): AsyncGenerator<Result[]>;
+    getIterator(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'> & {
+        batchSize?: number;
+    }): AsyncGenerator<Result[]>;
+    getIterator<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
+        batchSize?: number;
+    }>(options: Options): AsyncGenerator<SelectedPick<Record, typeof options['columns']>[]>;
     /**
      * Performs the query in the database and returns a set of results.
      * @param options Additional options to be used when performing the query.
      * @returns An array of records from the database.
      */
     getMany(): Promise<Result[]>;
-    getMany(options: Omit<QueryOptions<Record>, 'columns'>): Promise<Result[]>;
+    getMany(options: OmitBy<QueryOptions<Record>, 'columns'>): Promise<Result[]>;
     getMany<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>[]>;
     /**
      * Performs the query in the database and returns all the results.
@@ -2863,17 +3094,27 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
      * @param options Additional options to be used when performing the query.
      * @returns An array of records from the database.
      */
-    getAll(chunk?: number): Promise<Result[]>;
-    getAll(chunk: number | undefined, options: Omit<QueryOptions<Record>, 'columns' | 'page'>): Promise<Result[]>;
-    getAll<Options extends RequiredBy<Omit<QueryOptions<Record>, 'page'>, 'columns'>>(chunk: number | undefined, options: Options): Promise<SelectedPick<Record, typeof options['columns']>[]>;
+    getAll(): Promise<Result[]>;
+    getAll(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'> & {
+        batchSize?: number;
+    }): Promise<Result[]>;
+    getAll<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'> & {
+        batchSize?: number;
+    }>(options: Options): Promise<SelectedPick<Record, typeof options['columns']>[]>;
     /**
      * Performs the query in the database and returns the first result.
      * @param options Additional options to be used when performing the query.
      * @returns The first record that matches the query, or null if no record matched the query.
      */
-    getOne(): Promise<Result | null>;
-    getOne(options: Omit<QueryOptions<Record>, 'columns' | 'page'>): Promise<Result | null>;
-    getOne<Options extends RequiredBy<Omit<QueryOptions<Record>, 'page'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']> | null>;
+    getFirst(): Promise<Result | null>;
+    getFirst(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'>): Promise<Result | null>;
+    getFirst<Options extends RequiredBy<OmitBy<QueryOptions<Record>, 'pagination'>, 'columns'>>(options: Options): Promise<SelectedPick<Record, typeof options['columns']> | null>;
+    /**
+     * Builds a new query object adding a cache TTL in milliseconds.
+     * @param ttl The cache TTL in milliseconds.
+     * @returns A new Query object.
+     */
+    cache(ttl: number): Query<Record, Result>;
     nextPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
     previousPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
     firstPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
@@ -2957,14 +3198,11 @@ declare type OffsetNavigationOptions = {
     size?: number;
     offset?: number;
 };
-declare type PaginationOptions = CursorNavigationOptions & OffsetNavigationOptions;
 declare const PAGINATION_MAX_SIZE = 200;
 declare const PAGINATION_DEFAULT_SIZE = 200;
 declare const PAGINATION_MAX_OFFSET = 800;
 declare const PAGINATION_DEFAULT_OFFSET = 0;
 
-declare type TableLink = string[];
-declare type LinkDictionary = Dictionary<TableLink[]>;
 /**
  * Common interface for performing operations on a table.
  */
@@ -3070,9 +3308,8 @@ declare class RestRepository<Data extends BaseData, Record extends XataRecord =
     db: SchemaPluginResult<any>;
     constructor(options: {
         table: string;
-        links?: LinkDictionary;
-        getFetchProps: () => Promise<FetcherExtraProps>;
         db: SchemaPluginResult<any>;
+        pluginOptions: XataPluginOptions;
     });
     create(object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
     create(recordId: string, object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
@@ -3084,7 +3321,7 @@ declare class RestRepository<Data extends BaseData, Record extends XataRecord =
     createOrUpdate(object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
     createOrUpdate(recordId: string, object: EditableData<Data>): Promise<SelectedPick<Record, ['*']>>;
     createOrUpdate(objects: EditableData<Data>[]): Promise<SelectedPick<Record, ['*']>[]>;
-    delete(recordId: string | Identifiable | Array<string | Identifiable>): Promise<void>;
+    delete(a: string | Identifiable | Array<string | Identifiable>): Promise<void>;
     search(query: string, options?: {
         fuzziness?: number;
     }): Promise<SelectedPick<Record, ['*']>[]>;
@@ -3166,17 +3403,17 @@ declare const includesAny: <T>(value: T) => ArrayFilter<T>;
 
 declare type SchemaDefinition = {
     table: string;
-    links?: LinkDictionary;
 };
 declare type SchemaPluginResult<Schemas extends Record<string, BaseData>> = {
     [Key in keyof Schemas]: Repository<Schemas[Key]>;
+} & {
+    [key: string]: Repository<XataRecord$1>;
 };
 declare class SchemaPlugin<Schemas extends Record<string, BaseData>> extends XataPlugin {
     #private;
-    private links?;
     private tableNames?;
-    constructor(links?: LinkDictionary | undefined, tableNames?: string[] | undefined);
-    build(options: XataPluginOptions): SchemaPluginResult<Schemas>;
+    constructor(tableNames?: string[] | undefined);
+    build(pluginOptions: XataPluginOptions): SchemaPluginResult<Schemas>;
 }
 
 declare type SearchOptions<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>> = {
@@ -3197,8 +3434,7 @@ declare type SearchPluginResult<Schemas extends Record<string, BaseData>> = {
 declare class SearchPlugin<Schemas extends Record<string, BaseData>> extends XataPlugin {
     #private;
     private db;
-    private links;
-    constructor(db: SchemaPluginResult<Schemas>, links: LinkDictionary);
+    constructor(db: SchemaPluginResult<Schemas>);
     build({ getFetchProps }: XataPluginOptions): SearchPluginResult<Schemas>;
 }
 declare type SearchXataRecord = XataRecord & {
@@ -3217,10 +3453,11 @@ declare type BaseClientOptions = {
     apiKey?: string;
     databaseURL?: string;
     branch?: BranchStrategyOption;
+    cache?: CacheImpl;
 };
 declare const buildClient: <Plugins extends Record<string, XataPlugin> = {}>(plugins?: Plugins | undefined) => ClientConstructor<Plugins>;
 interface ClientConstructor<Plugins extends Record<string, XataPlugin>> {
-    new <Schemas extends Record<string, BaseData>>(options?: Partial<BaseClientOptions>, links?: LinkDictionary): Omit<{
+    new <Schemas extends Record<string, BaseData> = {}>(options?: Partial<BaseClientOptions>, tables?: string[]): Omit<{
         db: Awaited<ReturnType<SchemaPlugin<Schemas>['build']>>;
         search: Awaited<ReturnType<SearchPlugin<Schemas>['build']>>;
     }, keyof Plugins> & {
@@ -3247,4 +3484,4 @@ declare class XataError extends Error {
     constructor(message: string, status: number);
 }
 
-export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, BaseClient, BaseClientOptions, BaseData, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsResponse, BulkInsertTableRecordsVariables, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, CreateBranchError, CreateBranchPathParams, CreateBranchQueryParams, CreateBranchRequestBody, CreateBranchVariables, CreateDatabaseError, CreateDatabasePathParams, CreateDatabaseRequestBody, CreateDatabaseResponse, CreateDatabaseVariables, CreateTableError, CreateTablePathParams, CreateTableVariables, CreateUserAPIKeyError, CreateUserAPIKeyPathParams, CreateUserAPIKeyResponse, CreateUserAPIKeyVariables, CreateWorkspaceError, CreateWorkspaceVariables, CursorNavigationOptions, DeleteBranchError, DeleteBranchPathParams, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabasePathParams, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, FetcherExtraProps, GetBranchDetailsError, GetBranchDetailsPathParams, GetBranchDetailsVariables, GetBranchListError, GetBranchListPathParams, GetBranchListVariables, GetBranchMetadataError, GetBranchMetadataPathParams, GetBranchMetadataVariables, GetBranchMigrationHistoryError, GetBranchMigrationHistoryPathParams, GetBranchMigrationHistoryRequestBody, GetBranchMigrationHistoryResponse, GetBranchMigrationHistoryVariables, GetBranchMigrationPlanError, GetBranchMigrationPlanPathParams, GetBranchMigrationPlanVariables, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, GetDatabaseListError, GetDatabaseListPathParams, GetDatabaseListVariables, GetRecordError, GetRecordPathParams, GetRecordRequestBody, GetRecordVariables, GetTableColumnsError, GetTableColumnsPathParams, GetTableColumnsResponse, GetTableColumnsVariables, GetTableSchemaError, GetTableSchemaPathParams, GetTableSchemaResponse, GetTableSchemaVariables, GetUserAPIKeysError, GetUserAPIKeysResponse, GetUserAPIKeysVariables, GetUserError, GetUserVariables, GetWorkspaceError, GetWorkspaceMembersListError, GetWorkspaceMembersListPathParams, GetWorkspaceMembersListVariables, GetWorkspacePathParams, GetWorkspaceVariables, GetWorkspacesListError, GetWorkspacesListResponse, GetWorkspacesListVariables, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordResponse, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, LinkDictionary, OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Paginable, PaginationOptions, PaginationQueryMeta, Query, QueryTableError, QueryTablePathParams, QueryTableRequestBody, QueryTableVariables, RemoveWorkspaceMemberError, RemoveWorkspaceMemberPathParams, RemoveWorkspaceMemberVariables, Repository, ResendWorkspaceMemberInviteError, ResendWorkspaceMemberInvitePathParams, ResendWorkspaceMemberInviteVariables, responses as Responses, RestRepository, SchemaDefinition, SchemaPlugin, SchemaPluginResult, schemas as Schemas, SearchBranchError, SearchBranchPathParams, SearchBranchRequestBody, SearchBranchVariables, SearchOptions, SearchPlugin, SearchPluginResult, SelectableColumn, SelectedPick, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, UpdateRecordWithIDError, UpdateRecordWithIDPathParams, UpdateRecordWithIDQueryParams, UpdateRecordWithIDVariables, UpdateTableError, UpdateTablePathParams, UpdateTableRequestBody, UpdateTableVariables, UpdateUserError, UpdateUserVariables, UpdateWorkspaceError, UpdateWorkspaceMemberRoleError, UpdateWorkspaceMemberRolePathParams, UpdateWorkspaceMemberRoleRequestBody, UpdateWorkspaceMemberRoleVariables, UpdateWorkspacePathParams, UpdateWorkspaceVariables, UpsertRecordWithIDError, UpsertRecordWithIDPathParams, UpsertRecordWithIDQueryParams, UpsertRecordWithIDVariables, ValueAtColumn, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addTableColumn, buildClient, bulkInsertTableRecords, cancelWorkspaceMemberInvite, contains, createBranch, createDatabase, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, endsWith, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseList, getDatabaseURL, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isIdentifiable, isNot, isXataRecord, le, lt, lte, notExists, operationsByTag, pattern, queryTable, removeWorkspaceMember, resendWorkspaceMemberInvite, searchBranch, setTableSchema, startsWith, updateBranchMetadata, updateColumn, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberRole, upsertRecordWithID };
+export { AcceptWorkspaceMemberInviteError, AcceptWorkspaceMemberInvitePathParams, AcceptWorkspaceMemberInviteVariables, AddGitBranchesEntryError, AddGitBranchesEntryPathParams, AddGitBranchesEntryRequestBody, AddGitBranchesEntryResponse, AddGitBranchesEntryVariables, AddTableColumnError, AddTableColumnPathParams, AddTableColumnVariables, BaseClient, BaseClientOptions, BaseData, BulkInsertTableRecordsError, BulkInsertTableRecordsPathParams, BulkInsertTableRecordsRequestBody, BulkInsertTableRecordsResponse, BulkInsertTableRecordsVariables, CacheImpl, CancelWorkspaceMemberInviteError, CancelWorkspaceMemberInvitePathParams, CancelWorkspaceMemberInviteVariables, ClientConstructor, CreateBranchError, CreateBranchPathParams, CreateBranchQueryParams, CreateBranchRequestBody, CreateBranchVariables, CreateDatabaseError, CreateDatabasePathParams, CreateDatabaseRequestBody, CreateDatabaseResponse, CreateDatabaseVariables, CreateTableError, CreateTablePathParams, CreateTableVariables, CreateUserAPIKeyError, CreateUserAPIKeyPathParams, CreateUserAPIKeyResponse, CreateUserAPIKeyVariables, CreateWorkspaceError, CreateWorkspaceVariables, CursorNavigationOptions, DeleteBranchError, DeleteBranchPathParams, DeleteBranchVariables, DeleteColumnError, DeleteColumnPathParams, DeleteColumnVariables, DeleteDatabaseError, DeleteDatabasePathParams, DeleteDatabaseVariables, DeleteRecordError, DeleteRecordPathParams, DeleteRecordVariables, DeleteTableError, DeleteTablePathParams, DeleteTableVariables, DeleteUserAPIKeyError, DeleteUserAPIKeyPathParams, DeleteUserAPIKeyVariables, DeleteUserError, DeleteUserVariables, DeleteWorkspaceError, DeleteWorkspacePathParams, DeleteWorkspaceVariables, EditableData, ExecuteBranchMigrationPlanError, ExecuteBranchMigrationPlanPathParams, ExecuteBranchMigrationPlanRequestBody, ExecuteBranchMigrationPlanVariables, FetchImpl, FetcherExtraProps, GetBranchDetailsError, GetBranchDetailsPathParams, GetBranchDetailsVariables, GetBranchListError, GetBranchListPathParams, GetBranchListVariables, GetBranchMetadataError, GetBranchMetadataPathParams, GetBranchMetadataVariables, GetBranchMigrationHistoryError, GetBranchMigrationHistoryPathParams, GetBranchMigrationHistoryRequestBody, GetBranchMigrationHistoryResponse, GetBranchMigrationHistoryVariables, GetBranchMigrationPlanError, GetBranchMigrationPlanPathParams, GetBranchMigrationPlanVariables, GetBranchStatsError, GetBranchStatsPathParams, GetBranchStatsResponse, GetBranchStatsVariables, GetColumnError, GetColumnPathParams, GetColumnVariables, GetDatabaseListError, GetDatabaseListPathParams, GetDatabaseListVariables, GetGitBranchesMappingError, GetGitBranchesMappingPathParams, GetGitBranchesMappingVariables, GetRecordError, GetRecordPathParams, GetRecordRequestBody, GetRecordVariables, GetTableColumnsError, GetTableColumnsPathParams, GetTableColumnsResponse, GetTableColumnsVariables, GetTableSchemaError, GetTableSchemaPathParams, GetTableSchemaResponse, GetTableSchemaVariables, GetUserAPIKeysError, GetUserAPIKeysResponse, GetUserAPIKeysVariables, GetUserError, GetUserVariables, GetWorkspaceError, GetWorkspaceMembersListError, GetWorkspaceMembersListPathParams, GetWorkspaceMembersListVariables, GetWorkspacePathParams, GetWorkspaceVariables, GetWorkspacesListError, GetWorkspacesListResponse, GetWorkspacesListVariables, Identifiable, InsertRecordError, InsertRecordPathParams, InsertRecordResponse, InsertRecordVariables, InsertRecordWithIDError, InsertRecordWithIDPathParams, InsertRecordWithIDQueryParams, InsertRecordWithIDVariables, InviteWorkspaceMemberError, InviteWorkspaceMemberPathParams, InviteWorkspaceMemberRequestBody, InviteWorkspaceMemberVariables, OffsetNavigationOptions, operationsByTag as Operations, PAGINATION_DEFAULT_OFFSET, PAGINATION_DEFAULT_SIZE, PAGINATION_MAX_OFFSET, PAGINATION_MAX_SIZE, Page, Paginable, PaginationQueryMeta, Query, QueryTableError, QueryTablePathParams, QueryTableRequestBody, QueryTableVariables, RemoveGitBranchesEntryError, RemoveGitBranchesEntryPathParams, RemoveGitBranchesEntryQueryParams, RemoveGitBranchesEntryVariables, RemoveWorkspaceMemberError, RemoveWorkspaceMemberPathParams, RemoveWorkspaceMemberVariables, Repository, ResendWorkspaceMemberInviteError, ResendWorkspaceMemberInvitePathParams, ResendWorkspaceMemberInviteVariables, ResolveBranchError, ResolveBranchPathParams, ResolveBranchQueryParams, ResolveBranchResponse, ResolveBranchVariables, responses as Responses, RestRepository, SchemaDefinition, SchemaPlugin, SchemaPluginResult, schemas as Schemas, SearchBranchError, SearchBranchPathParams, SearchBranchRequestBody, SearchBranchVariables, SearchOptions, SearchPlugin, SearchPluginResult, SelectableColumn, SelectedPick, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, UpdateRecordWithIDError, UpdateRecordWithIDPathParams, UpdateRecordWithIDQueryParams, UpdateRecordWithIDVariables, UpdateTableError, UpdateTablePathParams, UpdateTableRequestBody, UpdateTableVariables, UpdateUserError, UpdateUserVariables, UpdateWorkspaceError, UpdateWorkspaceMemberRoleError, UpdateWorkspaceMemberRolePathParams, UpdateWorkspaceMemberRoleRequestBody, UpdateWorkspaceMemberRoleVariables, UpdateWorkspacePathParams, UpdateWorkspaceVariables, UpsertRecordWithIDError, UpsertRecordWithIDPathParams, UpsertRecordWithIDQueryParams, UpsertRecordWithIDVariables, ValueAtColumn, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, buildClient, bulkInsertTableRecords, cancelWorkspaceMemberInvite, contains, createBranch, createDatabase, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, endsWith, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseList, getDatabaseURL, getGitBranchesMapping, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isIdentifiable, isNot, isXataRecord, le, lt, lte, notExists, operationsByTag, pattern, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, setTableSchema, startsWith, updateBranchMetadata, updateColumn, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberRole, upsertRecordWithID };