@itwin/ecschema-rpcinterface-common/lib/esm/RpcIncrementalSchemaLocater.d.ts

Schema RPC Interface common interface

import { type IModelRpcProps } from "@itwin/core-common";
import { ECSqlQueryOptions, ECSqlSchemaLocater, ECSqlSchemaLocaterOptions, SchemaKey, SchemaProps } from "@itwin/ecschema-metadata";
/**
 * A [[ECSqlSchemaLocater]]($ecschema-metadata) implementation that uses the ECSchema RPC interfaces to load schemas incrementally.
 * @beta
 */
export declare class RpcIncrementalSchemaLocater extends ECSqlSchemaLocater {
    private readonly _iModelProps;
    /**
     * Initializes a new instance of the RpcIncrementalSchemaLocater class.
     */
    constructor(iModelProps: IModelRpcProps, options?: ECSqlSchemaLocaterOptions);
    /**
     * Executes the given ECSql query and returns the resulting rows.
     * @param query The ECSql query to execute.
     * @param options Optional arguments to control the query result.
     * @returns A promise that resolves to the resulting rows.
     */
    protected executeQuery<TRow>(query: string, options?: ECSqlQueryOptions): Promise<ReadonlyArray<TRow>>;
    /**
     * Gets the [[SchemaProps]]($ecschema-metadata) for the given [[SchemaKey]]($ecschema-metadata).
     * This is the full schema json with all elements that are defined in the schema.
     * @param schemaKey The schema key of the schema to be resolved.
     */
    protected getSchemaProps(schemaKey: SchemaKey): Promise<SchemaProps | undefined>;
}
//# sourceMappingURL=RpcIncrementalSchemaLocater.d.ts.map