@xata.io/client 0.0.0-alpha.vf38f30b → 0.0.0-alpha.vf6c3bd7

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;
     };
@@ -234,6 +268,17 @@ declare type SortExpression = string[] | {
     [key: string]: SortOrder;
 }[];
 declare type SortOrder = 'asc' | 'desc';
+/**
+ * Maximum [Levenshtein distance](https://en.wikipedia.org/wiki/Levenshtein_distance) for the search terms. The Levenshtein
+ * distance is the number of one charcter changes needed to make two strings equal. The default is 1, meaning that single
+ * character typos per word are tollerated by search. You can set it to 0 to remove the typo tollerance or set it to 2
+ * to allow two typos in a word.
+ *
+ * @default 1
+ * @maximum 2
+ * @minimum 0
+ */
+declare type FuzzinessExpression = number;
 /**
  * @minProperties 1
  */
@@ -247,6 +292,10 @@ declare type FilterExpression = {
 } & {
     [key: string]: FilterColumn;
 };
+declare type HighlightExpression = {
+    enabled?: boolean;
+    encodeHTML?: boolean;
+};
 declare type FilterList = FilterExpression | FilterExpression[];
 declare type FilterColumn = FilterColumnIncludes | FilterPredicate | FilterList;
 /**
@@ -332,6 +381,11 @@ declare type XataRecord$1 = {
     xata: {
         version: number;
         table?: string;
+        highlight?: {
+            [key: string]: string[] | {
+                [key: string]: any;
+            };
+        };
         warnings?: string[];
     };
 } & {
@@ -354,6 +408,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;
@@ -374,7 +429,9 @@ type schemas_TableMigration = TableMigration;
 type schemas_ColumnMigration = ColumnMigration;
 type schemas_SortExpression = SortExpression;
 type schemas_SortOrder = SortOrder;
+type schemas_FuzzinessExpression = FuzzinessExpression;
 type schemas_FilterExpression = FilterExpression;
+type schemas_HighlightExpression = HighlightExpression;
 type schemas_FilterList = FilterList;
 type schemas_FilterColumn = FilterColumn;
 type schemas_FilterColumnIncludes = FilterColumnIncludes;
@@ -406,6 +463,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,
@@ -426,7 +484,9 @@ declare namespace schemas {
     schemas_ColumnMigration as ColumnMigration,
     schemas_SortExpression as SortExpression,
     schemas_SortOrder as SortOrder,
+    schemas_FuzzinessExpression as FuzzinessExpression,
     schemas_FilterExpression as FilterExpression,
+    schemas_HighlightExpression as HighlightExpression,
     schemas_FilterList as FilterList,
     schemas_FilterColumn as FilterColumn,
     schemas_FilterColumnIncludes as FilterColumnIncludes,
@@ -982,6 +1042,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 +1483,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 +1893,7 @@ declare type QueryTableVariables = {
  * {
  *   "columns": [...],
  *   "filter": {
- *     "$all": [...]
+ *     "$all": [...],
  *     "$any": [...]
  *     ...
  *   },
@@ -1721,7 +1939,11 @@ declare type QueryTableVariables = {
  *           "link": {
  *             "table": "users"
  *           }
- *         }
+ *         },
+ *         {
+ *           "name": "foundedDate",
+ *           "type": "datetime"
+ *         },
  *       ]
  *     },
  *     {
@@ -1809,7 +2031,7 @@ declare type QueryTableVariables = {
  * {
  *   "name": "Kilian",
  *   "address": {
- *     "street": "New street",
+ *     "street": "New street"
  *   }
  * }
  * ```
@@ -1818,10 +2040,7 @@ declare type QueryTableVariables = {
  *
  * ```json
  * {
- *   "columns": [
- *     "*",
- *     "team.name"
- *   ]
+ *   "columns": ["*", "team.name"]
  * }
  * ```
  *
@@ -1839,7 +2058,7 @@ declare type QueryTableVariables = {
  *   "team": {
  *     "id": "XX",
  *     "xata": {
- *       "version": 0,
+ *       "version": 0
  *     },
  *     "name": "first team"
  *   }
@@ -1850,10 +2069,7 @@ declare type QueryTableVariables = {
  *
  * ```json
  * {
- *   "columns": [
- *     "*",
- *     "team.*"
- *   ]
+ *   "columns": ["*", "team.*"]
  * }
  * ```
  *
@@ -1871,10 +2087,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 +2106,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 +2137,7 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *       "name": "r2",
+ *     "name": "r2"
  *   }
  * }
  * ```
@@ -1942,7 +2159,7 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *       "settings.plan": "free",
+ *     "settings.plan": "free"
  *   }
  * }
  * ```
@@ -1952,8 +2169,8 @@ declare type QueryTableVariables = {
  *   "filter": {
  *     "settings": {
  *       "plan": "free"
- *     },
- *   },
+ *     }
+ *   }
  * }
  * ```
  *
@@ -1962,8 +2179,8 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *     "settings.plan": {"$any": ["free", "paid"]}
- *   },
+ *     "settings.plan": { "$any": ["free", "paid"] }
+ *   }
  * }
  * ```
  *
@@ -1972,9 +2189,9 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *       "settings.dark": true,
- *       "settings.plan": "free",
- *   },
+ *     "settings.dark": true,
+ *     "settings.plan": "free"
+ *   }
  * }
  * ```
  *
@@ -1985,11 +2202,11 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *       "$any": {
- *         "settings.dark": true,
- *         "settings.plan": "free"
- *       }
- *   },
+ *     "$any": {
+ *       "settings.dark": true,
+ *       "settings.plan": "free"
+ *     }
+ *   }
  * }
  * ```
  *
@@ -2000,10 +2217,10 @@ declare type QueryTableVariables = {
  *   "filter": {
  *     "$any": [
  *       {
- *         "name": "r1",
+ *         "name": "r1"
  *       },
  *       {
- *         "name": "r2",
+ *         "name": "r2"
  *       }
  *     ]
  *   }
@@ -2015,7 +2232,7 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *     "$exists": "settings",
+ *     "$exists": "settings"
  *   }
  * }
  * ```
@@ -2027,10 +2244,10 @@ declare type QueryTableVariables = {
  *   "filter": {
  *     "$all": [
  *       {
- *         "$exists": "settings",
+ *         "$exists": "settings"
  *       },
  *       {
- *         "$exists": "name",
+ *         "$exists": "name"
  *       }
  *     ]
  *   }
@@ -2042,7 +2259,7 @@ declare type QueryTableVariables = {
  * ```json
  * {
  *   "filter": {
- *     "$notExists": "settings",
+ *     "$notExists": "settings"
  *   }
  * }
  * ```
@@ -2069,43 +2286,59 @@ declare type QueryTableVariables = {
  * {
  *   "filter": {
  *     "<column_name>": {
- *         "$pattern": "v*alue*"
+ *       "$pattern": "v*alu?"
  *     }
  *   }
  * }
  * ```
  *
+ * The `$pattern` operator accepts two wildcard characters:
+ * * `*` matches zero or more characters
+ * * `?` matches exactly one character
+ *
+ * If you want to match a string that contains a wildcard character, you can escape them using a backslash (`\`). You can escape a backslash by usign another backslash.
+ *
  * We could also have `$endsWith` and `$startsWith` operators:
  *
  * ```json
  * {
  *   "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 +2363,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 +2432,8 @@ declare type QueryTableVariables = {
  *     "<array name>": {
  *       "$includes": {
  *         "$all": [
- *           {"$contains": "label"},
- *           {"$not": {"$endsWith": "-debug"}}
+ *           { "$contains": "label" },
+ *           { "$not": { "$endsWith": "-debug" } }
  *         ]
  *       }
  *     }
@@ -2214,9 +2453,7 @@ declare type QueryTableVariables = {
  * {
  *   "filter": {
  *     "settings.labels": {
- *       "$includesAll": [
- *         {"$contains": "label"},
- *       ]
+ *       "$includesAll": [{ "$contains": "label" }]
  *     }
  *   }
  * }
@@ -2264,7 +2501,6 @@ declare type QueryTableVariables = {
  * }
  * ```
  *
- *
  * ### Pagination
  *
  * We offer cursor pagination and offset pagination. The offset pagination is limited
@@ -2330,8 +2566,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.
  *
@@ -2368,6 +2604,39 @@ declare type QueryTableVariables = {
  * ```
  */
 declare const queryTable: (variables: QueryTableVariables) => Promise<QueryResponse>;
+declare type SearchTablePathParams = {
+    dbBranchName: DBBranchName;
+    tableName: TableName;
+    workspace: string;
+};
+declare type SearchTableError = ErrorWrapper<{
+    status: 400;
+    payload: BadRequestError;
+} | {
+    status: 401;
+    payload: AuthError;
+} | {
+    status: 404;
+    payload: SimpleError;
+}>;
+declare type SearchTableRequestBody = {
+    query: string;
+    fuzziness?: FuzzinessExpression;
+    filter?: FilterExpression;
+    highlight?: HighlightExpression;
+};
+declare type SearchTableVariables = {
+    body: SearchTableRequestBody;
+    pathParams: SearchTablePathParams;
+} & FetcherExtraProps;
+/**
+ * Run a free text search operation in a particular table.
+ *
+ * The endpoint accepts a `query` parameter that is used for the free text search and a set of structured filters (via the `filter` parameter) that are applied before the search. The `filter` parameter uses the same syntax as the [query endpoint](/api-reference/db/db_branch_name/tables/table_name/) with the following exceptions:
+ * * filters `$contains`, `$startsWith`, `$endsWith` don't work on columns of type `text`
+ * * filtering on columns of type `multiple` is currently unsupported
+ */
+declare const searchTable: (variables: SearchTableVariables) => Promise<SearchResponse>;
 declare type SearchBranchPathParams = {
     dbBranchName: DBBranchName;
     workspace: string;
@@ -2383,9 +2652,13 @@ declare type SearchBranchError = ErrorWrapper<{
     payload: SimpleError;
 }>;
 declare type SearchBranchRequestBody = {
-    tables?: string[];
+    tables?: (string | {
+        table: string;
+        filter?: FilterExpression;
+    })[];
     query: string;
-    fuzziness?: number;
+    fuzziness?: FuzzinessExpression;
+    highlight?: HighlightExpression;
 };
 declare type SearchBranchVariables = {
     body: SearchBranchRequestBody;
@@ -2422,6 +2695,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>;
@@ -2456,6 +2733,7 @@ declare const operationsByTag: {
         getRecord: (variables: GetRecordVariables) => Promise<XataRecord$1>;
         bulkInsertTableRecords: (variables: BulkInsertTableRecordsVariables) => Promise<BulkInsertTableRecordsResponse>;
         queryTable: (variables: QueryTableVariables) => Promise<QueryResponse>;
+        searchTable: (variables: SearchTableVariables) => Promise<SearchResponse>;
         searchBranch: (variables: SearchBranchVariables) => Promise<SearchResponse>;
     };
 };
@@ -2472,6 +2750,9 @@ interface XataApiClientOptions {
     apiKey?: string;
     host?: HostProvider;
 }
+/**
+ * @deprecated Use XataApiPlugin instead
+ */
 declare class XataApiClient {
     #private;
     constructor(options?: XataApiClientOptions);
@@ -2514,6 +2795,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;
@@ -2554,6 +2839,7 @@ declare class RecordsApi {
     getRecord(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, recordId: RecordID, options?: GetRecordRequestBody): Promise<XataRecord$1>;
     bulkInsertTableRecords(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, records: Record<string, any>[]): Promise<BulkInsertTableRecordsResponse>;
     queryTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, query: QueryTableRequestBody): Promise<QueryResponse>;
+    searchTable(workspace: WorkspaceID, database: DBName, branch: BranchName, tableName: TableName, query: SearchTableRequestBody): Promise<SearchResponse>;
     searchBranch(workspace: WorkspaceID, database: DBName, branch: BranchName, query: SearchBranchRequestBody): Promise<SearchResponse>;
 }
 
@@ -2575,30 +2861,31 @@ 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<{
     [K in Key[number]]: NestedValueAtColumn<O, K> & XataRecord;
 }>>;
-declare type ValueAtColumn<O, P extends SelectableColumn<O>> = P extends '*' ? Values<O> : P extends 'id' ? string : P extends keyof O ? O[P] : P extends `${infer K}.${infer V}` ? K extends keyof O ? Values<O[K] extends XataRecord ? (V extends SelectableColumn<O[K]> ? {
-    V: ValueAtColumn<O[K], V>;
-} : never) : O[K]> : never : never;
+declare type ValueAtColumn<O, P extends SelectableColumn<O>> = P extends '*' ? Values<O> : P extends 'id' ? string : P extends keyof O ? O[P] : P extends `${infer K}.${infer V}` ? K extends keyof O ? Values<RemoveNullable<O[K]> extends Record<string, any> ? V extends SelectableColumn<RemoveNullable<O[K]>> ? {
+    V: ValueAtColumn<RemoveNullable<O[K]>, V>;
+} : never : O[K]> : never : never;
 declare type MAX_RECURSION = 5;
 declare type NestedColumns<O, RecursivePath extends any[]> = RecursivePath['length'] extends MAX_RECURSION ? never : If<IsObject<O>, Values<{
-    [K in DataProps<O>]: If<IsArray<NonNullable<O[K]>>, K, // If the property is an array, we stop recursion. We don't support object arrays yet
-    If<IsObject<NonNullable<O[K]>>, NonNullable<O[K]> extends XataRecord ? SelectableColumn<NonNullable<O[K]>, [...RecursivePath, O[K]]> extends string ? K | `${K}.${SelectableColumn<NonNullable<O[K]>, [...RecursivePath, O[K]]>}` : never : `${K}.${StringKeys<NonNullable<O[K]>> | '*'}`, // This allows usage of objects that are not links
+    [K in DataProps<O>]: If<IsArray<RemoveNullable<O[K]>>, K, // If the property is an array, we stop recursion. We don't support object arrays yet
+    If<IsObject<RemoveNullable<O[K]>>, RemoveNullable<O[K]> extends XataRecord ? SelectableColumn<RemoveNullable<O[K]>, [...RecursivePath, O[K]]> extends string ? K | `${K}.${SelectableColumn<RemoveNullable<O[K]>, [...RecursivePath, O[K]]>}` : never : `${K}.${StringKeys<RemoveNullable<O[K]>> | '*'}`, // This allows usage of objects that are not links
     K>>;
 }>, never>;
 declare type DataProps<O> = Exclude<StringKeys<O>, StringKeys<XataRecord>>;
 declare type NestedValueAtColumn<O, Key extends SelectableColumn<O>> = Key extends `${infer N}.${infer M}` ? N extends DataProps<O> ? {
-    [K in N]: M extends SelectableColumn<NonNullable<O[K]>> ? NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], NestedValueAtColumn<NonNullable<O[K]>, M> & XataRecord> : ForwardNullable<O[K], NestedValueAtColumn<NonNullable<O[K]>, M>> : unknown;
+    [K in N]: M extends SelectableColumn<RemoveNullable<O[K]>> ? RemoveNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], NestedValueAtColumn<RemoveNullable<O[K]>, M> & XataRecord> : ForwardNullable<O[K], NestedValueAtColumn<RemoveNullable<O[K]>, M>> : unknown;
 } : unknown : Key extends DataProps<O> ? {
-    [K in Key]: NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], SelectedPick<NonNullable<O[K]>, ['*']>> : O[K];
+    [K in Key]: RemoveNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], SelectedPick<RemoveNullable<O[K]>, ['*']>> : O[K];
 } : Key extends '*' ? {
-    [K in StringKeys<O>]: NonNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], Link<NonNullable<O[K]>>> : O[K];
+    [K in StringKeys<O>]: RemoveNullable<O[K]> extends XataRecord ? ForwardNullable<O[K], Link<RemoveNullable<O[K]>>> : O[K];
 } : unknown;
-declare type ForwardNullable<T, R> = T extends NonNullable<T> ? R : R | null;
+declare type RemoveNullable<T> = T extends null | undefined ? never : T;
+declare type ForwardNullable<T, R> = T extends RemoveNullable<T> ? R : R | null;
 
 /**
  * Represents an identifiable record from the database.
@@ -2739,8 +3026,8 @@ declare type ValueTypeFilters<T> = T | T extends string ? StringTypeFilter : T e
     ],
 }
 */
-declare type AggregatorFilter<Record> = {
-    [key in '$all' | '$any' | '$not' | '$none']?: SingleOrArray<Filter<Record>>;
+declare type AggregatorFilter<T> = {
+    [key in '$all' | '$any' | '$not' | '$none']?: SingleOrArray<Filter<T>>;
 };
 /**
  * Existance filter
@@ -2755,10 +3042,10 @@ declare type BaseApiFilter<Record> = PropertyAccessFilter<Record> | AggregatorFi
  * Injects the Api filters on nested properties
  * Example: { filter: { settings: { plan: { $any: ['free', 'trial'] } } } }
  */
-declare type NestedApiFilter<T> = T extends Record<string, any> ? {
+declare type NestedApiFilter<T> = {
     [key in keyof T]?: T[key] extends Record<string, any> ? SingleOrArray<Filter<T[key]>> : PropertyFilter<T[key]>;
-} : PropertyFilter<T>;
-declare type Filter<Record> = BaseApiFilter<Record> | NestedApiFilter<Record>;
+};
+declare type Filter<T> = T extends Record<string, any> ? BaseApiFilter<T> | NestedApiFilter<T> : PropertyFilter<T>;
 
 declare type SortDirection = 'asc' | 'desc';
 declare type SortFilterExtended<T extends XataRecord> = {
@@ -2770,12 +3057,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.
  *
@@ -2786,8 +3082,9 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
     #private;
     readonly meta: PaginationQueryMeta;
     readonly records: Result[];
-    constructor(repository: Repository<Record> | null, table: string, data: Partial<QueryOptions<Record>>, parent?: Partial<QueryOptions<Record>>);
+    constructor(repository: Repository<Record> | null, table: string, data: Partial<QueryOptions<Record>>, rawParent?: 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.
@@ -2817,18 +3114,28 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
      *
      * ```
      * query.filter("columnName", columnValue)
-     * query.filter({
-     *   "columnName": columnValue
-     * })
+     * query.filter("columnName", operator(columnValue)) // Use gt, gte, lt, lte, startsWith,...
+     * ```
+     *
+     * @param column The name of the column to filter.
+     * @param value The value to filter.
+     * @returns A new Query object.
+     */
+    filter<F extends SelectableColumn<Record>>(column: F, value: Filter<ValueAtColumn<Record, F>>): Query<Record, Result>;
+    /**
+     * Builds a new query object adding one or more constraints. Examples:
+     *
+     * ```
+     * query.filter({ "columnName": columnValue })
      * query.filter({
      *   "columnName": operator(columnValue) // Use gt, gte, lt, lte, startsWith,...
      * })
      * ```
      *
+     * @param filters A filter object
      * @returns A new Query object.
      */
     filter(filters: Filter<Record>): Query<Record, Result>;
-    filter<F extends SelectableColumn<Record>>(column: F, value: Filter<ValueAtColumn<Record, F>>): Query<Record, Result>;
     /**
      * Builds a new query with a new sort option.
      * @param column The column name.
@@ -2842,42 +3149,148 @@ declare class Query<Record extends XataRecord, Result extends XataRecord = Recor
      * @returns A new Query object.
      */
     select<K extends SelectableColumn<Record>>(columns: NonEmptyArray<K>): Query<Record, SelectedPick<Record, NonEmptyArray<K>>>;
+    /**
+     * Get paginated results
+     *
+     * @returns A page of results
+     */
     getPaginated(): Promise<Page<Record, Result>>;
-    getPaginated(options: Omit<QueryOptions<Record>, 'columns'>): Promise<Page<Record, Result>>;
+    /**
+     * Get paginated results
+     *
+     * @param options Pagination options
+     * @returns A page of results
+     */
+    getPaginated(options: OmitBy<QueryOptions<Record>, 'columns'>): Promise<Page<Record, Result>>;
+    /**
+     * Get paginated results
+     *
+     * @param options Pagination options
+     * @returns A page of results
+     */
     getPaginated<Options extends RequiredBy<QueryOptions<Record>, 'columns'>>(options: Options): Promise<Page<Record, SelectedPick<Record, typeof options['columns']>>>;
+    /**
+     * Get results in an iterator
+     *
+     * @async
+     * @returns Async interable of results
+     */
     [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']>[]>;
+    /**
+     * Build an iterator of results
+     *
+     * @returns Async generator of results array
+     */
+    getIterator(): AsyncGenerator<Result[]>;
+    /**
+     * Build an iterator of results
+     *
+     * @param options Pagination options with batchSize
+     * @returns Async generator of results array
+     */
+    getIterator(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'> & {
+        batchSize?: number;
+    }): AsyncGenerator<Result[]>;
+    /**
+     * Build an iterator of results
+     *
+     * @param options Pagination options with batchSize
+     * @returns Async generator of results array
+     */
+    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[]>;
+    /**
+     * 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(options: OmitBy<QueryOptions<Record>, 'columns'>): Promise<Result[]>;
+    /**
+     * 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<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.
+     * Warning: If there are a large number of results, this method can have performance implications.
+     * @returns An array of records from the database.
+     */
+    getAll(): Promise<Result[]>;
+    /**
+     * Performs the query in the database and returns all the results.
+     * Warning: If there are a large number of results, this method can have performance implications.
+     * @param options Additional options to be used when performing the query.
+     * @returns An array of records from the database.
+     */
+    getAll(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'> & {
+        batchSize?: number;
+    }): Promise<Result[]>;
     /**
      * Performs the query in the database and returns all the results.
      * Warning: If there are a large number of results, this method can have performance implications.
      * @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<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.
+     * @returns The first record that matches the query, or null if no record matched the query.
+     */
+    getFirst(): Promise<Result | null>;
     /**
      * 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(options: OmitBy<QueryOptions<Record>, 'columns' | 'pagination'>): Promise<Result | null>;
+    /**
+     * 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.
+     */
+    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>;
+    /**
+     * Retrieve next page of records
+     *
+     * @returns A new page object.
+     */
     nextPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
+    /**
+     * Retrieve previous page of records
+     *
+     * @returns A new page object
+     */
     previousPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
+    /**
+     * Retrieve first page of records
+     *
+     * @returns A new page object
+     */
     firstPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
+    /**
+     * Retrieve last page of records
+     *
+     * @returns A new page object
+     */
     lastPage(size?: number, offset?: number): Promise<Page<Record, Result>>;
+    /**
+     * @returns Boolean indicating if there is a next page
+     */
     hasNextPage(): boolean;
 }
 
@@ -2957,14 +3370,12 @@ 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 function isCursorPaginationOptions(options: Record<string, unknown> | undefined | null): options is CursorNavigationOptions;
 
-declare type TableLink = string[];
-declare type LinkDictionary = Dictionary<TableLink[]>;
 /**
  * Common interface for performing operations on a table.
  */
@@ -2989,6 +3400,12 @@ declare abstract class Repository<Data extends BaseData, Record extends XataReco
      * @returns The persisted record for the given id or null if the record could not be found.
      */
     abstract read(id: string): Promise<Readonly<SelectedPick<Record, ['*']> | null>>;
+    /**
+     * Queries multiple records from the table given their unique id.
+     * @param ids The unique ids array.
+     * @returns The persisted records for the given ids (if a record could not be found it is not returned).
+     */
+    abstract read(ids: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
     /**
      * Partially update a single record.
      * @param object An object with its id and the columns to be updated.
@@ -3061,7 +3478,9 @@ declare abstract class Repository<Data extends BaseData, Record extends XataReco
      * @returns The found records.
      */
     abstract search(query: string, options?: {
-        fuzziness?: number;
+        fuzziness?: FuzzinessExpression;
+        highlight?: HighlightExpression;
+        filter?: Filter<Record>;
     }): Promise<SelectedPick<Record, ['*']>[]>;
     abstract query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
 }
@@ -3070,23 +3489,25 @@ 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, ['*']>>;
     create(objects: EditableData<Data>[]): Promise<SelectedPick<Record, ['*']>[]>;
     read(recordId: string): Promise<SelectedPick<Record, ['*']> | null>;
+    read(recordIds: string[]): Promise<Array<Readonly<SelectedPick<Record, ['*']>>>>;
     update(object: Partial<EditableData<Data>> & Identifiable): Promise<SelectedPick<Record, ['*']>>;
     update(recordId: string, object: Partial<EditableData<Data>>): Promise<SelectedPick<Record, ['*']>>;
     update(objects: Array<Partial<EditableData<Data>> & Identifiable>): Promise<SelectedPick<Record, ['*']>[]>;
     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;
+        fuzziness?: FuzzinessExpression;
+        highlight?: HighlightExpression;
+        filter?: Filter<Record>;
     }): Promise<SelectedPick<Record, ['*']>[]>;
     query<Result extends XataRecord>(query: Query<Record, Result>): Promise<Page<Record, Result>>;
 }
@@ -3166,46 +3587,60 @@ 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>> = {
-    fuzziness?: number;
-    tables?: Tables[];
+    fuzziness?: FuzzinessExpression;
+    highlight?: HighlightExpression;
+    tables?: Array<Tables | Values<{
+        [Model in GetArrayInnerType<NonNullable<Tables[]>>]: {
+            table: Model;
+            filter?: Filter<SelectedPick<Schemas[Model] & SearchXataRecord, ['*']>>;
+        };
+    }>>;
 };
 declare type SearchPluginResult<Schemas extends Record<string, BaseData>> = {
     all: <Tables extends StringKeys<Schemas>>(query: string, options?: SearchOptions<Schemas, Tables>) => Promise<Values<{
-        [Model in GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>]: {
+        [Model in ExtractTables<Schemas, Tables, GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>>]: {
             table: Model;
             record: Awaited<SelectedPick<Schemas[Model] & SearchXataRecord, ['*']>>;
         };
     }>[]>;
     byTable: <Tables extends StringKeys<Schemas>>(query: string, options?: SearchOptions<Schemas, Tables>) => Promise<{
-        [Model in GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>]?: Awaited<SelectedPick<Schemas[Model] & SearchXataRecord, ['*']>[]>;
+        [Model in ExtractTables<Schemas, Tables, GetArrayInnerType<NonNullable<NonNullable<typeof options>['tables']>>>]?: Awaited<SelectedPick<Schemas[Model] & SearchXataRecord, ['*']>[]>;
     }>;
 };
 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 & {
     xata: {
-        table: string;
+        table?: string;
+        highlight?: {
+            [key: string]: string[] | {
+                [key: string]: any;
+            };
+        };
     };
 };
+declare type ReturnTable<Table, Tables> = Table extends Tables ? Table : never;
+declare type ExtractTables<Schemas extends Record<string, BaseData>, Tables extends StringKeys<Schemas>, TableOptions extends GetArrayInnerType<NonNullable<NonNullable<SearchOptions<Schemas, Tables>>['tables']>>> = TableOptions extends `${infer Table}` ? ReturnTable<Table, Tables> : TableOptions extends {
+    table: infer Table;
+} ? ReturnTable<Table, Tables> : never;
 
 declare type BranchStrategyValue = string | undefined | null;
 declare type BranchStrategyBuilder = () => BranchStrategyValue | Promise<BranchStrategyValue>;
@@ -3217,10 +3652,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> & {
@@ -3236,7 +3672,7 @@ declare type BranchResolutionOptions = {
     apiKey?: string;
     fetchImpl?: FetchImpl;
 };
-declare function getCurrentBranchName(options?: BranchResolutionOptions): Promise<string | undefined>;
+declare function getCurrentBranchName(options?: BranchResolutionOptions): Promise<string>;
 declare function getCurrentBranchDetails(options?: BranchResolutionOptions): Promise<DBBranch | null>;
 declare function getDatabaseURL(): string | undefined;
 
@@ -3247,4 +3683,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, SearchTableError, SearchTablePathParams, SearchTableRequestBody, SearchTableVariables, SelectableColumn, SelectedPick, SetTableSchemaError, SetTableSchemaPathParams, SetTableSchemaRequestBody, SetTableSchemaVariables, SimpleCache, SimpleCacheOptions, UpdateBranchMetadataError, UpdateBranchMetadataPathParams, UpdateBranchMetadataVariables, UpdateColumnError, UpdateColumnPathParams, UpdateColumnRequestBody, UpdateColumnVariables, UpdateRecordWithIDError, UpdateRecordWithIDPathParams, UpdateRecordWithIDQueryParams, UpdateRecordWithIDVariables, UpdateTableError, UpdateTablePathParams, UpdateTableRequestBody, UpdateTableVariables, UpdateUserError, UpdateUserVariables, UpdateWorkspaceError, UpdateWorkspaceMemberRoleError, UpdateWorkspaceMemberRolePathParams, UpdateWorkspaceMemberRoleRequestBody, UpdateWorkspaceMemberRoleVariables, UpdateWorkspacePathParams, UpdateWorkspaceVariables, UpsertRecordWithIDError, UpsertRecordWithIDPathParams, UpsertRecordWithIDQueryParams, UpsertRecordWithIDVariables, ValueAtColumn, XataApiClient, XataApiClientOptions, XataApiPlugin, XataError, XataPlugin, XataPluginOptions, XataRecord, acceptWorkspaceMemberInvite, addGitBranchesEntry, addTableColumn, buildClient, bulkInsertTableRecords, cancelWorkspaceMemberInvite, contains, createBranch, createDatabase, createTable, createUserAPIKey, createWorkspace, deleteBranch, deleteColumn, deleteDatabase, deleteRecord, deleteTable, deleteUser, deleteUserAPIKey, deleteWorkspace, endsWith, executeBranchMigrationPlan, exists, ge, getAPIKey, getBranchDetails, getBranchList, getBranchMetadata, getBranchMigrationHistory, getBranchMigrationPlan, getBranchStats, getColumn, getCurrentBranchDetails, getCurrentBranchName, getDatabaseList, getDatabaseURL, getGitBranchesMapping, getRecord, getTableColumns, getTableSchema, getUser, getUserAPIKeys, getWorkspace, getWorkspaceMembersList, getWorkspacesList, gt, gte, includes, includesAll, includesAny, includesNone, insertRecord, insertRecordWithID, inviteWorkspaceMember, is, isCursorPaginationOptions, isIdentifiable, isNot, isXataRecord, le, lt, lte, notExists, operationsByTag, pattern, queryTable, removeGitBranchesEntry, removeWorkspaceMember, resendWorkspaceMemberInvite, resolveBranch, searchBranch, searchTable, setTableSchema, startsWith, updateBranchMetadata, updateColumn, updateRecordWithID, updateTable, updateUser, updateWorkspace, updateWorkspaceMemberRole, upsertRecordWithID };