@itwin/core-common 3.5.0-dev.5 → 3.5.0-dev.7

package/lib/esm/ConcurrentQuery.d.ts

@@ -1,242 +1,242 @@
-/** @packageDocumentation
- * @module iModels
- */
-import { BentleyError, DbResult, Id64String, OrderedId64Iterable } from "@itwin/core-bentley";
-import { Point2d, Point3d } from "@itwin/core-geometry";
-/**
- * Specifies the format of the rows returned by the `query` and `restartQuery` methods of
- * [IModelConnection]($frontend), [IModelDb]($backend), and [ECDb]($backend).
- *
- * @public
- * @extensions
- */
-export declare enum QueryRowFormat {
-    /** Each row is an object in which each non-null column value can be accessed by its name as defined in the ECSql.
-     * Null values are omitted.
-     */
-    UseECSqlPropertyNames = 0,
-    /** Each row is an array of values accessed by an index corresponding to the property's position in the ECSql SELECT statement.
-     * Null values are included if they are followed by a non-null column, but trailing null values at the end of the array are omitted.
-     */
-    UseECSqlPropertyIndexes = 1,
-    /** Each row is an object in which each non-null column value can be accessed by a [remapped property name]($docs/learning/ECSqlRowFormat.md).
-     * This format is backwards-compatible with the format produced by iTwin.js 2.x. Null values are omitted.
-     */
-    UseJsPropertyNames = 2
-}
-/**
- * Specify limit or range of rows to return
- * @public
- * @extensions
- * */
-export interface QueryLimit {
-    /** Number of rows to return */
-    count?: number;
-    /** Offset from which to return rows */
-    offset?: number;
-}
-/** @beta */
-export interface QueryPropertyMetaData {
-    className: string;
-    generated: boolean;
-    index: number;
-    jsonName: string;
-    name: string;
-    extendType: string;
-    typeName: string;
-}
-/** @beta */
-export interface DbRuntimeStats {
-    cpuTime: number;
-    totalTime: number;
-    timeLimit: number;
-    memLimit: number;
-    memUsed: number;
-}
-/**
- * Quota hint for the query.
- * @public
- * @extensions
- * */
-export interface QueryQuota {
-    /** Max time allowed in seconds. This is hint and may not be honoured but help in prioritize request */
-    time?: number;
-    /** Max memory allowed in bytes. This is hint and may not be honoured but help in prioritize request */
-    memory?: number;
-}
-/**
- * Config for all request made to concurrent query engine.
- * @public
- * @extensions
- */
-export interface BaseReaderOptions {
-    /** Determine priority of this query default to 0, used as hint and can be overriden by backend. */
-    priority?: number;
-    /** If specified cancel last query (if any) with same restart token and queue the new query */
-    restartToken?: string;
-    /** For editing apps this can be set to true and all query will run on primary connection
-    *  his may cause slow queries execution but the most recent data changes will be visitable via query
-    */
-    usePrimaryConn?: boolean;
-    /** Restrict time or memory for query but use as hint and may be changed base on backend settings */
-    quota?: QueryQuota;
-}
-/**
- * ECSql query config
- * @public
- * @extensions
- * */
-export interface QueryOptions extends BaseReaderOptions {
-    /**
-     * default to false. It abbreviate blobs to single bytes. This help cases where wildcard is
-     * used in select clause. Use BlobReader api to read individual blob specially if its of large size.
-     * */
-    abbreviateBlobs?: boolean;
-    /**
-     * default to false. It will suppress error and will not log it. Useful in cases where we expect query
-     * can fail.
-     */
-    suppressLogErrors?: boolean;
-    /** This is used internally. If true it query will return meta data about query. */
-    includeMetaData?: boolean;
-    /** Limit range of rows returned by query*/
-    limit?: QueryLimit;
-    /**
-     * Convert ECClassId, SourceECClassId, TargetECClassId and RelClassId to respective name.
-     * When true, XXXXClassId property will be returned as className.
-     * */
-    convertClassIdsToClassNames?: boolean;
-    /**
-     * Determine row format.
-     */
-    rowFormat?: QueryRowFormat;
-}
-/** @beta */
-export declare type BlobRange = QueryLimit;
-/** @beta */
-export interface BlobOptions extends BaseReaderOptions {
-    range?: BlobRange;
-}
-/** @public */
-export declare class QueryOptionsBuilder {
-    private _options;
-    constructor(_options?: QueryOptions);
-    getOptions(): QueryOptions;
-    setPriority(val: number): this;
-    setRestartToken(val: string): this;
-    setQuota(val: QueryQuota): this;
-    setUsePrimaryConnection(val: boolean): this;
-    setAbbreviateBlobs(val: boolean): this;
-    setSuppressLogErrors(val: boolean): this;
-    setConvertClassIdsToNames(val: boolean): this;
-    setLimit(val: QueryLimit): this;
-    setRowFormat(val: QueryRowFormat): this;
-}
-/** @beta */
-export declare class BlobOptionsBuilder {
-    private _options;
-    constructor(_options?: BlobOptions);
-    getOptions(): BlobOptions;
-    setPriority(val: number): this;
-    setRestartToken(val: string): this;
-    setQuota(val: QueryQuota): this;
-    setUsePrimaryConnection(val: boolean): this;
-    setRange(val: BlobRange): this;
-}
-/** @public */
-export declare class QueryBinder {
-    private _args;
-    private verify;
-    bindBoolean(indexOrName: string | number, val: boolean): this;
-    bindBlob(indexOrName: string | number, val: Uint8Array): this;
-    bindDouble(indexOrName: string | number, val: number): this;
-    bindId(indexOrName: string | number, val: Id64String): this;
-    bindIdSet(indexOrName: string | number, val: OrderedId64Iterable): this;
-    bindInt(indexOrName: string | number, val: number): this;
-    bindStruct(indexOrName: string | number, val: object): this;
-    bindLong(indexOrName: string | number, val: number): this;
-    bindString(indexOrName: string | number, val: string): this;
-    bindNull(indexOrName: string | number): this;
-    bindPoint2d(indexOrName: string | number, val: Point2d): this;
-    bindPoint3d(indexOrName: string | number, val: Point3d): this;
-    private static bind;
-    static from(args: any[] | object | undefined): QueryBinder;
-    serialize(): object;
-}
-/** @internal */
-export declare enum DbRequestKind {
-    BlobIO = 0,
-    ECSql = 1
-}
-/** @internal */
-export declare enum DbResponseKind {
-    BlobIO = 0,
-    ECSql = 1,
-    NoResult = 2
-}
-/** @internal */
-export declare enum DbResponseStatus {
-    Done = 1,
-    Cancel = 2,
-    Partial = 3,
-    Timeout = 4,
-    QueueFull = 5,
-    Error = 100,
-    Error_ECSql_PreparedFailed = 101,
-    Error_ECSql_StepFailed = 102,
-    Error_ECSql_RowToJsonFailed = 103,
-    Error_ECSql_BindingFailed = 104,
-    Error_BlobIO_OpenFailed = 105,
-    Error_BlobIO_OutOfRange = 106
-}
-/** @internal */
-export declare enum DbValueFormat {
-    ECSqlNames = 0,
-    JsNames = 1
-}
-/** @internal */
-export interface DbRequest extends BaseReaderOptions {
-    kind?: DbRequestKind;
-}
-/** @internal */
-export interface DbQueryRequest extends DbRequest, QueryOptions {
-    valueFormat?: DbValueFormat;
-    query: string;
-    args?: object;
-}
-/** @internal */
-export interface DbBlobRequest extends DbRequest, BlobOptions {
-    className: string;
-    accessString: string;
-    instanceId: Id64String;
-}
-/** @internal */
-export interface DbResponse {
-    stats: DbRuntimeStats;
-    status: DbResponseStatus;
-    kind: DbResponseKind;
-    error?: string;
-}
-/** @internal */
-export interface DbQueryResponse extends DbResponse {
-    meta: QueryPropertyMetaData[];
-    data: any[];
-    rowCount: number;
-}
-/** @internal */
-export interface DbBlobResponse extends DbResponse {
-    data?: Uint8Array;
-    rawBlobSize: number;
-}
-/** @public */
-export declare class DbQueryError extends BentleyError {
-    readonly response: any;
-    readonly request?: any;
-    constructor(response: any, request?: any, rc?: DbResult);
-    static throwIfError(response: any, request?: any): void;
-}
-/** @internal */
-export interface DbRequestExecutor<TRequest extends DbRequest, TResponse extends DbResponse> {
-    execute(request: TRequest): Promise<TResponse>;
-}
+/** @packageDocumentation
+ * @module iModels
+ */
+import { BentleyError, DbResult, Id64String, OrderedId64Iterable } from "@itwin/core-bentley";
+import { Point2d, Point3d } from "@itwin/core-geometry";
+/**
+ * Specifies the format of the rows returned by the `query` and `restartQuery` methods of
+ * [IModelConnection]($frontend), [IModelDb]($backend), and [ECDb]($backend).
+ *
+ * @public
+ * @extensions
+ */
+export declare enum QueryRowFormat {
+    /** Each row is an object in which each non-null column value can be accessed by its name as defined in the ECSql.
+     * Null values are omitted.
+     */
+    UseECSqlPropertyNames = 0,
+    /** Each row is an array of values accessed by an index corresponding to the property's position in the ECSql SELECT statement.
+     * Null values are included if they are followed by a non-null column, but trailing null values at the end of the array are omitted.
+     */
+    UseECSqlPropertyIndexes = 1,
+    /** Each row is an object in which each non-null column value can be accessed by a [remapped property name]($docs/learning/ECSqlRowFormat.md).
+     * This format is backwards-compatible with the format produced by iTwin.js 2.x. Null values are omitted.
+     */
+    UseJsPropertyNames = 2
+}
+/**
+ * Specify limit or range of rows to return
+ * @public
+ * @extensions
+ * */
+export interface QueryLimit {
+    /** Number of rows to return */
+    count?: number;
+    /** Offset from which to return rows */
+    offset?: number;
+}
+/** @beta */
+export interface QueryPropertyMetaData {
+    className: string;
+    generated: boolean;
+    index: number;
+    jsonName: string;
+    name: string;
+    extendType: string;
+    typeName: string;
+}
+/** @beta */
+export interface DbRuntimeStats {
+    cpuTime: number;
+    totalTime: number;
+    timeLimit: number;
+    memLimit: number;
+    memUsed: number;
+}
+/**
+ * Quota hint for the query.
+ * @public
+ * @extensions
+ * */
+export interface QueryQuota {
+    /** Max time allowed in seconds. This is hint and may not be honoured but help in prioritize request */
+    time?: number;
+    /** Max memory allowed in bytes. This is hint and may not be honoured but help in prioritize request */
+    memory?: number;
+}
+/**
+ * Config for all request made to concurrent query engine.
+ * @public
+ * @extensions
+ */
+export interface BaseReaderOptions {
+    /** Determine priority of this query default to 0, used as hint and can be overriden by backend. */
+    priority?: number;
+    /** If specified cancel last query (if any) with same restart token and queue the new query */
+    restartToken?: string;
+    /** For editing apps this can be set to true and all query will run on primary connection
+    *  his may cause slow queries execution but the most recent data changes will be visitable via query
+    */
+    usePrimaryConn?: boolean;
+    /** Restrict time or memory for query but use as hint and may be changed base on backend settings */
+    quota?: QueryQuota;
+}
+/**
+ * ECSql query config
+ * @public
+ * @extensions
+ * */
+export interface QueryOptions extends BaseReaderOptions {
+    /**
+     * default to false. It abbreviate blobs to single bytes. This help cases where wildcard is
+     * used in select clause. Use BlobReader api to read individual blob specially if its of large size.
+     * */
+    abbreviateBlobs?: boolean;
+    /**
+     * default to false. It will suppress error and will not log it. Useful in cases where we expect query
+     * can fail.
+     */
+    suppressLogErrors?: boolean;
+    /** This is used internally. If true it query will return meta data about query. */
+    includeMetaData?: boolean;
+    /** Limit range of rows returned by query*/
+    limit?: QueryLimit;
+    /**
+     * Convert ECClassId, SourceECClassId, TargetECClassId and RelClassId to respective name.
+     * When true, XXXXClassId property will be returned as className.
+     * */
+    convertClassIdsToClassNames?: boolean;
+    /**
+     * Determine row format.
+     */
+    rowFormat?: QueryRowFormat;
+}
+/** @beta */
+export declare type BlobRange = QueryLimit;
+/** @beta */
+export interface BlobOptions extends BaseReaderOptions {
+    range?: BlobRange;
+}
+/** @public */
+export declare class QueryOptionsBuilder {
+    private _options;
+    constructor(_options?: QueryOptions);
+    getOptions(): QueryOptions;
+    setPriority(val: number): this;
+    setRestartToken(val: string): this;
+    setQuota(val: QueryQuota): this;
+    setUsePrimaryConnection(val: boolean): this;
+    setAbbreviateBlobs(val: boolean): this;
+    setSuppressLogErrors(val: boolean): this;
+    setConvertClassIdsToNames(val: boolean): this;
+    setLimit(val: QueryLimit): this;
+    setRowFormat(val: QueryRowFormat): this;
+}
+/** @beta */
+export declare class BlobOptionsBuilder {
+    private _options;
+    constructor(_options?: BlobOptions);
+    getOptions(): BlobOptions;
+    setPriority(val: number): this;
+    setRestartToken(val: string): this;
+    setQuota(val: QueryQuota): this;
+    setUsePrimaryConnection(val: boolean): this;
+    setRange(val: BlobRange): this;
+}
+/** @public */
+export declare class QueryBinder {
+    private _args;
+    private verify;
+    bindBoolean(indexOrName: string | number, val: boolean): this;
+    bindBlob(indexOrName: string | number, val: Uint8Array): this;
+    bindDouble(indexOrName: string | number, val: number): this;
+    bindId(indexOrName: string | number, val: Id64String): this;
+    bindIdSet(indexOrName: string | number, val: OrderedId64Iterable): this;
+    bindInt(indexOrName: string | number, val: number): this;
+    bindStruct(indexOrName: string | number, val: object): this;
+    bindLong(indexOrName: string | number, val: number): this;
+    bindString(indexOrName: string | number, val: string): this;
+    bindNull(indexOrName: string | number): this;
+    bindPoint2d(indexOrName: string | number, val: Point2d): this;
+    bindPoint3d(indexOrName: string | number, val: Point3d): this;
+    private static bind;
+    static from(args: any[] | object | undefined): QueryBinder;
+    serialize(): object;
+}
+/** @internal */
+export declare enum DbRequestKind {
+    BlobIO = 0,
+    ECSql = 1
+}
+/** @internal */
+export declare enum DbResponseKind {
+    BlobIO = 0,
+    ECSql = 1,
+    NoResult = 2
+}
+/** @internal */
+export declare enum DbResponseStatus {
+    Done = 1,
+    Cancel = 2,
+    Partial = 3,
+    Timeout = 4,
+    QueueFull = 5,
+    Error = 100,
+    Error_ECSql_PreparedFailed = 101,
+    Error_ECSql_StepFailed = 102,
+    Error_ECSql_RowToJsonFailed = 103,
+    Error_ECSql_BindingFailed = 104,
+    Error_BlobIO_OpenFailed = 105,
+    Error_BlobIO_OutOfRange = 106
+}
+/** @internal */
+export declare enum DbValueFormat {
+    ECSqlNames = 0,
+    JsNames = 1
+}
+/** @internal */
+export interface DbRequest extends BaseReaderOptions {
+    kind?: DbRequestKind;
+}
+/** @internal */
+export interface DbQueryRequest extends DbRequest, QueryOptions {
+    valueFormat?: DbValueFormat;
+    query: string;
+    args?: object;
+}
+/** @internal */
+export interface DbBlobRequest extends DbRequest, BlobOptions {
+    className: string;
+    accessString: string;
+    instanceId: Id64String;
+}
+/** @internal */
+export interface DbResponse {
+    stats: DbRuntimeStats;
+    status: DbResponseStatus;
+    kind: DbResponseKind;
+    error?: string;
+}
+/** @internal */
+export interface DbQueryResponse extends DbResponse {
+    meta: QueryPropertyMetaData[];
+    data: any[];
+    rowCount: number;
+}
+/** @internal */
+export interface DbBlobResponse extends DbResponse {
+    data?: Uint8Array;
+    rawBlobSize: number;
+}
+/** @public */
+export declare class DbQueryError extends BentleyError {
+    readonly response: any;
+    readonly request?: any;
+    constructor(response: any, request?: any, rc?: DbResult);
+    static throwIfError(response: any, request?: any): void;
+}
+/** @internal */
+export interface DbRequestExecutor<TRequest extends DbRequest, TResponse extends DbResponse> {
+    execute(request: TRequest): Promise<TResponse>;
+}
 //# sourceMappingURL=ConcurrentQuery.d.ts.map