@itwin/core-backend
Version:
iTwin.js backend components
698 lines • 35.6 kB
JavaScript
/*---------------------------------------------------------------------------------------------
* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
* See LICENSE.md in the project root for license terms and full copyright notice.
*--------------------------------------------------------------------------------------------*/
import { assert } from "chai";
import { DbResult, Id64 } from "@itwin/core-bentley";
import { DbRequestKind, ECSqlReader, QueryBinder, QueryOptionsBuilder, QueryRowFormat } from "@itwin/core-common";
import { ConcurrentQuery } from "../../ConcurrentQuery";
import { _nativeDb, SnapshotDb } from "../../core-backend";
import { IModelTestUtils } from "../IModelTestUtils";
import { SequentialLogMatcher } from "../SequentialLogMatcher";
import * as path from "path";
// cspell:ignore mirukuru ibim
describe("ECSql Query", () => {
let imodel1;
let imodel2;
let imodel3;
let imodel4;
let imodel5;
let imodel6;
before(async () => {
imodel1 = SnapshotDb.openFile(IModelTestUtils.resolveAssetFile("test.bim"));
imodel2 = SnapshotDb.openFile(IModelTestUtils.resolveAssetFile("CompatibilityTestSeed.bim"));
imodel3 = SnapshotDb.openFile(IModelTestUtils.resolveAssetFile("GetSetAutoHandledStructProperties.bim"));
imodel4 = SnapshotDb.openFile(IModelTestUtils.resolveAssetFile("GetSetAutoHandledArrayProperties.bim"));
imodel5 = SnapshotDb.openFile(IModelTestUtils.resolveAssetFile("mirukuru.ibim"));
imodel6 = SnapshotDb.openFile(IModelTestUtils.resolveAssetFile("test_ec_4003.bim"));
});
after(async () => {
imodel1.close();
imodel2.close();
imodel3.close();
imodel4.close();
imodel5.close();
imodel6.close();
});
it("verify 4.8.x format for ECClassId", async () => {
const queries = [
"SELECT ECClassId FROM Bis.Element LIMIT 1",
"SELECT ECClassId aClassId FROM Bis.Element LIMIT 1",
"SELECT Parent FROM Bis.Element WHERE Parent.Id IS NOT NULL LIMIT 1 ",
"SELECT Parent.RelECClassId FROM Bis.Element WHERE Parent.Id IS NOT NULL LIMIT 1",
"SELECT Parent aParent FROM Bis.Element WHERE Parent.Id IS NOT NULL LIMIT 1 ",
"SELECT Parent.RelECClassId aRelClassId FROM Bis.Element WHERE Parent.Id IS NOT NULL LIMIT 1",
"WITH t(aClassId) AS (SELECT ECClassId FROM Bis.Element LIMIT 1) SELECT aClassId FROM t",
"WITH t(aClassId) AS (SELECT ECClassId Foo FROM Bis.Element LIMIT 1) SELECT aClassId FROM t",
"WITH t(aClassId) AS (SELECT ECClassId FROM Bis.Element LIMIT 1) SELECT aClassId bClassId FROM t",
"SELECT * FROM (SELECT ECClassId FROM Bis.Element LIMIT 1)",
"SELECT * FROM (SELECT ECClassId aClassId, ECClassId FROM Bis.Element LIMIT 1)",
"SELECT * FROM (SELECT Parent FROM Bis.Element WHERE Parent.Id IS NOT NULL LIMIT 1)",
"SELECT * FROM (SELECT Parent.RelECClassId FROM Bis.Element WHERE Parent.Id IS NOT NULL LIMIT 1)",
"SELECT * FROM (SELECT Parent aParent FROM Bis.Element WHERE Parent.Id IS NOT NULL LIMIT 1)",
"SELECT * FROM (SELECT Parent.RelECClassId aRelClassId FROM Bis.Element WHERE Parent.Id IS NOT NULL LIMIT 1)",
"SELECT * FROM (WITH t(aClassId) AS (SELECT ECClassId FROM Bis.Element LIMIT 1) SELECT aClassId FROM t)",
"SELECT * FROM (WITH t(aClassId) AS (SELECT ECClassId Foo FROM Bis.Element LIMIT 1) SELECT aClassId FROM t)",
"SELECT * FROM (WITH t(aClassId) AS (SELECT ECClassId FROM Bis.Element LIMIT 1) SELECT aClassId bClassId FROM t)",
];
assert.equal(queries.length, 18);
const results = [
{ className: "BisCore.DrawingCategory" },
{ aClassId: "0x4c" },
{ parent: { id: "0x1", relClassName: "BisCore.SubjectOwnsPartitionElements" } },
{ "parent.relClassName": "BisCore.SubjectOwnsPartitionElements" },
{ aParent: { id: "0x1", relClassName: "BisCore.SubjectOwnsPartitionElements" } },
{ aRelClassId: "0xcf" },
{ aClassId: "0x4c" },
{ aClassId: "0x4c" },
{ bClassId: "0x4c" },
{ className: "BisCore.DrawingCategory" },
{ aClassId: "0x4c", className: "BisCore.DrawingCategory" },
{ parent: { id: "0x1", relClassName: "BisCore.SubjectOwnsPartitionElements" } },
{ "parent.relClassName": "BisCore.SubjectOwnsPartitionElements" },
{ aParent: { id: "0x1", relClassName: "BisCore.SubjectOwnsPartitionElements" } },
{ aRelClassId: "0xcf" },
{ aClassId: "0x4c" },
{ aClassId: "0x4c" },
{ bClassId: "0x4c" },
];
assert.equal(results.length, 18);
const builder = new QueryOptionsBuilder();
builder.setRowFormat(QueryRowFormat.UseJsPropertyNames);
let expectedRows = 0;
for (let i = 0; i < queries.length; i++) {
// eslint-disable-next-line @typescript-eslint/no-deprecated
imodel1.withPreparedStatement(queries[i], (stmt) => {
assert.equal(DbResult.BE_SQLITE_ROW, stmt.step(), "expected DbResult.BE_SQLITE_ROW");
assert.deepEqual(stmt.getRow(), results[i], `(ECSqlStatement) "${queries[i]}" does not match expected result (${path.basename(imodel1[_nativeDb].getFilePath())})`);
++expectedRows;
});
for await (const row of imodel1.createQueryReader(queries[i], undefined, builder.getOptions())) {
assert.deepEqual(row.toRow(), results[i], `(ECSqlReader) "${queries[i]}" does not match expected result (${path.basename(imodel1[_nativeDb].getFilePath())})`);
++expectedRows;
}
}
assert.equal(expectedRows, 36);
});
it("verify return values for system properties", async () => {
/* eslint-disable @typescript-eslint/naming-convention */
const testQueries = [
//
{
query: "SELECT a.ECInstanceId, b.ECInstanceId, a.ECClassId, b.ECClassId FROM BisCore.Element a, BisCore.Element b LIMIT 1",
result: {
id: "0x19",
id_1: "0x19",
className: "BisCore.DrawingCategory",
className_1: "BisCore.DrawingCategory",
},
},
{
query: "SELECT Parent.Id,Parent.RelECClassId, Parent.Id myParentId, Parent.RelECClassId myParentRelClassId FROM BisCore.Element WHERE Parent.Id IS NOT NULL LIMIT 1",
result: {
"myParentId": "0x1",
"myParentRelClassId": "0xcf",
"parent.id": "0x1",
"parent.relClassName": "BisCore.SubjectOwnsPartitionElements",
},
},
{
query: "SELECT ECInstanceId, ECClassId FROM Bis.Element LIMIT 1",
result: {
id: "0x19",
className: "BisCore.DrawingCategory",
},
},
{
query: "SELECT * FROM (SELECT ECInstanceId, ECClassId FROM Bis.Element) LIMIT 1",
result: {
id: "0x19",
className: "BisCore.DrawingCategory",
},
},
{
query: "SELECT ECInstanceId, ECClassId, SourceECInstanceId, SourceECClassId, TargetECInstanceid, TargetECClassId FROM Bis.ElementRefersToElements LIMIT 1",
result: {
id: "0x1",
className: "BisCore.PartitionOriginatesFromRepository",
sourceId: "0x1c",
sourceClassName: "BisCore.PhysicalPartition",
targetId: "0x12",
targetClassName: "BisCore.RepositoryLink",
},
},
{
query: "SELECT * FROM (SELECT ECInstanceId, ECClassId, SourceECInstanceId, SourceECClassId, TargetECInstanceid, TargetECClassId FROM Bis.ElementRefersToElements) LIMIT 1",
result: {
id: "0x1",
className: "BisCore.PartitionOriginatesFromRepository",
sourceId: "0x1c",
sourceClassName: "BisCore.PhysicalPartition",
targetId: "0x12",
targetClassName: "BisCore.RepositoryLink",
},
},
{
query: "SELECT ECInstanceId a, ECClassId b FROM Bis.Element LIMIT 1",
result: {
a: "0x19",
b: "0x4c",
},
},
{
query: "SELECT * FROM (SELECT ECInstanceId a, ECClassId b FROM Bis.Element) LIMIT 1",
result: {
a: "0x19",
b: "0x4c",
},
},
{
query: "SELECT ECInstanceId A, ECClassId B FROM Bis.Element LIMIT 1",
result: {
a: "0x19",
b: "0x4c",
},
},
{
query: "SELECT * FROM (SELECT ECInstanceId A, ECClassId B FROM Bis.Element) LIMIT 1",
result: {
a: "0x19",
b: "0x4c",
},
},
{
query: "SELECT ECInstanceId a, ECClassId b, SourceECInstanceId c, SourceECClassId d, TargetECInstanceid e, TargetECClassId f FROM Bis.ElementRefersToElements LIMIT 1",
result: {
a: "0x1",
b: "0xa8",
c: "0x1c",
d: "0xb4",
e: "0x12",
f: "0xa9",
},
},
{
query: "SELECT * FROM (SELECT ECInstanceId a, ECClassId b, SourceECInstanceId c, SourceECClassId d, TargetECInstanceid e, TargetECClassId f FROM Bis.ElementRefersToElements) LIMIT 1",
result: {
a: "0x1",
b: "0xa8",
c: "0x1c",
d: "0xb4",
e: "0x12",
f: "0xa9",
},
},
{
query: "SELECT ECInstanceId A, ECClassId B, SourceECInstanceId C, SourceECClassId D, TargetECInstanceid E, TargetECClassId F FROM Bis.ElementRefersToElements LIMIT 1",
result: {
a: "0x1",
b: "0xa8",
c: "0x1c",
d: "0xb4",
e: "0x12",
f: "0xa9",
},
},
{
query: "SELECT * FROM (SELECT ECInstanceId A, ECClassId B, SourceECInstanceId C, SourceECClassId D, TargetECInstanceid E, TargetECClassId F FROM Bis.ElementRefersToElements) LIMIT 1",
result: {
a: "0x1",
b: "0xa8",
c: "0x1c",
d: "0xb4",
e: "0x12",
f: "0xa9",
},
},
{
query: "SELECT Model, Model.Id, Model.RelECClassId from Bis.Element limit 1",
result: {
"model": {
id: "0x1",
relClassName: "BisCore.ModelContainsElements",
},
"model.id": "0x1",
"model.relClassName": "BisCore.ModelContainsElements",
},
},
{
query: "SELECT * FROM (SELECT Model, Model.Id, Model.RelECClassId from Bis.Element) LIMIT 1",
result: {
"model": {
id: "0x1",
relClassName: "BisCore.ModelContainsElements",
},
"model.id": "0x1",
"model.relClassName": "BisCore.ModelContainsElements",
},
},
{
query: "SELECT r.ECInstanceId, r.ECClassId, r.SourceECInstanceId, r.SourceECClassId, r.TargetECInstanceid, r.TargetECClassId, ele.Model, ele.Model.Id, ele.Model.RelECClassId FROM Bis.ElementRefersToElements r JOIN Bis.Element ele ON ele.ECInstanceId = r.SourceECInstanceId LIMIT 1",
result: {
"id": "0x1",
"className": "BisCore.PartitionOriginatesFromRepository",
"sourceId": "0x1c",
"sourceClassName": "BisCore.PhysicalPartition",
"targetId": "0x12",
"targetClassName": "BisCore.RepositoryLink",
"model": {
id: "0x1",
relClassName: "BisCore.ModelContainsElements",
},
"model.id": "0x1",
"model.relClassName": "BisCore.ModelContainsElements",
},
},
{
query: "SELECT * FROM (SELECT r.ECInstanceId, r.ECClassId, r.SourceECInstanceId, r.SourceECClassId, r.TargetECInstanceid, r.TargetECClassId, ele.Model, ele.Model.Id, ele.Model.RelECClassId FROM Bis.ElementRefersToElements r JOIN Bis.Element ele ON ele.ECInstanceId = r.SourceECInstanceId) LIMIT 1",
result: {
"id": "0x1",
"className": "BisCore.PartitionOriginatesFromRepository",
"sourceId": "0x1c",
"sourceClassName": "BisCore.PhysicalPartition",
"targetId": "0x12",
"targetClassName": "BisCore.RepositoryLink",
"model": {
id: "0x1",
relClassName: "BisCore.ModelContainsElements",
},
"model.id": "0x1",
"model.relClassName": "BisCore.ModelContainsElements",
},
},
{
query: "SELECT r.ECInstanceId a, r.ECClassId b, r.SourceECInstanceId c, r.SourceECClassId d, r.TargetECInstanceid e, r.TargetECClassId f, ele.Model g, ele.Model.Id h, ele.Model.RelECClassId i FROM Bis.ElementRefersToElements r JOIN Bis.Element ele ON ele.ECInstanceId = r.SourceECInstanceId LIMIT 1",
result: {
a: "0x1",
b: "0xa8",
c: "0x1c",
d: "0xb4",
e: "0x12",
f: "0xa9",
g: {
id: "0x1",
relClassName: "BisCore.ModelContainsElements",
},
h: "0x1",
i: "0x40",
},
},
{
query: "SELECT * FROM (SELECT r.ECInstanceId a, r.ECClassId b, r.SourceECInstanceId c, r.SourceECClassId d, r.TargetECInstanceid e, r.TargetECClassId f, ele.Model g, ele.Model.Id h, ele.Model.RelECClassId i FROM Bis.ElementRefersToElements r JOIN Bis.Element ele ON ele.ECInstanceId = r.SourceECInstanceId) LIMIT 1",
result: {
a: "0x1",
b: "0xa8",
c: "0x1c",
d: "0xb4",
e: "0x12",
f: "0xa9",
g: {
id: "0x1",
relClassName: "BisCore.ModelContainsElements",
},
h: "0x1",
i: "0x40",
},
},
{
query: "SELECT r.ECInstanceId A, r.ECClassId B, r.SourceECInstanceId C, r.SourceECClassId D, r.TargetECInstanceid E, r.TargetECClassId F, ele.Model G, ele.Model.Id H, ele.Model.RelECClassId I FROM Bis.ElementRefersToElements r JOIN Bis.Element ele ON ele.ECInstanceId = r.SourceECInstanceId LIMIT 1",
result: {
a: "0x1",
b: "0xa8",
c: "0x1c",
d: "0xb4",
e: "0x12",
f: "0xa9",
g: {
id: "0x1",
relClassName: "BisCore.ModelContainsElements",
},
h: "0x1",
i: "0x40",
},
},
{
query: "SELECT * FROM (SELECT r.ECInstanceId A, r.ECClassId B, r.SourceECInstanceId C, r.SourceECClassId D, r.TargetECInstanceid E, r.TargetECClassId F, ele.Model G, ele.Model.Id H, ele.Model.RelECClassId I FROM Bis.ElementRefersToElements r JOIN Bis.Element ele ON ele.ECInstanceId = r.SourceECInstanceId) LIMIT 1",
result: {
a: "0x1",
b: "0xa8",
c: "0x1c",
d: "0xb4",
e: "0x12",
f: "0xa9",
g: {
id: "0x1",
relClassName: "BisCore.ModelContainsElements",
},
h: "0x1",
i: "0x40",
},
},
];
/* eslint-enable @typescript-eslint/naming-convention */
const builder = new QueryOptionsBuilder();
builder.setRowFormat(QueryRowFormat.UseJsPropertyNames);
// eslint-disable-next-line @typescript-eslint/no-deprecated
builder.setConvertClassIdsToNames(true);
// With ECDb Profile 4002
for (const testQuery of testQueries) {
// eslint-disable-next-line @typescript-eslint/no-deprecated
imodel1.withPreparedStatement(testQuery.query, (stmt) => {
assert.equal(DbResult.BE_SQLITE_ROW, stmt.step(), "expected DbResult.BE_SQLITE_ROW");
assert.deepEqual(stmt.getRow(), testQuery.result, `(ECSqlStatement) "${testQuery.query}" does not match expected result (${path.basename(imodel1[_nativeDb].getFilePath())})`);
});
let hasRow = false;
for await (const row of imodel1.createQueryReader(testQuery.query, undefined, builder.getOptions())) {
assert.deepEqual(row.toRow(), testQuery.result, `(ECSqlReader) "${testQuery.query}" does not match expected result (${path.basename(imodel1[_nativeDb].getFilePath())})`);
hasRow = true;
}
assert.isTrue(hasRow, "imodel1.query() must return latest one row");
}
// With ECDb Profile 4003
for (const testQuery of testQueries) {
// eslint-disable-next-line @typescript-eslint/no-deprecated
imodel6.withPreparedStatement(testQuery.query, (stmt) => {
assert.equal(DbResult.BE_SQLITE_ROW, stmt.step(), "expected DbResult.BE_SQLITE_ROW");
assert.deepEqual(stmt.getRow(), testQuery.result, `(ECSqlStatement) "${testQuery.query}" does not match expected result (${path.basename(imodel1[_nativeDb].getFilePath())})`);
});
let hasRow = false;
for await (const row of imodel6.createQueryReader(testQuery.query, undefined, builder.getOptions())) {
assert.deepEqual(row.toRow(), testQuery.result, `(ECSqlReader) "${testQuery.query}" does not match expected result (${path.basename(imodel1[_nativeDb].getFilePath())})`);
hasRow = true;
}
assert.isTrue(hasRow, "imodel1.query() must return latest one row");
}
});
it("check prepare logErrors flag", () => {
const ecdb = imodel1;
// expect log message when statement fails
let slm = new SequentialLogMatcher();
slm.append().error().category("BeSQLite").message("Error \"no such table: def (BE_SQLITE_ERROR)\" preparing SQL: SELECT abc FROM def");
assert.throw(() => ecdb.withSqliteStatement("SELECT abc FROM def", () => { }), "no such table: def (BE_SQLITE_ERROR)");
assert.isTrue(slm.finishAndDispose(), "logMatcher should detect log");
// now pass suppress log error which mean we should not get the error
slm = new SequentialLogMatcher();
slm.append().error().category("BeSQLite").message("Error \"no such table: def (BE_SQLITE_ERROR)\" preparing SQL: SELECT abc FROM def");
assert.throw(() => ecdb.withSqliteStatement("SELECT abc FROM def", () => { }, /* logErrors = */ false), "no such table: def (BE_SQLITE_ERROR)");
assert.isFalse(slm.finishAndDispose(), "logMatcher should not detect log");
// expect log message when statement fails
slm = new SequentialLogMatcher();
slm.append().error().category("ECDb").message("ECClass 'abc.def' does not exist or could not be loaded.");
// eslint-disable-next-line @typescript-eslint/no-deprecated
assert.throw(() => ecdb.withPreparedStatement("SELECT abc FROM abc.def", () => { }), "ECClass 'abc.def' does not exist or could not be loaded.");
assert.isTrue(slm.finishAndDispose(), "logMatcher should detect log");
// now pass suppress log error which mean we should not get the error
slm = new SequentialLogMatcher();
slm.append().error().category("ECDb").message("ECClass 'abc.def' does not exist or could not be loaded.");
// eslint-disable-next-line @typescript-eslint/no-deprecated
assert.throw(() => ecdb.withPreparedStatement("SELECT abc FROM abc.def", () => { }, /* logErrors = */ false), "");
assert.isFalse(slm.finishAndDispose(), "logMatcher should not detect log");
});
it("restart query", async () => {
let cancelled = 0;
let successful = 0;
let rowCount = 0;
try {
ConcurrentQuery.shutdown(imodel1[_nativeDb]);
ConcurrentQuery.resetConfig(imodel1[_nativeDb], { globalQuota: { time: 1 }, ignoreDelay: false });
const scheduleQuery = async (delay) => {
return new Promise(async (resolve, reject) => {
try {
const options = new QueryOptionsBuilder();
options.setDelay(delay);
options.setRestartToken("tag");
const reader = imodel1.createQueryReader("SELECT ECInstanceId as Id, Parent.Id as ParentId FROM BisCore.element", undefined, options.getOptions());
while (await reader.step()) {
rowCount++;
}
successful++;
resolve();
}
catch (err) {
// we expect query to be cancelled
if (err.errorNumber === DbResult.BE_SQLITE_INTERRUPT) {
cancelled++;
resolve();
}
else {
reject(new Error("rejected"));
}
}
});
};
const queries = [];
queries.push(scheduleQuery(5000));
queries.push(scheduleQuery(0));
await Promise.all(queries);
// We expect at least one query to be cancelled
assert.isAtLeast(cancelled, 1, "cancelled should be at least 1");
assert.isAtLeast(successful, 1, "successful should be at least 1");
assert.isAtLeast(rowCount, 1, "rowCount should be at least 1");
}
finally {
ConcurrentQuery.shutdown(imodel1[_nativeDb]);
ConcurrentQuery.resetConfig(imodel1[_nativeDb]);
}
});
it("concurrent query should retry on timeout", async () => {
class MockECSqlReader extends ECSqlReader {
constructor(_executor, query) {
super(_executor, query);
}
async mockReadRows(queryRequest) {
return super.runWithRetry(queryRequest);
}
}
// Set time to 1 sec to simulate a timeout scenario
ConcurrentQuery.resetConfig(imodel1[_nativeDb], { globalQuota: { time: 1 }, ignoreDelay: false });
const executor = {
execute: async (req) => {
return ConcurrentQuery.executeQueryRequest(imodel1[_nativeDb], req);
},
};
const request = {
kind: DbRequestKind.ECSql,
query: "SELECT * FROM BisCore.element",
delay: 5000, // Set delay to a value > timeout
};
try {
await new MockECSqlReader(executor, request.query).mockReadRows(request);
assert(false); // We expect this scenario to always throw
}
catch (error) {
// Query should give up after max retry count has been reached
assert(error.message === "query too long to execute or server is too busy");
}
});
it("concurrent query use primary connection", async () => {
const reader = imodel1.createQueryReader("SELECT * FROM BisCore.element", undefined, { usePrimaryConn: true });
let props = await reader.getMetaData();
assert.equal(props.length, 11);
let rows = 0;
while (await reader.step()) {
rows++;
}
assert.equal(rows, 46);
props = await reader.getMetaData();
assert.equal(props.length, 11);
assert.equal(reader.stats.backendRowsReturned, 46);
assert.isTrue(reader.stats.backendCpuTime > 0);
assert.isTrue(reader.stats.backendMemUsed > 1000);
assert.isTrue(reader.stats.totalTime > 0);
});
it("concurrent query use idset", async () => {
const ids = [];
for await (const row of imodel1.createQueryReader("SELECT ECInstanceId FROM BisCore.Element LIMIT 23")) {
ids.push(row[0]);
}
const reader = imodel1.createQueryReader("SELECT * FROM BisCore.element WHERE InVirtualSet(?, ECInstanceId)", QueryBinder.from([ids]));
let props = await reader.getMetaData();
assert.equal(props.length, 11);
let rows = 0;
while (await reader.step()) {
rows++;
}
assert.equal(rows, 23);
props = await reader.getMetaData();
assert.equal(props.length, 11);
assert.equal(reader.stats.backendRowsReturned, 23);
assert.isTrue(reader.stats.backendCpuTime > 0);
assert.isTrue(reader.stats.backendMemUsed > 100);
});
it("concurrent query bind idset in IdSet virtual table", async () => {
const ids = [];
for await (const row of imodel1.createQueryReader("SELECT ECInstanceId FROM BisCore.Element LIMIT 23")) {
ids.push(row[0]);
}
const reader = imodel1.createQueryReader("SELECT * FROM BisCore.element, IdSet(?) WHERE id = ECInstanceId ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES", QueryBinder.from([ids]));
let props = await reader.getMetaData();
assert.equal(props.length, 12); // 11 for BisCore.element and 1 for IdSet
let rows = 0;
while (await reader.step()) {
rows++;
}
assert.equal(rows, 23);
props = await reader.getMetaData();
assert.equal(props.length, 12); // 11 for BisCore.element and 1 for IdSet
assert.equal(reader.stats.backendRowsReturned, 23);
assert.isTrue(reader.stats.backendCpuTime > 0);
assert.isTrue(reader.stats.backendMemUsed > 100);
});
it("concurrent query bind single id in IdSet virtual table", async () => {
let ids = "";
for await (const row of imodel1.createQueryReader("SELECT ECInstanceId FROM BisCore.Element LIMIT 23")) {
ids = row[0]; // getting only the first id
break;
}
const reader = imodel1.createQueryReader("SELECT * FROM BisCore.element, IdSet(?) WHERE id = ECInstanceId ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES", QueryBinder.from([ids]));
let props = await reader.getMetaData();
assert.equal(props.length, 12); // 11 for BisCore.element and 1 for IdSet
let rows = 0; // backend will fail to bind so no rows will be returned
while (await reader.step()) {
rows++;
}
assert.equal(rows, 0);
props = await reader.getMetaData();
assert.equal(props.length, 12); // 11 for BisCore.element and 1 for IdSet
assert.equal(reader.stats.backendRowsReturned, 0);
assert.isTrue(reader.stats.backendCpuTime > 0);
});
it("concurrent query bind idset with invalid values in IdSet virtual table", async () => {
const ids = ["0x1", "ABC", "YZ"];
const reader = imodel1.createQueryReader("SELECT * FROM BisCore.element, IdSet(?) WHERE id = ECInstanceId ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES", QueryBinder.from([ids]));
let props = await reader.getMetaData();
assert.equal(props.length, 12); // 11 for BisCore.element and 1 for IdSet
let rows = 0; // backend will bind successfully but some of the values are not valid for IdSet VT so those values will be ignored
while (await reader.step()) {
rows++;
}
assert.equal(rows, 1);
props = await reader.getMetaData();
assert.equal(props.length, 12); // 11 for BisCore.element and 1 for IdSet
assert.equal(reader.stats.backendRowsReturned, 1);
assert.isTrue(reader.stats.backendCpuTime > 0);
});
it("concurrent query bind idset with invalid values in IdSet virtual table", async () => {
const ids = ["ABC", "0x1", "YZ"]; // as first value is not an Id so QueryBinder.from will throw error of "unsupported type"
try {
imodel1.createQueryReader("SELECT * FROM BisCore.element, IdSet(?) WHERE id = ECInstanceId ECSQLOPTIONS ENABLE_EXPERIMENTAL_FEATURES", QueryBinder.from([ids]));
}
catch (err) {
assert.equal(err.message, "unsupported type");
}
});
it("concurrent query get meta data", async () => {
const reader = imodel1.createQueryReader("SELECT * FROM BisCore.element");
let props = await reader.getMetaData();
assert.equal(props.length, 11);
let rows = 0;
while (await reader.step()) {
rows++;
}
assert.equal(rows, 46);
props = await reader.getMetaData();
assert.equal(props.length, 11);
assert.equal(reader.stats.backendRowsReturned, 46);
assert.isTrue(reader.stats.backendCpuTime > 0);
assert.isTrue(reader.stats.backendMemUsed > 1000);
});
it("concurrent query access string meta data", async () => {
let reader = imodel1.createQueryReader("SELECT e.ECClassId FROM bis.Element e");
let props = await reader.getMetaData();
assert.equal(props.length, 1);
assert.equal(props[0].accessString, "ECClassId");
reader = imodel1.createQueryReader("SELECT Model.Id, e.Model.Id, Model.RelECClassId, e.Model.RelECClassId FROM bis.Element e");
props = await reader.getMetaData();
assert.equal(props.length, 4);
assert.equal(props[0].accessString, "Model.Id");
assert.equal(props[1].accessString, "Model.Id");
assert.equal(props[2].accessString, "Model.RelECClassId");
assert.equal(props[3].accessString, "Model.RelECClassId");
reader = imodel1.createQueryReader("SELECT Origin.X, Origin.Y, TypeDefinition FROM bis.GeometricElement2d ge");
props = await reader.getMetaData();
assert.equal(props.length, 3);
assert.equal(props[0].accessString, "Origin.X");
assert.equal(props[1].accessString, "Origin.Y");
assert.equal(props[2].accessString, "TypeDefinition");
assert.equal(props[2].typeName, "navigation");
reader = imodel1.createQueryReader("SELECT 1, 1 + 6, * FROM (VALUES(1,2), (2,3))");
props = await reader.getMetaData();
assert.equal(props.length, 4);
assert.equal(props[0].accessString, "1");
assert.equal(props[0].jsonName, "1");
assert.equal(props[1].accessString, "1 + 6");
assert.equal(props[1].typeName, "double");
assert.equal(props[2].accessString, "1_1");
assert.equal(props[2].jsonName, "1_1");
assert.equal(props[3].accessString, "2");
});
it("concurrent query quota", async () => {
let reader = imodel1.createQueryReader("SELECT * FROM BisCore.element", undefined, { limit: { count: 4 } });
let rows = 0;
while (await reader.step()) {
rows++;
}
assert.equal(rows, 4);
reader = imodel1.createQueryReader("SELECT * FROM BisCore.element", undefined, { limit: { offset: 4, count: 4 } });
rows = 0;
while (await reader.step()) {
rows++;
}
assert.equal(rows, 4);
});
it("paging results", async () => {
const getRowPerPage = (nPageSize, nRowCount) => {
const nRowPerPage = nRowCount / nPageSize;
const nPages = Math.ceil(nRowPerPage);
const nRowOnLastPage = nRowCount - (Math.floor(nRowPerPage) * pageSize);
const pages = new Array(nPages).fill(pageSize);
if (nRowPerPage) {
pages[nPages - 1] = nRowOnLastPage;
}
return pages;
};
const pageSize = 5;
const query = "SELECT ECInstanceId as Id, Parent.Id as ParentId FROM BisCore.element";
const dbs = [imodel1, imodel2, imodel3, imodel4, imodel5];
const pendingRowCount = [];
for (const db of dbs) {
for await (const row of db.createQueryReader(`SELECT count(*) FROM (${query})`)) {
pendingRowCount.push(row[0]);
}
}
const rowCounts = await Promise.all(pendingRowCount);
const expected = [46, 62, 7, 7, 28];
assert.equal(rowCounts.length, expected.length);
for (let i = 0; i < expected.length; i++) {
assert.equal(rowCounts[i], expected[i]);
}
// verify row per page
for (const db of dbs) {
const i = dbs.indexOf(db);
const rowPerPage = getRowPerPage(pageSize, expected[i]);
for (let k = 0; k < rowPerPage.length; k++) {
const rs = await db.createQueryReader(query, undefined, { rowFormat: QueryRowFormat.UseJsPropertyNames, limit: { count: pageSize, offset: k * pageSize } }).toArray();
assert.equal(rs.length, rowPerPage[k]);
}
}
// verify async iterator
for (const db of dbs) {
const resultSet = [];
for await (const queryRow of db.createQueryReader(query, undefined, { rowFormat: QueryRowFormat.UseJsPropertyNames })) {
const row = queryRow.toRow();
resultSet.push(row);
assert.isTrue(Reflect.has(row, "id"));
if (Reflect.ownKeys(row).length > 1) {
assert.isTrue(Reflect.has(row, "parentId"));
const parentId = row.parentId;
assert.isTrue(Id64.isValidId64(parentId));
}
const id = row.id;
assert.isTrue(Id64.isValidId64(id));
}
const entry = dbs.indexOf(db);
assert.equal(rowCounts[entry], resultSet.length);
}
});
});
//# sourceMappingURL=ECSqlQuery.test.js.map