@itwin/core-backend 5.0.0-dev.9 → 5.0.0-dev.92

package/lib/esm/ECSchemaXmlContext.js

@@ -0,0 +1,66 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module Schema
+ */
+import { assert } from "@itwin/core-bentley";
+import { IModelError } from "@itwin/core-common";
+import { IModelNative } from "./internal/NativePlatform";
+/** Context used when deserializing a [Schema]($ecschema-metadata) from an XML file.
+ * A schema may contain references to other schemas, which may reside elsewhere on the local disk than the referencing schema.
+ * The context maintains a list of directories ("search paths") to search for referenced schemas. Directories can be appended to the list via [[addSchemaPath]].
+ * When a referenced schema needs to be located, the list of directories is searched in the order in which each was added.
+ * Once located, the schema is cached to avoid performing repeated lookups in the file system.
+ * @see [[readSchemaFromXmlFile]] to deserialize a schema.
+ * @beta
+ */
+export class ECSchemaXmlContext {
+    _nativeContext;
+    /** Construct a context with an empty list of search paths. */
+    constructor() {
+        this._nativeContext = new IModelNative.platform.ECSchemaXmlContext();
+    }
+    /** @internal */
+    get nativeContext() {
+        assert(undefined !== this._nativeContext);
+        return this._nativeContext;
+    }
+    /** Append a directory to the list of directories that will be searched to locate referenced schemas.
+     * The directories are searched in the order in which they were added to the list.
+     * @param searchPath The absolute path to the directory to search.
+     */
+    addSchemaPath(searchPath) {
+        this.nativeContext.addSchemaPath(searchPath);
+    }
+    /** Set the last locater to be used when trying to find a schema
+     * @param locater Locater that should be used as the last locater when trying to find a schema
+     * @internal
+     */
+    setSchemaLocater(locater) {
+        this.nativeContext.setSchemaLocater(locater);
+    }
+    /** Adds a schema locator to the beginning of the list of locators used to search for schemas.
+     * This schema locator will be prioritized over other locators when searching for schemas in the current context.
+     * @param locater Locater to add to the current context
+     * @internal
+     */
+    setFirstSchemaLocater(locater) {
+        this.nativeContext.setFirstSchemaLocater(locater);
+    }
+    /** Deserialize a [Schema]($ecschema-metadata) from an ECSchemaXML-formatted file.
+     * @param filePath The absolute path of the XML file.
+     * @returns The JSON representation of the schema, as a [SchemaProps]($ecschema-metadata).
+     * @throws [[IModelError]] if there is a problem reading schema from the XML file
+     */
+    readSchemaFromXmlFile(filePath) {
+        const response = this.nativeContext.readSchemaFromXmlFile(filePath);
+        if (response.error) {
+            throw new IModelError(response.error.status, response.error.message);
+        }
+        assert(undefined !== response.result);
+        return JSON.parse(response.result);
+    }
+}
+//# sourceMappingURL=ECSchemaXmlContext.js.map

package/lib/esm/ECSchemaXmlContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ECSchemaXmlContext.js","sourceRoot":"","sources":["../../src/ECSchemaXmlContext.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEjD,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAQzD;;;;;;;GAOG;AACH,MAAM,OAAO,kBAAkB;IACrB,cAAc,CAAgD;IAEtE,8DAA8D;IAC9D;QACE,IAAI,CAAC,cAAc,GAAG,IAAI,YAAY,CAAC,QAAQ,CAAC,kBAAkB,EAAE,CAAC;IACvE,CAAC;IAED,gBAAgB;IAChB,IAAW,aAAa;QACtB,MAAM,CAAC,SAAS,KAAK,IAAI,CAAC,cAAc,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED;;;OAGG;IACI,aAAa,CAAC,UAAkB;QACrC,IAAI,CAAC,aAAa,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;IAC/C,CAAC;IAED;;;OAGG;IACI,gBAAgB,CAAC,OAAgE;QACtF,IAAI,CAAC,aAAa,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED;;;;OAIG;IACI,qBAAqB,CAAC,OAAgE;QAC3F,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACI,qBAAqB,CAAC,QAAgB;QAC3C,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAC;QACpE,IAAI,QAAQ,CAAC,KAAK,EAAE,CAAC;YACnB,MAAM,IAAI,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QACvE,CAAC;QAED,MAAM,CAAC,SAAS,KAAK,QAAQ,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACrC,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module Schema\n */\n\nimport { assert } from \"@itwin/core-bentley\";\nimport { IModelError } from \"@itwin/core-common\";\nimport { IModelJsNative } from \"@bentley/imodeljs-native\";\nimport { IModelNative } from \"./internal/NativePlatform\";\n\n/** @internal */\nexport type SchemaKey = IModelJsNative.ECSchemaXmlContext.SchemaKey;\n\n/** @internal */\nexport type SchemaMatchType = IModelJsNative.ECSchemaXmlContext.SchemaMatchType;\n\n/** Context used when deserializing a [Schema]($ecschema-metadata) from an XML file.\n * A schema may contain references to other schemas, which may reside elsewhere on the local disk than the referencing schema.\n * The context maintains a list of directories (\"search paths\") to search for referenced schemas. Directories can be appended to the list via [[addSchemaPath]].\n * When a referenced schema needs to be located, the list of directories is searched in the order in which each was added.\n * Once located, the schema is cached to avoid performing repeated lookups in the file system.\n * @see [[readSchemaFromXmlFile]] to deserialize a schema.\n * @beta\n */\nexport class ECSchemaXmlContext {\n  private _nativeContext: IModelJsNative.ECSchemaXmlContext | undefined;\n\n  /** Construct a context with an empty list of search paths. */\n  constructor() {\n    this._nativeContext = new IModelNative.platform.ECSchemaXmlContext();\n  }\n\n  /** @internal */\n  public get nativeContext(): IModelJsNative.ECSchemaXmlContext {\n    assert(undefined !== this._nativeContext);\n    return this._nativeContext;\n  }\n\n  /** Append a directory to the list of directories that will be searched to locate referenced schemas.\n   * The directories are searched in the order in which they were added to the list.\n   * @param searchPath The absolute path to the directory to search.\n   */\n  public addSchemaPath(searchPath: string): void {\n    this.nativeContext.addSchemaPath(searchPath);\n  }\n\n  /** Set the last locater to be used when trying to find a schema\n   * @param locater Locater that should be used as the last locater when trying to find a schema\n   * @internal\n   */\n  public setSchemaLocater(locater: IModelJsNative.ECSchemaXmlContext.SchemaLocaterCallback): void {\n    this.nativeContext.setSchemaLocater(locater);\n  }\n\n  /** Adds a schema locator to the beginning of the list of locators used to search for schemas.\n   * This schema locator will be prioritized over other locators when searching for schemas in the current context.\n   * @param locater Locater to add to the current context\n   * @internal\n   */\n  public setFirstSchemaLocater(locater: IModelJsNative.ECSchemaXmlContext.SchemaLocaterCallback): void {\n    this.nativeContext.setFirstSchemaLocater(locater);\n  }\n\n  /** Deserialize a [Schema]($ecschema-metadata) from an ECSchemaXML-formatted file.\n   * @param filePath The absolute path of the XML file.\n   * @returns The JSON representation of the schema, as a [SchemaProps]($ecschema-metadata).\n   * @throws [[IModelError]] if there is a problem reading schema from the XML file\n   */\n  public readSchemaFromXmlFile(filePath: string): any {\n    const response = this.nativeContext.readSchemaFromXmlFile(filePath);\n    if (response.error) {\n      throw new IModelError(response.error.status, response.error.message);\n    }\n\n    assert(undefined !== response.result);\n    return JSON.parse(response.result);\n  }\n}\n"]}

package/lib/esm/ECSqlStatement.d.ts

@@ -0,0 +1,492 @@
+/** @packageDocumentation
+ * @module ECSQL
+ */
+import { DbResult, GuidString, Id64String } from "@itwin/core-bentley";
+import { LowAndHighXYZ, XAndY, XYAndZ } from "@itwin/core-geometry";
+import { ECSqlValueType, NavigationBindingValue, NavigationValue, QueryRowFormat } from "@itwin/core-common";
+import { IModelJsNative } from "@bentley/imodeljs-native";
+/** The result of an **ECSQL INSERT** statement as returned from [ECSqlStatement.stepForInsert]($backend).
+ *
+ * If the step was successful, the ECSqlInsertResult contains
+ * [DbResult.BE_SQLITE_DONE]($core-bentley)
+ * and the ECInstanceId of the newly created instance.
+ * In case of failure it contains the [DbResult]($core-bentley) error code.
+ *
+ * > Insert statements can be used with ECDb only, not with IModelDb.
+ * @public
+ */
+export declare class ECSqlInsertResult {
+    status: DbResult;
+    id?: Id64String | undefined;
+    constructor(status: DbResult, id?: Id64String | undefined);
+}
+/**
+ * Arguments supplied to [[ECSqlStatement.getRow]].
+ * @public
+ * */
+export interface ECSqlRowArg {
+    /** Determine row format. */
+    rowFormat?: QueryRowFormat;
+    /**
+     * Determine if classIds are converted to class names.
+     */
+    classIdsToClassNames?: boolean;
+}
+/** Executes ECSQL statements.
+ *
+ * A statement must be prepared before it can be executed, and it must be released when no longer needed.
+ * See [IModelDb.withPreparedStatement]($backend) or
+ * [ECDb.withPreparedStatement]($backend) for a convenient and
+ * reliable way to prepare, execute, and then release a statement.
+ *
+ * A statement may contain parameters that must be filled in before use by the **bind** methods.
+ *
+ * Once prepared (and parameters are bound, if any), the statement is executed by calling [ECSqlStatement.step]($backend).
+ * In case of an **ECSQL SELECT** statement, the current row can be retrieved with [ECSqlStatement.getRow]($backend) as
+ * a whole, or with [ECSqlStatement.getValue]($backend) when individual values are needed.
+ * Alternatively, query results of an **ECSQL SELECT** statement can be stepped through by using
+ * standard iteration syntax, such as `for of`.
+ *
+ * > Preparing a statement can be time-consuming. The best way to reduce the effect of this overhead is to cache and reuse prepared
+ * > statements. A cached prepared statement may be used in different places in an app, as long as the statement is general enough.
+ * > The key to making this strategy work is to phrase a statement in a general way and use placeholders to represent parameters that will vary on each use.
+ *
+ * See also
+ * - [Executing ECSQL]($docs/learning/backend/ExecutingECSQL) provides more background on ECSQL and an introduction on how to execute ECSQL with the iTwin.js API.
+ * - [Code Examples]($docs/learning/backend/ECSQLCodeExamples) illustrate the use of the iTwin.js API for executing and working with ECSQL
+ * @public
+ */
+export declare class ECSqlStatement implements IterableIterator<any>, Disposable {
+    private _stmt;
+    private _sql;
+    private _props;
+    get sql(): string;
+    /** Check if this statement has been prepared successfully or not */
+    get isPrepared(): boolean;
+    /** Prepare this statement prior to first use.
+     * @param db The DgnDb or ECDb to prepare the statement against
+     * @param ecsql The ECSQL statement string to prepare
+     * @param logErrors Determine if errors are logged or not
+     * @throws [IModelError]($common) if the ECSQL statement cannot be prepared. Normally, prepare fails due to ECSQL syntax errors or references to tables or properties that do not exist.
+     * The error.message property will provide details.
+     * @internal
+     */
+    prepare(db: IModelJsNative.DgnDb | IModelJsNative.ECDb, ecsql: string, logErrors?: boolean): void;
+    /** Prepare this statement prior to first use.
+     * @param db The DgnDb or ECDb to prepare the statement against
+     * @param ecsql The ECSQL statement string to prepare
+     * @param logErrors Determine if errors are logged or not, its set to false by default for tryPrepare()
+     * @returns An object with a `status` member equal to [DbResult.BE_SQLITE_OK]($bentley) on success. Upon error, the `message` member will provide details.
+     * @internal
+     */
+    tryPrepare(db: IModelJsNative.DgnDb | IModelJsNative.ECDb, ecsql: string, logErrors?: boolean): {
+        status: DbResult;
+        message: string;
+    };
+    /** Reset this statement so that the next call to step will return the first row, if any. */
+    reset(): void;
+    /** Get the Native SQL statement
+     * @internal
+     */
+    getNativeSql(): string;
+    /** Call this function when finished with this statement. This releases the native resources held by the statement.
+     *
+     * > Do not call this method directly on a statement that is being managed by a statement cache.
+     */
+    [Symbol.dispose](): void;
+    /** @deprecated in 5.0 Use [Symbol.dispose] instead. */
+    dispose(): void;
+    /** Binds the specified value to the specified ECSQL parameter.
+     * The section "[iTwin.js Types used in ECSQL Parameter Bindings]($docs/learning/ECSQLParameterTypes)" describes the
+     * iTwin.js types to be used for the different ECSQL parameter types.
+     * @param parameter Index (1-based) or name of the parameter
+     */
+    bindValue(parameter: number | string, val: any): void;
+    /** Binds null to the specified ECSQL parameter.
+     * @param parameter Index (1-based) or name of the parameter
+     */
+    bindNull(parameter: number | string): void;
+    /** Binds a BLOB value to the specified ECSQL parameter.
+     * @param parameter Index (1-based) or name of the parameter
+     * @param BLOB value as either a Uint8Array, ArrayBuffer or a Base64 string
+     */
+    bindBlob(parameter: number | string, blob: string | Uint8Array | ArrayBuffer | SharedArrayBuffer): void;
+    /** Binds a boolean value to the specified ECSQL parameter.
+     * @param parameter Index (1-based) or name of the parameter
+     * @param val Boolean value
+     */
+    bindBoolean(parameter: number | string, val: boolean): void;
+    /** Binds a DateTime value to the specified ECSQL parameter.
+     * @param parameter Index (1-based) or name of the parameter
+     * @param isoDateTimeString DateTime value as ISO8601 string
+     */
+    bindDateTime(parameter: number | string, isoDateTimeString: string): void;
+    /** Binds a double value to the specified ECSQL parameter.
+     * @param parameter Index (1-based) or name of the parameter
+     * @param val Double value
+     */
+    bindDouble(parameter: number | string, val: number): void;
+    /** Binds an GUID value to the specified ECSQL parameter.
+     * @param parameter Index (1-based) or name of the parameter
+     * @param val GUID value
+     */
+    bindGuid(parameter: number | string, val: GuidString): void;
+    /** Binds an Id value to the specified ECSQL parameter.
+     * @param parameter Index (1-based) or name of the parameter
+     * @param val Id value
+     */
+    bindId(parameter: number | string, val: Id64String): void;
+    /** Binds an integer value to the specified ECSQL parameter.
+     * @param parameter Index (1-based) or name of the parameter
+     * @param val Integer value as number, decimal string or hexadecimal string.
+     */
+    bindInteger(parameter: number | string, val: number | string): void;
+    /** Binds an Point2d value to the specified ECSQL parameter.
+     * @param parameter Index (1-based) or name of the parameter
+     * @param val Point2d value
+     */
+    bindPoint2d(parameter: number | string, val: XAndY): void;
+    /** Binds an Point3d value to the specified ECSQL parameter.
+     * @param parameter Index (1-based) or name of the parameter
+     * @param val Point3d value
+     */
+    bindPoint3d(parameter: number | string, val: XYAndZ): void;
+    /** Binds a Range3d as a blob to the specified ECSQL parameter
+     * @param parameter Index(1-based) or name of the parameter
+     * @param val Range3d value
+     */
+    bindRange3d(parameter: number | string, val: LowAndHighXYZ): void;
+    /** Binds an string to the specified ECSQL parameter.
+     * @param parameter Index (1-based) or name of the parameter
+     * @param val String value
+     */
+    bindString(parameter: number | string, val: string): void;
+    /** Binds a navigation property value to the specified ECSQL parameter.
+     * @param parameter Index (1-based) or name of the parameter
+     * @param val Navigation property value
+     */
+    bindNavigation(parameter: number | string, val: NavigationBindingValue): void;
+    /** Binds a struct property value to the specified ECSQL parameter.
+     * @param parameter Index (1-based) or name of the parameter
+     * @param val Struct value. The struct value is an object composed of pairs of a struct member property name and its value
+     * (of one of the supported types)
+     */
+    bindStruct(parameter: number | string, val: object): void;
+    /** Binds an array value to the specified ECSQL parameter.
+     * @param parameter Index (1-based) or name of the parameter
+     * @param val Array value. The array value is an array of values of the supported types
+     */
+    bindArray(parameter: number | string, val: any[]): void;
+    bindIdSet(parameter: number | string, val: Id64String[]): void;
+    /**
+     * Gets a binder to bind a value for an ECSQL parameter
+     * > This is the most low-level API to bind a value to a specific parameter. Alternatively you can use the ECSqlStatement.bindXX methods
+     * > or [ECSqlStatement.bindValues]($backend).
+     * @param parameter Index (1-based) or name of the parameter
+     */
+    getBinder(parameter: string | number): ECSqlBinder;
+    /** Bind values to all parameters in the statement.
+     * @param values The values to bind to the parameters.
+     * Pass an *array* of values if the parameters are *positional*.
+     * Pass an *object of the values keyed on the parameter name* for *named parameters*.
+     * The values in either the array or object must match the respective types of the parameter.
+     *
+     * The section "[iTwin.js Types used in ECSQL Parameter Bindings]($docs/learning/ECSQLParameterTypes)" describes the
+     * iTwin.js types to be used for the different ECSQL parameter types.
+     *
+     * See also these [Code Samples]($docs/learning/backend/ECSQLCodeExamples#binding-to-all-parameters-at-once)
+     */
+    bindValues(values: any[] | object): void;
+    /** Clear any bindings that were previously set on this statement.
+     * @throws [IModelError]($common) in case of errors
+     */
+    clearBindings(): void;
+    /** Step this statement to the next row.
+     *
+     *  For **ECSQL SELECT** statements the method returns
+     *  - [DbResult.BE_SQLITE_ROW]($core-bentley) if the statement now points successfully to the next row.
+     *  - [DbResult.BE_SQLITE_DONE]($core-bentley) if the statement has no more rows.
+     *  - Error status in case of errors.
+     *
+     *  For **ECSQL INSERT, UPDATE, DELETE** statements the method returns
+     *  - [DbResult.BE_SQLITE_DONE]($core-bentley) if the statement has been executed successfully.
+     *  - Error status in case of errors.
+     *
+     *  >  Insert statements can be used with ECDb only, not with IModelDb.
+     *
+     * See also: [Code Samples]($docs/learning/backend/ECSQLCodeExamples)
+     */
+    step(): DbResult;
+    /** @internal added this back in for testing purposes */
+    stepAsync(): Promise<DbResult>;
+    /** Step this INSERT statement and returns status and the ECInstanceId of the newly
+     * created instance.
+     *
+     * > Insert statements can be used with ECDb only, not with IModelDb.
+     *
+     * @returns Returns the generated ECInstanceId in case of success and the status of the step
+     * call. In case of error, the respective error code is returned.
+     */
+    stepForInsert(): ECSqlInsertResult;
+    /** Get the query result's column count (only for ECSQL SELECT statements). */
+    getColumnCount(): number;
+    /** Get the current row.
+     * The returned row is formatted as JavaScript object where every SELECT clause item becomes a property in the JavaScript object.
+     *
+     * See also:
+     * - [ECSQL row format]($docs/learning/ECSQLRowFormat) for details about the format of the returned row.
+     * - [Code Samples]($docs/learning/backend/ECSQLCodeExamples#working-with-the-query-result)
+     */
+    getRow(args?: ECSqlRowArg): any;
+    private formatCurrentRow;
+    /** Calls step when called as an iterator.
+     *
+     *  Each iteration returns an [ECSQL row format]($docs/learning/ECSQLRowFormat) as returned
+     *  from [ECSqlStatement.getRow]($backend).
+     */
+    next(): IteratorResult<any>;
+    /** The iterator that will step through the results of this statement. */
+    [Symbol.iterator](): IterableIterator<any>;
+    /** Get the value for the column at the given index in the query result.
+     * @param columnIx Index of ECSQL column in query result (0-based)
+     *
+     * See also: [Code Samples]($docs/learning/backend/ECSQLCodeExamples#working-with-the-query-result)
+     */
+    getValue(columnIx: number): ECSqlValue;
+}
+/** Binds a value to an ECSQL parameter.
+ *
+ * See also:
+ *
+ * - [ECSqlStatement]($backend)
+ * - [ECSqlStatement.getBinder]($backend)
+ * - [Executing ECSQL]($docs/learning/backend/ExecutingECSQL)
+ * @public
+ */
+export declare class ECSqlBinder {
+    private _binder;
+    /** @internal */
+    constructor(binder: IModelJsNative.ECSqlBinder);
+    /** Binds the specified value to the ECSQL parameter.
+     * The section "[iTwin.js Types used in ECSQL Parameter Bindings]($docs/learning/ECSQLParameterTypes)" describes the
+     * iTwin.js types to be used for the different ECSQL parameter types.
+     * @param val Value to bind
+     */
+    bind(val: any): void;
+    /** Binds null to the ECSQL parameter. */
+    bindNull(): void;
+    /** Binds a BLOB value to the ECSQL parameter.
+     * @param BLOB value as either a UInt8Array, ArrayBuffer or a Base64 string
+     */
+    bindBlob(blob: string | Uint8Array | ArrayBuffer | SharedArrayBuffer): void;
+    /** Binds a boolean value to the ECSQL parameter.
+     * @param val Boolean value
+     */
+    bindBoolean(val: boolean): void;
+    /** Binds a DateTime value to the ECSQL parameter.
+     * @param isoDateTimeString DateTime value as ISO8601 string
+     */
+    bindDateTime(isoDateTimeString: string): void;
+    /** Binds a double value to the ECSQL parameter.
+     * @param val Double value
+     */
+    bindDouble(val: number): void;
+    /** Binds an GUID value to the ECSQL parameter.
+     * @param val GUID value. If passed as string, it must be formatted as described in [GuidString]($core-bentley).
+     */
+    bindGuid(val: GuidString): void;
+    /** Binds an Id value to the ECSQL parameter.
+     * @param val Id value. If passed as string it must be the hexadecimal representation of the Id.
+     */
+    bindId(val: Id64String): void;
+    /** Binds an integer value to the ECSQL parameter.
+     * @param val Integer value as number, decimal string or hexadecimal string.
+     */
+    bindInteger(val: number | string): void;
+    /** Binds an Point2d value to the ECSQL parameter.
+     * @param val Point2d value
+     */
+    bindPoint2d(val: XAndY): void;
+    /** Binds an Point3d value to the ECSQL parameter.
+     * @param val Point3d value
+     */
+    bindPoint3d(val: XYAndZ): void;
+    /** Binds a Range3d as a blob to the ECSQL parameter.
+     * @param val Range3d value
+     */
+    bindRange3d(val: LowAndHighXYZ): void;
+    /** Binds an string to the ECSQL parameter.
+     * @param val String value
+     */
+    bindString(val: string): void;
+    /** Binds a navigation property value to the ECSQL parameter.
+     * @param val Navigation property value
+     */
+    bindNavigation(val: NavigationBindingValue): void;
+    /** Binds a struct property value to the ECSQL parameter.
+     * @param val Struct value. The struct value is an object composed of pairs of a struct member property name and its value
+     * (of one of the supported types)
+     */
+    bindStruct(val: object): void;
+    /** Gets the binder for the specified member of a struct parameter
+     *
+     * > This is the most low-level way to bind struct parameters with most flexibility. A simpler alternative is
+     * > to just call [ECSqlBinder.bindStruct]($backend).
+     */
+    bindMember(memberName: string): ECSqlBinder;
+    /** Binds a set of Id strings to the ECSQL parameter.
+     * @param val array of Id values. If passed as string they must be the hexadecimal representation of the Ids.
+     */
+    bindIdSet(vector: Id64String[]): void;
+    /** Binds an array value to the ECSQL parameter.
+     * @param val Array value. The array value is an array of values of the supported types
+     */
+    bindArray(val: any[]): void;
+    /** Adds a new array element to the array parameter and returns the binder for the new array element
+     *
+     * > This is the most low-level way to bind array parameters with most flexibility. A simpler alternative is
+     * > to just call [ECSqlBinder.bindArray]($backend).
+     */
+    addArrayElement(): ECSqlBinder;
+}
+/** Represents the value of an ECEnumeration.
+ *
+ * See also:
+ * - [[ECSqlValue.getEnum]]
+ * - [[ECSqlStatement]]
+ * - [[ECSqlStatement.getValue]]
+ * - [Code Samples]($docs/learning/backend/ECSQLCodeExamples#working-with-the-query-result)
+ * @public
+ */
+export interface ECEnumValue {
+    schema: string;
+    name: string;
+    key: string;
+    value: number | string;
+}
+/** Value of a column in a row of an ECSQL query result.
+ *
+ * See also:
+ * - [ECSqlStatement]($backend)
+ * - [ECSqlStatement.getValue]($backend)
+ * - [Code Samples]($docs/learning/backend/ECSQLCodeExamples#working-with-the-query-result)
+ * @public
+ */
+export declare class ECSqlValue {
+    private _val;
+    /** @internal */
+    constructor(val: IModelJsNative.ECSqlValue);
+    /** Get information about the query result's column this value refers to. */
+    get columnInfo(): ECSqlColumnInfo;
+    /** Get the value of this ECSQL value */
+    get value(): any;
+    /** Indicates whether the value is NULL or not. */
+    get isNull(): boolean;
+    /** Get the value as BLOB */
+    getBlob(): Uint8Array;
+    /** Get the value as a boolean value */
+    getBoolean(): boolean;
+    /** Get the value as a DateTime value (formatted as ISO8601 string) */
+    getDateTime(): string;
+    /** Get the value as a double value */
+    getDouble(): number;
+    /** Get the value as a IGeometry value (as ECJSON IGeometry) */
+    getGeometry(): any;
+    /** Get the value as a GUID (formatted as GUID string).
+     *  See [GuidString]($core-bentley)
+     */
+    getGuid(): GuidString;
+    /** Get the value as a Id (formatted as hexadecimal string). */
+    getId(): Id64String;
+    /** Get the ClassId value formatted as fully qualified class name. */
+    getClassNameForClassId(): string;
+    /** Get the value as a integer value */
+    getInteger(): number;
+    /** Get the value as a string value */
+    getString(): string;
+    /** Get the value as [XAndY]($core-geometry) */
+    getXAndY(): XAndY;
+    /** Get the value as [XYAndZ]($core-geometry) */
+    getXYAndZ(): XYAndZ;
+    /** Get the value as ECEnumeration value
+     *  Note: This method is optional. Using [[ECSqlValue.getInteger]] for integral enums and
+     *  [[ECSqlValue.getString]] for string enums respectively are the usual way to get
+     *  enum values. This method can be used if the context of the underlying ECEnumeration
+     *  is required.
+     *  The value is broken down into the ECEnumerators that make it up, if the value
+     *  is a combination of ECEnumerators. If the value is not a strict match of an ECEnumerator
+     *  or a combination of them, undefined is returned.
+     *  > Note: You can call [[ECSqlValue.columnInfo.isEnum]] to find out whether
+     *  > this method can be called or not.
+     *  @return ECEnumeration value(s) or undefined if the ECSqlValue does not represent an ECEnumeration.
+     *  or is not a strict match of an ECEnumerator or a combination of them.
+     */
+    getEnum(): ECEnumValue[] | undefined;
+    /** Get the value as [NavigationValue]($common) */
+    getNavigation(): NavigationValue;
+    /** Get an iterator for iterating the struct members of this struct value. */
+    getStructIterator(): ECSqlValueIterator;
+    /** Get this struct value's content as object literal */
+    getStruct(): any;
+    /** Get an iterator for iterating the array elements of this array value. */
+    getArrayIterator(): ECSqlValueIterator;
+    /** Get this array value as JavaScript array */
+    getArray(): any[];
+}
+/** Iterator over members of a struct [ECSqlValue]($backend) or the elements of an array [ECSqlValue]($backend).
+ * See [ECSqlValue.getStructIterator]($backend) or [ECSqlValue.getArrayIterator]($backend).
+ * @public
+ */
+export declare class ECSqlValueIterator implements IterableIterator<ECSqlValue> {
+    private _it;
+    /** @internal */
+    constructor(it: IModelJsNative.ECSqlValueIterator);
+    next(): IteratorResult<ECSqlValue>;
+    [Symbol.iterator](): IterableIterator<ECSqlValue>;
+}
+/** Information about an ECSQL column in an ECSQL query result.
+ * See [ECSqlValue.columnInfo]($backend), [ECSqlStatement.getValue]($backend), [ECSqlStatement]($backend)
+ * @public
+ */
+export interface ECSqlColumnInfo {
+    /** Gets the data type of the column.
+     */
+    getType(): ECSqlValueType;
+    /** Gets the name of the property backing the column.
+     * > If this column is backed by a generated property, i.e. it represents ECSQL expression,
+     * > the access string consists of the name of the generated property. [[ECSqlColumnInfo.getOriginPropertyName]]
+     * > can be used to obtain the non-aliased name in that case.
+     */
+    getPropertyName(): string;
+    /** Gets the name of the original property that the column data is from.
+     * > Other than [[ECSqlColumnInfo.getPropertyName]], this ignores aliases and allows getting the name
+     * > of the property which is being used for the column. A column may not be backed
+     * > by a property, in which case this returns undefined.
+     */
+    getOriginPropertyName(): string | undefined;
+    /** Gets the full access string to the corresponding ECSqlValue starting from the root class.
+     * > If this column is backed by a generated property, i.e. it represents ECSQL expression,
+     * > the access string consists of the ECSQL expression.
+     */
+    getAccessString(): string;
+    /** Indicates whether the column refers to an ECEnumeration property. */
+    isEnum(): boolean;
+    /** Indicates whether the column refers to a system property (e.g. id, className). */
+    isSystemProperty(): boolean;
+    /** Indicates whether the column is backed by a generated property or not. For SELECT clause items that are expressions other
+     * than simply a reference to an ECProperty, a property is generated containing the expression name.
+     */
+    isGeneratedProperty(): boolean;
+    /** Gets the table space in which this root class is persisted.
+     * > For classes in the primary file the table space is MAIN. For classes in attached
+     * > files, the table space is the name by which the file was attached. For generated properties the table space is empty.
+     */
+    getRootClassTableSpace(): string;
+    /** Gets the fully qualified name of the ECClass of the top-level ECProperty backing this column. */
+    getRootClassName(): string;
+    /** Gets the class alias of the root class to which the column refers to.
+     * > Returns an empty string if no class alias was specified in the select clause.
+     */
+    getRootClassAlias(): string;
+}
+//# sourceMappingURL=ECSqlStatement.d.ts.map

package/lib/esm/ECSqlStatement.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ECSqlStatement.d.ts","sourceRoot":"","sources":["../../src/ECSqlStatement.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAU,QAAQ,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAE,aAAa,EAAW,KAAK,EAAE,MAAM,EAAO,MAAM,sBAAsB,CAAC;AAClF,OAAO,EAAa,cAAc,EAAe,sBAAsB,EAAE,eAAe,EAAuB,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAC1J,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAI1D;;;;;;;;;GASG;AACH,qBAAa,iBAAiB;IACF,MAAM,EAAE,QAAQ;IAAS,EAAE,CAAC,EAAE,UAAU;gBAAxC,MAAM,EAAE,QAAQ,EAAS,EAAE,CAAC,EAAE,UAAU,YAAA;CACnE;AAED;;;KAGK;AACL,MAAM,WAAW,WAAW;IAC1B,4BAA4B;IAC5B,SAAS,CAAC,EAAE,cAAc,CAAC;IAC3B;;OAEG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,cAAe,YAAW,gBAAgB,CAAC,GAAG,CAAC,EAAE,UAAU;IACtE,OAAO,CAAC,KAAK,CAA4C;IACzD,OAAO,CAAC,IAAI,CAAqB;IACjC,OAAO,CAAC,MAAM,CAA+B;IAE7C,IAAW,GAAG,WAAyB;IAEvC,oEAAoE;IACpE,IAAW,UAAU,IAAI,OAAO,CAAyB;IAEzD;;;;;;;OAOG;IACI,OAAO,CAAC,EAAE,EAAE,cAAc,CAAC,KAAK,GAAG,cAAc,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,UAAO,GAAG,IAAI;IAOrG;;;;;;OAMG;IACI,UAAU,CAAC,EAAE,EAAE,cAAc,CAAC,KAAK,GAAG,cAAc,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,UAAQ,GAAG;QAAE,MAAM,EAAE,QAAQ,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE;IAQ1I,4FAA4F;IACrF,KAAK,IAAI,IAAI;IAMpB;;OAEG;IACI,YAAY,IAAI,MAAM;IAK7B;;;OAGG;IACI,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI;IAO/B,uDAAuD;IAChD,OAAO,IAAI,IAAI;IAItB;;;;OAIG;IACI,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,GAAG,GAAG,IAAI;IAE5D;;OAEG;IACI,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAEjD;;;OAGG;IACI,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,iBAAiB,GAAG,IAAI;IAE9G;;;OAGG;IACI,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,OAAO,GAAG,IAAI;IAElE;;;OAGG;IACI,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,iBAAiB,EAAE,MAAM,GAAG,IAAI;IAEhF;;;OAGG;IACI,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAEhE;;;OAGG;IACI,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,UAAU,GAAG,IAAI;IAElE;;;OAGG;IACI,MAAM,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,UAAU,GAAG,IAAI;IAEhE;;;OAGG;IACI,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAE1E;;;OAGG;IACI,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,KAAK,GAAG,IAAI;IAEhE;;;OAGG;IACI,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAEjE;;;OAGG;IACI,WAAW,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,aAAa,GAAG,IAAI;IAExE;;;OAGG;IACI,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAEhE;;;OAGG;IACI,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,sBAAsB,GAAG,IAAI;IAEpF;;;;OAIG;IACI,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAEhE;;;OAGG;IACI,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI;IAEvD,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,IAAI;IACrE;;;;;OAKG;IACI,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,MAAM,GAAG,WAAW;IAKzD;;;;;;;;;;OAUG;IACI,UAAU,CAAC,MAAM,EAAE,GAAG,EAAE,GAAG,MAAM,GAAG,IAAI;IAuB/C;;OAEG;IACI,aAAa,IAAI,IAAI;IAQ5B;;;;;;;;;;;;;;OAcG;IACI,IAAI,IAAI,QAAQ;IAEvB,wDAAwD;IAC3C,SAAS,IAAI,OAAO,CAAC,QAAQ,CAAC;IAM3C;;;;;;;OAOG;IACI,aAAa,IAAI,iBAAiB;IASzC,8EAA8E;IACvE,cAAc,IAAI,MAAM;IAE/B;;;;;;OAMG;IACI,MAAM,CAAC,IAAI,CAAC,EAAE,WAAW,GAAG,GAAG;IAoBtC,OAAO,CAAC,gBAAgB;IA0BxB;;;;OAIG;IACI,IAAI,IAAI,cAAc,CAAC,GAAG,CAAC;IAclC,yEAAyE;IAClE,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,GAAG,CAAC;IAEjD;;;;OAIG;IACI,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,UAAU;CAI9C;AAED;;;;;;;;GAQG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,OAAO,CAA6B;IAE5C,gBAAgB;gBACG,MAAM,EAAE,cAAc,CAAC,WAAW;IAErD;;;;OAIG;IACI,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,IAAI;IAI3B,yCAAyC;IAClC,QAAQ,IAAI,IAAI;IAMvB;;OAEG;IACI,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,iBAAiB,GAAG,IAAI;IAMlF;;OAEG;IACI,WAAW,CAAC,GAAG,EAAE,OAAO,GAAG,IAAI;IAMtC;;OAEG;IACI,YAAY,CAAC,iBAAiB,EAAE,MAAM,GAAG,IAAI;IAMpD;;OAEG;IACI,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAMpC;;OAEG;IACI,QAAQ,CAAC,GAAG,EAAE,UAAU,GAAG,IAAI;IAMtC;;OAEG;IACI,MAAM,CAAC,GAAG,EAAE,UAAU,GAAG,IAAI;IAMpC;;OAEG;IACI,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI;IAM9C;;OAEG;IACI,WAAW,CAAC,GAAG,EAAE,KAAK,GAAG,IAAI;IAMpC;;OAEG;IACI,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAMrC;;OAEG;IACI,WAAW,CAAC,GAAG,EAAE,aAAa,GAAG,IAAI;IAM5C;;OAEG;IACI,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAMpC;;OAEG;IACI,cAAc,CAAC,GAAG,EAAE,sBAAsB,GAAG,IAAI;IAMxD;;;OAGG;IACI,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAEpC;;;;OAIG;IACI,UAAU,CAAC,UAAU,EAAE,MAAM,GAAG,WAAW;IAElD;;OAEG;IACI,SAAS,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI;IAM5C;;OAEG;IACI,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI;IAElC;;;;OAIG;IACI,eAAe,IAAI,WAAW;CACtC;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,GAAG,MAAM,CAAC;CACxB;AAED;;;;;;;GAOG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,IAAI,CAA4B;IAExC,gBAAgB;gBACG,GAAG,EAAE,cAAc,CAAC,UAAU;IAEjD,4EAA4E;IAC5E,IAAW,UAAU,IAAI,eAAe,CAAyD;IAEjG,wCAAwC;IACxC,IAAW,KAAK,IAAI,GAAG,CAA4C;IAEnE,kDAAkD;IAClD,IAAW,MAAM,IAAI,OAAO,CAA+B;IAC3D,4BAA4B;IACrB,OAAO,IAAI,UAAU;IAC5B,uCAAuC;IAChC,UAAU,IAAI,OAAO;IAC5B,sEAAsE;IAC/D,WAAW,IAAI,MAAM;IAC5B,sCAAsC;IAC/B,SAAS,IAAI,MAAM;IAC1B,+DAA+D;IACxD,WAAW,IAAI,GAAG;IACzB;;OAEG;IACI,OAAO,IAAI,UAAU;IAC5B,+DAA+D;IACxD,KAAK,IAAI,UAAU;IAC1B,qEAAqE;IAC9D,sBAAsB,IAAI,MAAM;IACvC,uCAAuC;IAChC,UAAU,IAAI,MAAM;IAC3B,sCAAsC;IAC/B,SAAS,IAAI,MAAM;IAC1B,+CAA+C;IACxC,QAAQ,IAAI,KAAK;IACxB,gDAAgD;IACzC,SAAS,IAAI,MAAM;IAC1B;;;;;;;;;;;;OAYG;IACI,OAAO,IAAI,WAAW,EAAE,GAAG,SAAS;IAE3C,kDAAkD;IAC3C,aAAa,IAAI,eAAe;IAEvC,6EAA6E;IACtE,iBAAiB,IAAI,kBAAkB;IAE9C,wDAAwD;IACjD,SAAS,IAAI,GAAG;IAEvB,4EAA4E;IACrE,gBAAgB,IAAI,kBAAkB;IAE7C,+CAA+C;IACxC,QAAQ,IAAI,GAAG,EAAE;CACzB;AAED;;;GAGG;AACH,qBAAa,kBAAmB,YAAW,gBAAgB,CAAC,UAAU,CAAC;IACrE,OAAO,CAAC,GAAG,CAAoC;IAE/C,gBAAgB;gBACG,EAAE,EAAE,cAAc,CAAC,kBAAkB;IAEjD,IAAI,IAAI,cAAc,CAAC,UAAU,CAAC;IAOlC,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,UAAU,CAAC;CACzD;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;OACG;IACH,OAAO,IAAI,cAAc,CAAC;IAE1B;;;;OAIG;IACH,eAAe,IAAI,MAAM,CAAC;IAE1B;;;;OAIG;IACH,qBAAqB,IAAI,MAAM,GAAG,SAAS,CAAC;IAE5C;;;OAGG;IACH,eAAe,IAAI,MAAM,CAAC;IAE1B,wEAAwE;IACxE,MAAM,IAAI,OAAO,CAAC;IAElB,qFAAqF;IACrF,gBAAgB,IAAI,OAAO,CAAC;IAE5B;;OAEG;IACH,mBAAmB,IAAI,OAAO,CAAC;IAE/B;;;OAGG;IACH,sBAAsB,IAAI,MAAM,CAAC;IAEjC,oGAAoG;IACpG,gBAAgB,IAAI,MAAM,CAAC;IAE3B;;OAEG;IACH,iBAAiB,IAAI,MAAM,CAAC;CAC7B"}