@xata.io/client 0.0.0-beta.f46cf74 → 0.0.0-beta.fef71a6

package/dist/schema/query.d.ts

@@ -81,27 +81,28 @@ export declare class Query<T extends XataRecord, R extends XataRecord = T> imple
      * @returns A new Query object.
      */
     select<K extends SelectableColumn<T>>(columns: K[]): Query<T, Select<T, K>>;
-    getPaginated<Options extends QueryOptions<T>>(options?: Options): Promise<Page<T, typeof options extends {
-        columns: SelectableColumn<T>[];
-    } ? Select<T, typeof options['columns'][number]> : R>>;
+    getPaginated<Options extends QueryOptions<T>>(options?: Options): Promise<Page<T, GetWithColumnOptions<T, R, typeof options>>>;
     [Symbol.asyncIterator](): AsyncIterableIterator<R>;
-    getIterator(chunk: number, options?: Omit<QueryOptions<T>, 'page'>): AsyncGenerator<R[]>;
+    getIterator<Options extends QueryOptions<T>>(chunk: number, options?: Omit<Options, 'page'>): AsyncGenerator<GetWithColumnOptions<T, R, typeof options>[]>;
     /**
      * 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 QueryOptions<T>>(options?: Options): Promise<(typeof options extends {
-        columns: SelectableColumn<T>[];
-    } ? Select<T, typeof options['columns'][number]> : R)[]>;
+    getMany<Options extends QueryOptions<T>>(options?: Options): Promise<GetWithColumnOptions<T, R, typeof options>[]>;
+    /**
+     * 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 extends QueryOptions<T>>(options?: Omit<Options, 'page'>): Promise<GetWithColumnOptions<T, R, typeof options>[]>;
     /**
      * 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<Options extends Omit<QueryOptions<T>, 'page'>>(options?: Options): Promise<(typeof options extends {
-        columns: SelectableColumn<T>[];
-    } ? Select<T, typeof options['columns'][number]> : R) | null>;
+    getOne<Options extends Omit<QueryOptions<T>, 'page'>>(options?: Options): Promise<GetWithColumnOptions<T, R, typeof options> | null>;
     /**async deleteAll(): Promise<number> {
       // TODO: Return number of affected rows
       return 0;
@@ -112,3 +113,16 @@ export declare class Query<T extends XataRecord, R extends XataRecord = T> imple
     lastPage(size?: number, offset?: number): Promise<Page<T, R>>;
     hasNextPage(): boolean;
 }
+/**
+ * Helper type to read options and compute the correct type for the result values
+ * T: Original type
+ * R: Default destination type
+ * Options: QueryOptions
+ *
+ * If the columns are overriden in the options, the result type is the pick of the original type and the columns
+ * If the columns are not overriden, the result type is the default destination type
+ */
+declare type GetWithColumnOptions<T, R, Options> = Options extends {
+    columns: SelectableColumn<T>[];
+} ? Select<T, Options['columns'][number]> : R;
+export {};

package/dist/schema/query.js

@@ -193,6 +193,32 @@ class Query {
             return records;
         });
     }
+    /**
+     * 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 = {}) {
+        var e_2, _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const results = [];
+            try {
+                for (var _b = __asyncValues(this.getIterator(100, options)), _c; _c = yield _b.next(), !_c.done;) {
+                    const page = _c.value;
+                    results.push(...page);
+                }
+            }
+            catch (e_2_1) { e_2 = { error: e_2_1 }; }
+            finally {
+                try {
+                    if (_c && !_c.done && (_a = _b.return)) yield _a.call(_b);
+                }
+                finally { if (e_2) throw e_2.error; }
+            }
+            return results;
+        });
+    }
     /**
      * Performs the query in the database and returns the first result.
      * @param options Additional options to be used when performing the query.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xata.io/client",
-  "version": "0.0.0-beta.f46cf74",
+  "version": "0.0.0-beta.fef71a6",
   "description": "Xata.io SDK for TypeScript and JavaScript",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -20,5 +20,5 @@
     "url": "https://github.com/xataio/client-ts/issues"
   },
   "homepage": "https://github.com/xataio/client-ts/blob/main/client/README.md",
-  "gitHead": "f46cf74dea31a3823e8d48ded90a6f0c7d42d894"
+  "gitHead": "fef71a6d4020e404d82c373e466e9fd4c23d4d90"
 }