@itwin/core-backend 5.14.0-dev.21 → 5.14.0-dev.22

package/lib/esm/test/ecdb/QueryReaders.test.js

@@ -75,12 +75,87 @@ describe("QueryReaders - createQueryReader() and withQueryReader() api tests", (
     after(async () => {
         iModel.close();
     });
+    it("formats blob results", async () => {
+        const env_1 = { stack: [], error: void 0, hasError: false };
+        try {
+            const ecdb = __addDisposableResource(env_1, ECDbTestHelper.createECDb(KnownTestLocations.outputDir, "ecsql-reader-blobs.ecdb", `<?xml version="1.0" encoding="utf-8"?>
+      <ECSchema schemaName="MySchema" alias="myschema" version="01.00.00" xmlns="http://www.bentley.com/schemas/Bentley.ECXML.3.2">
+        <ECEntityClass typeName="BlobExample">
+          <ECProperty propertyName="Data" typeName="binary" />
+        </ECEntityClass>
+      </ECSchema>`), false);
+            const blob = new Uint8Array([1, 2, 3]);
+            const insertStatus = ecdb.withWriteStatement("INSERT INTO myschema.BlobExample(Data) VALUES(?)", (stmt) => {
+                stmt.bindBlob(1, blob);
+                return stmt.step();
+            });
+            assert.equal(insertStatus, DbResult.BE_SQLITE_DONE);
+            ecdb.saveChanges();
+            for (const abbreviateBlobs of [undefined, false, true]) {
+                const query = "SELECT Data FROM myschema.BlobExample";
+                const expected = abbreviateBlobs ? '{"bytes":3}' : blob;
+                const asyncRows = await ecdb.createQueryReader(query, undefined, { abbreviateBlobs }).toArray();
+                const syncRows = ecdb.withQueryReader(query, (reader) => reader.toArray(), undefined, { abbreviateBlobs });
+                assert.deepEqual(asyncRows, [[expected]]);
+                assert.deepEqual(syncRows, [[expected]]);
+            }
+        }
+        catch (e_1) {
+            env_1.error = e_1;
+            env_1.hasError = true;
+        }
+        finally {
+            __disposeResources(env_1);
+        }
+    });
+    it("preserves row formats and bindings", async () => {
+        const rootSelect = "SELECT ECInstanceId, ECClassId FROM bis.Element WHERE ECInstanceId=?";
+        const asyncIndexRows = await iModel.createQueryReader(rootSelect, new QueryBinder().bindId(1, "0x1")).toArray();
+        assert.isArray(asyncIndexRows[0]);
+        assert.equal(asyncIndexRows[0][0], "0x1");
+        assert.isTrue(Id64.isValidId64(asyncIndexRows[0][1]));
+        const asyncECSqlNameRows = await iModel.createQueryReader(rootSelect, new QueryBinder().bindId(1, "0x1"), { rowFormat: QueryRowFormat.UseECSqlPropertyNames }).toArray();
+        assert.equal(asyncECSqlNameRows[0].ECInstanceId, "0x1");
+        assert.isTrue(Id64.isValidId64(asyncECSqlNameRows[0].ECClassId));
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
+        const asyncJsNameRows = await iModel.createQueryReader(rootSelect, new QueryBinder().bindId(1, "0x1"), { rowFormat: QueryRowFormat.UseJsPropertyNames }).toArray();
+        assert.equal(asyncJsNameRows[0].id, "0x1");
+        assert.equal(asyncJsNameRows[0].className, "BisCore.Subject");
+        const syncIndexRows = iModel.withQueryReader(rootSelect, (reader) => reader.toArray(), new QueryBinder().bindId(1, "0x1"));
+        assert.isArray(syncIndexRows[0]);
+        assert.equal(syncIndexRows[0][0], "0x1");
+        assert.isTrue(Id64.isValidId64(syncIndexRows[0][1]));
+        const syncECSqlNameRows = iModel.withQueryReader(rootSelect, (reader) => reader.toArray(), new QueryBinder().bindId(1, "0x1"), { rowFormat: QueryRowFormat.UseECSqlPropertyNames });
+        assert.equal(syncECSqlNameRows[0].ECInstanceId, "0x1");
+        assert.isTrue(Id64.isValidId64(syncECSqlNameRows[0].ECClassId));
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
+        const syncJsNameRows = iModel.withQueryReader(rootSelect, (reader) => reader.toArray(), new QueryBinder().bindId(1, "0x1"), { rowFormat: QueryRowFormat.UseJsPropertyNames });
+        assert.equal(syncJsNameRows[0].id, "0x1");
+        assert.equal(syncJsNameRows[0].className, "BisCore.Subject");
+        const asyncReader = iModel.createQueryReader(rootSelect, new QueryBinder().bindId(1, "0x1"));
+        assert.isTrue(await asyncReader.step());
+        const asyncObjectRow = asyncReader.current.toRow();
+        assert.isFalse(Array.isArray(asyncObjectRow));
+        assert.equal(asyncObjectRow.ECInstanceId, "0x1");
+        const objectRow = iModel.withQueryReader(rootSelect, (reader) => {
+            assert.isTrue(reader.step());
+            return reader.current.toRow();
+        }, new QueryBinder().bindId(1, "0x1"));
+        assert.isObject(objectRow);
+        assert.equal(objectRow.ECInstanceId, "0x1");
+        const arrayRows = iModel.withQueryReader(rootSelect, (reader) => reader.toArray(), new QueryBinder().bindId(1, "0x1"));
+        assert.isArray(arrayRows[0]);
+        const idSetRows = await iModel.createQueryReader("SELECT ECInstanceId FROM bis.Element WHERE InVirtualSet(?, ECInstanceId)", new QueryBinder().bindIdSet(1, ["0x1", "0x2"])).toArray();
+        assert.isTrue(idSetRows.some((row) => row[0] === "0x1"));
+        const syncIdSetRows = iModel.withQueryReader("SELECT ECInstanceId FROM bis.Element WHERE InVirtualSet(?, ECInstanceId)", (reader) => reader.toArray(), new QueryBinder().bindIdSet(1, ["0x1", "0x2"]));
+        assert.sameDeepMembers(syncIdSetRows, idSetRows);
+    });
     describe("bind Id64 enumerable", async () => {
         const outDir = KnownTestLocations.outputDir;
         it("ecsql reader simple", async () => {
-            const env_1 = { stack: [], error: void 0, hasError: false };
+            const env_2 = { stack: [], error: void 0, hasError: false };
             try {
-                const ecdb = __addDisposableResource(env_1, ECDbTestHelper.createECDb(outDir, "test.ecdb", `<ECSchema schemaName="Test" alias="ts" version="01.00.00" xmlns="http://www.bentley.com/schemas/Bentley.ECXML.3.2">
+                const ecdb = __addDisposableResource(env_2, ECDbTestHelper.createECDb(outDir, "test.ecdb", `<ECSchema schemaName="Test" alias="ts" version="01.00.00" xmlns="http://www.bentley.com/schemas/Bentley.ECXML.3.2">
           <ECEntityClass typeName="Foo" modifier="Sealed">
             <ECProperty propertyName="n" typeName="int"/>
           </ECEntityClass>
@@ -106,18 +181,18 @@ describe("QueryReaders - createQueryReader() and withQueryReader() api tests", (
                 const reader = ecdb.createQueryReader("SELECT ECInstanceId, Name FROM meta.ECClassDef WHERE InVirtualSet(?, ECInstanceId)", params, optionBuilder.getOptions());
                 await readerCallback(reader);
             }
-            catch (e_1) {
-                env_1.error = e_1;
-                env_1.hasError = true;
+            catch (e_2) {
+                env_2.error = e_2;
+                env_2.hasError = true;
             }
             finally {
-                __disposeResources(env_1);
+                __disposeResources(env_2);
             }
         });
         it("ecsql reader simple for IdSet", async () => {
-            const env_2 = { stack: [], error: void 0, hasError: false };
+            const env_3 = { stack: [], error: void 0, hasError: false };
             try {
-                const ecdb = __addDisposableResource(env_2, ECDbTestHelper.createECDb(outDir, "test.ecdb", `<ECSchema schemaName="Test" alias="ts" version="01.00.00" xmlns="http://www.bentley.com/schemas/Bentley.ECXML.3.2">
+                const ecdb = __addDisposableResource(env_3, ECDbTestHelper.createECDb(outDir, "test.ecdb", `<ECSchema schemaName="Test" alias="ts" version="01.00.00" xmlns="http://www.bentley.com/schemas/Bentley.ECXML.3.2">
           <ECEntityClass typeName="Foo" modifier="Sealed">
             <ECProperty propertyName="n" typeName="int"/>
           </ECEntityClass>
@@ -143,18 +218,18 @@ describe("QueryReaders - createQueryReader() and withQueryReader() api tests", (
                 const reader = ecdb.createQueryReader("SELECT ECInstanceId, Name FROM meta.ECClassDef, IdSet(?) WHERE id = ECInstanceId ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES", params, optionBuilder.getOptions());
                 await readerCallback(reader);
             }
-            catch (e_2) {
-                env_2.error = e_2;
-                env_2.hasError = true;
+            catch (e_3) {
+                env_3.error = e_3;
+                env_3.hasError = true;
             }
             finally {
-                __disposeResources(env_2);
+                __disposeResources(env_3);
             }
         });
         it("bindIdSet throws on invalid integer Ids", () => {
-            const env_3 = { stack: [], error: void 0, hasError: false };
+            const env_4 = { stack: [], error: void 0, hasError: false };
             try {
-                const ecdb = __addDisposableResource(env_3, ECDbTestHelper.createECDb(outDir, "test.ecdb", `<ECSchema schemaName="Test" alias="ts" version="01.00.00" xmlns="http://www.bentley.com/schemas/Bentley.ECXML.3.2">
+                const ecdb = __addDisposableResource(env_4, ECDbTestHelper.createECDb(outDir, "test.ecdb", `<ECSchema schemaName="Test" alias="ts" version="01.00.00" xmlns="http://www.bentley.com/schemas/Bentley.ECXML.3.2">
           <ECEntityClass typeName="Foo" modifier="Sealed">
             <ECProperty propertyName="n" typeName="int"/>
           </ECEntityClass>
@@ -164,18 +239,18 @@ describe("QueryReaders - createQueryReader() and withQueryReader() api tests", (
                 const params = new QueryBinder();
                 expect(() => params.bindIdSet(1, ["50"])).to.throw(/is not a valid Id64String/);
             }
-            catch (e_3) {
-                env_3.error = e_3;
-                env_3.hasError = true;
+            catch (e_4) {
+                env_4.error = e_4;
+                env_4.hasError = true;
             }
             finally {
-                __disposeResources(env_3);
+                __disposeResources(env_4);
             }
         });
         it("ecsql reader simple using query reader", async () => {
-            const env_4 = { stack: [], error: void 0, hasError: false };
+            const env_5 = { stack: [], error: void 0, hasError: false };
             try {
-                const ecdb = __addDisposableResource(env_4, ECDbTestHelper.createECDb(outDir, "test.ecdb", `<ECSchema schemaName="Test" alias="ts" version="01.00.00" xmlns="http://www.bentley.com/schemas/Bentley.ECXML.3.2">
+                const ecdb = __addDisposableResource(env_5, ECDbTestHelper.createECDb(outDir, "test.ecdb", `<ECSchema schemaName="Test" alias="ts" version="01.00.00" xmlns="http://www.bentley.com/schemas/Bentley.ECXML.3.2">
           <ECEntityClass typeName="Foo" modifier="Sealed">
             <ECProperty propertyName="n" typeName="int"/>
           </ECEntityClass>
@@ -215,12 +290,12 @@ describe("QueryReaders - createQueryReader() and withQueryReader() api tests", (
                 const reader = ecdb.createQueryReader("SELECT ECInstanceId, n FROM ts.Foo WHERE ECInstanceId=:firstId", params, { limit: { count: 1 } });
                 await readerCallback(reader);
             }
-            catch (e_4) {
-                env_4.error = e_4;
-                env_4.hasError = true;
+            catch (e_5) {
+                env_5.error = e_5;
+                env_5.hasError = true;
             }
             finally {
-                __disposeResources(env_4);
+                __disposeResources(env_5);
             }
         });
         it("ecsql reader simple using query row reader", async () => {
@@ -255,10 +330,10 @@ describe("QueryReaders - createQueryReader() and withQueryReader() api tests", (
             await readerCallback(reader);
         });
         it("should bind Range3d", async () => {
-            const env_5 = { stack: [], error: void 0, hasError: false };
+            const env_6 = { stack: [], error: void 0, hasError: false };
             try {
                 const testRange = new Range3d(1.2, 2.3, 3.4, 4.5, 5.6, 6.7);
-                const ecdb = __addDisposableResource(env_5, ECDbTestHelper.createECDb(outDir, "bindrange3d.ecdb", `<ECSchema schemaName="Test" alias="test" version="01.00.00" xmlns="http://www.bentley.com/schemas/Bentley.ECXML.3.1">
+                const ecdb = __addDisposableResource(env_6, ECDbTestHelper.createECDb(outDir, "bindrange3d.ecdb", `<ECSchema schemaName="Test" alias="test" version="01.00.00" xmlns="http://www.bentley.com/schemas/Bentley.ECXML.3.1">
         <ECEntityClass typeName="Foo" modifier="Sealed">
           <ECProperty propertyName="Range3d" typeName="binary"/>
         </ECEntityClass>
@@ -280,12 +355,12 @@ describe("QueryReaders - createQueryReader() and withQueryReader() api tests", (
                 const actualRange = new Range3d(...rangeFloatArray);
                 assert.isTrue(actualRange.isAlmostEqual(testRange));
             }
-            catch (e_5) {
-                env_5.error = e_5;
-                env_5.hasError = true;
+            catch (e_6) {
+                env_6.error = e_6;
+                env_6.hasError = true;
             }
             finally {
-                __disposeResources(env_5);
+                __disposeResources(env_6);
             }
         });
     });