@itwin/presentation-shared/lib/cjs/shared/ECSqlCore.d.ts

The package contains types and utilities used across different iTwin.js Presentation packages.

import { Id64String } from "@itwin/core-bentley";
/**
 * Defines an ECSql binding consisting of a value and its type. Necessary to differentiate between numeric
 * types and `Id64String` vs `string`.
 *
 * @public
 */
export type ECSqlBinding = {
    type: "boolean";
    value?: boolean;
} | {
    type: "double" | "int" | "long";
    value?: number;
} | {
    type: "id";
    value?: Id64String;
} | {
    type: "idset";
    value?: Id64String[];
} | {
    type: "string";
    value?: string;
} | {
    type: "point2d";
    value?: {
        x: number;
        y: number;
    };
} | {
    type: "point3d";
    value?: {
        x: number;
        y: number;
        z: number;
    };
};
/**
 * Defines an ECSQL query and its bindings.
 * @public
 */
export interface ECSqlQueryDef {
    /** A list of CTEs used in the query. */
    ctes?: string[];
    /**
     * The ECSQL query to execute.
     * @note In case the query uses CTEs, they should be specified in the `ctes` rather than included in the `ecsql`.
     */
    ecsql: string;
    /**
     * Values to bind to the query.
     * @see https://www.itwinjs.org/learning/ecsql/#ecsql-parameters
     */
    bindings?: ECSqlBinding[];
}
/**
 * Defines requested ECSQL result row format.
 * @see [QueryRowFormat](https://www.itwinjs.org/reference/core-common/imodels/queryrowformat/)
 * @public
 */
type ECSqlQueryRowFormat = "ECSqlPropertyNames" | "Indexes";
/**
 * Defines options for ECSQL query reader.
 * @see [QueryOptions](https://www.itwinjs.org/reference/core-common/imodels/queryoptions/)
 * @public
 */
export interface ECSqlQueryReaderOptions {
    rowFormat?: ECSqlQueryRowFormat;
    restartToken?: string;
}
/**
 * Represents a single row of an ECSQL query result.
 * @see [QueryRowProxy](https://www.itwinjs.org/reference/core-common/imodels/queryrowproxy/)
 * @public
 */
export interface ECSqlQueryRow {
    [propertyName: string]: any;
    [propertyIndex: number]: any;
}
/**
 * Represents ECSQL query results reader.
 * @see [ECSqlReader](https://www.itwinjs.org/reference/core-common/imodels/ecsqlreader/)
 * @public
 */
type ECSqlQueryReader = AsyncIterableIterator<ECSqlQueryRow>;
/**
 * An interface for something that knows how to create an ECSQL query reader.
 * @see `createECSqlQueryExecutor` in `@itwin/presentation-core-interop`.
 * @public
 */
export interface ECSqlQueryExecutor {
    createQueryReader(query: ECSqlQueryDef, config?: ECSqlQueryReaderOptions): ECSqlQueryReader;
}
export {};
//# sourceMappingURL=ECSqlCore.d.ts.map