@itwin/core-backend 3.0.0-dev.100

package/lib/cjs/IModelDb.d.ts

@@ -0,0 +1,1107 @@
+/** @packageDocumentation
+ * @module iModels
+ */
+import { IModelJsNative } from "@bentley/imodeljs-native";
+import { AccessToken, BeEvent, DbResult, GuidString, Id64Arg, Id64Array, Id64Set, Id64String, IModelStatus, OpenMode } from "@itwin/core-bentley";
+import { AxisAlignedBox3d, BRepGeometryCreate, BriefcaseId, ChangesetIdWithIndex, Code, CodeSpec, CreateEmptySnapshotIModelProps, CreateEmptyStandaloneIModelProps, CreateSnapshotIModelProps, EcefLocation, ECSqlReader, ElementAspectProps, ElementGeometryRequest, ElementGeometryUpdate, ElementGraphicsRequestProps, ElementLoadProps, ElementProps, EntityMetaData, EntityProps, EntityQueryParams, FilePropertyProps, FontMap, FontProps, GeoCoordinatesRequestProps, GeoCoordinatesResponseProps, GeometryContainmentRequestProps, GeometryContainmentResponseProps, IModel, IModelCoordinatesRequestProps, IModelCoordinatesResponseProps, IModelTileTreeProps, LocalFileName, MassPropertiesRequestProps, MassPropertiesResponseProps, ModelLoadProps, ModelProps, OpenBriefcaseProps, PropertyCallback, QueryBinder, QueryOptions, QueryRowFormat, RpcActivity, SchemaState, SnapRequestProps, SnapResponseProps, SnapshotOpenOptions, StandaloneOpenOptions, TextureData, TextureLoadProps, ThumbnailProps, UpgradeOptions, ViewDefinitionProps, ViewQueryParams, ViewStateLoadProps, ViewStateProps } from "@itwin/core-common";
+import { Range3d } from "@itwin/core-geometry";
+import { PullChangesArgs, PushChangesArgs } from "./BriefcaseManager";
+import { CheckpointProps } from "./CheckpointManager";
+import { MetaDataRegistry } from "./ClassRegistry";
+import { CodeSpecs } from "./CodeSpecs";
+import { ECSqlStatement } from "./ECSqlStatement";
+import { Element, Subject } from "./Element";
+import { ElementAspect } from "./ElementAspect";
+import { Entity, EntityClassType } from "./Entity";
+import { ExportGraphicsOptions, ExportPartGraphicsOptions } from "./ExportGraphics";
+import { Model } from "./Model";
+import { Relationships } from "./Relationship";
+import { SqliteStatement } from "./SqliteStatement";
+import { TxnManager } from "./TxnManager";
+import { ViewDefinition } from "./ViewDefinition";
+/** Options for [[IModelDb.Models.updateModel]]
+ * @note To mark *only* the geometry as changed, use [[IModelDb.Models.updateGeometryGuid]] instead.
+ * @public
+ */
+export interface UpdateModelOptions extends ModelProps {
+    /** If defined, update the last modify time of the Model */
+    updateLastMod?: boolean;
+    /** If defined, update the GeometryGuid of the Model */
+    geometryChanged?: boolean;
+}
+/** Options supplied to [[IModelDb.computeProjectExtents]].
+ * @public
+ */
+export interface ComputeProjectExtentsOptions {
+    /** If true, the result will include `extentsWithOutliers`. */
+    reportExtentsWithOutliers?: boolean;
+    /** If true, the result will include `outliers`. */
+    reportOutliers?: boolean;
+}
+/** The result of [[IModelDb.computeProjectExtents]].
+ * @public
+ */
+export interface ComputedProjectExtents {
+    /** The computed extents, excluding any outlier elements. */
+    extents: Range3d;
+    /** If requested by caller, the computed extents, *including* any outlier elements. */
+    extentsWithOutliers?: Range3d;
+    /** If requested by caller, the Ids of outlier elements excluded from the computed extents. */
+    outliers?: Id64Array;
+}
+/**
+ * Interface for acquiring element locks to coordinate simultaneous edits from multiple briefcases.
+ * @beta
+ */
+export interface LockControl {
+    /**
+     * true if this LockControl uses a server-based concurrency approach.
+     */
+    readonly isServerBased: boolean;
+    /**
+     * Close the local lock control database
+     * @internal
+     */
+    close(): void;
+    /**
+     * Notification that a new element was just created. Called by [[Element.onInserted]]
+     * @internal
+     */
+    elementWasCreated(id: Id64String): void;
+    /**
+     * Throw if locks are required and the exclusive lock is not held on the supplied element.
+     * Note: there is no need to check the shared locks on parents/models since an element cannot hold the exclusive lock without first obtaining them.
+     * Called by [[Element.onUpdate]], [[Element.onDelete]], etc.
+     * @internal
+     */
+    checkExclusiveLock(id: Id64String, type: string, operation: string): void;
+    /**
+     * Throw if locks are required and a shared lock is not held on the supplied element.
+     * Called by [[Element.onInsert]] to ensure shared lock is held on model and parent.
+     * @internal
+     */
+    checkSharedLock(id: Id64String, type: string, operation: string): void;
+    /**
+     * Determine whether the supplied element currently holds the exclusive lock
+     */
+    holdsExclusiveLock(id: Id64String): boolean;
+    /**
+     * Determine whether the supplied element currently holds a shared lock
+     */
+    holdsSharedLock(id: Id64String): boolean;
+    /**
+     * Acquire the exclusive lock on one or more elements from the lock server, if locks are required and not already held.
+     * If any required lock is not available, this method throws an exception and *none* of the requested locks are acquired.
+     * > Note: acquiring the exclusive lock on an element requires also obtaining a shared lock on all its owner elements. This method will
+     * attempt to acquire all necessary locks for the set of input ids.
+     */
+    acquireExclusiveLock(ids: Id64Arg): Promise<void>;
+    /**
+     * Acquire a shared lock on one or more elements from the lock server, if locks are required and not already held.
+     * If any required lock is not available, this method throws an exception and *none* of the requested locks are acquired.
+     * > Note: acquiring the shared lock on an element requires also obtaining a shared lock on all its owner elements. This method will
+     * attempt to acquire all necessary locks for the set of input ids.
+     */
+    acquireSharedLock(ids: Id64Arg): Promise<void>;
+    /**
+     * Release all locks currently held by this Briefcase from the lock server.
+     */
+    releaseAllLocks(): Promise<void>;
+}
+/** @internal */
+export declare enum BriefcaseLocalValue {
+    StandaloneEdit = "StandaloneEdit",
+    NoLocking = "NoLocking"
+}
+/** An iModel database file. The database file can either be a briefcase or a snapshot.
+ * @see [Accessing iModels]($docs/learning/backend/AccessingIModels.md)
+ * @see [About IModelDb]($docs/learning/backend/IModelDb.md)
+ * @public
+ */
+export declare abstract class IModelDb extends IModel {
+    private _initialized;
+    /** Keep track of open imodels to support `tryFind` for RPC purposes */
+    private static readonly _openDbs;
+    static readonly defaultLimit = 1000;
+    static readonly maxLimit = 10000;
+    readonly models: IModelDb.Models;
+    readonly elements: IModelDb.Elements;
+    readonly views: IModelDb.Views;
+    readonly tiles: IModelDb.Tiles;
+    private _relationships?;
+    private readonly _statementCache;
+    private readonly _sqliteStatementCache;
+    private _codeSpecs?;
+    private _classMetaDataRegistry?;
+    protected _fontMap?: FontMap;
+    protected _concurrentQueryStats: {
+        resetTimerHandle: any;
+        logTimerHandle: any;
+        lastActivityTime: number;
+        dispose: () => void;
+    };
+    private readonly _snaps;
+    private static _shutdownListener;
+    /** @internal */
+    protected _locks?: LockControl;
+    /**
+     * Get the lock control for this iModel.
+     * @beta
+     */
+    get locks(): LockControl;
+    /** Acquire the exclusive schema lock on this iModel.
+     * > Note: To acquire the schema lock, all other briefcases must first release *all* their locks. No other briefcases
+     * will be able to acquire *any* locks while the schema lock is held.
+     */
+    acquireSchemaLock(): Promise<void>;
+    /** determine whether the schema lock is currently held for this iModel. */
+    get holdsSchemaLock(): boolean;
+    /** Event called after a changeset is applied to this IModelDb. */
+    readonly onChangesetApplied: BeEvent<() => void>;
+    /** @internal */
+    notifyChangesetApplied(): void;
+    get fontMap(): FontMap;
+    embedFont(prop: FontProps): FontProps;
+    /** Check if this iModel has been opened read-only or not. */
+    get isReadonly(): boolean;
+    /** The Guid that identifies this iModel. */
+    get iModelId(): GuidString;
+    private _nativeDb?;
+    /** @internal*/
+    get nativeDb(): IModelJsNative.DgnDb;
+    /** Get the full path fileName of this iModelDb
+     * @note this member is only valid while the iModel is opened.
+     */
+    get pathName(): LocalFileName;
+    /** @internal */
+    protected constructor(args: {
+        nativeDb: IModelJsNative.DgnDb;
+        key: string;
+        changeset?: ChangesetIdWithIndex;
+    });
+    /** Close this IModel, if it is currently open. */
+    close(): void;
+    /** @internal */
+    reattachDaemon(_accessToken: AccessToken): Promise<void>;
+    /** Event called when the iModel is about to be closed. */
+    readonly onBeforeClose: BeEvent<() => void>;
+    /**
+     * Called by derived classes before closing the connection
+     * @internal
+     */
+    protected beforeClose(): void;
+    /** @internal */
+    protected initializeIModelDb(): void;
+    /** Returns true if this is a BriefcaseDb
+     * @see [[BriefcaseDb.open]]
+     */
+    get isBriefcase(): boolean;
+    /** Type guard for instanceof [[BriefcaseDb]] */
+    isBriefcaseDb(): this is BriefcaseDb;
+    /** Returns true if this is a SnapshotDb
+     * @see [[SnapshotDb.open]]
+     */
+    get isSnapshot(): boolean;
+    /** Type guard for instanceof [[SnapshotDb]] */
+    isSnapshotDb(): this is SnapshotDb;
+    /** Returns true if this is a *standalone* iModel
+     * @see [[StandaloneDb.open]]
+     * @internal
+     */
+    get isStandalone(): boolean;
+    /** Type guard for instanceof [[StandaloneDb]]
+     * @internal
+     */
+    isStandaloneDb(): this is StandaloneDb;
+    /** Return `true` if the underlying nativeDb is open and valid.
+     * @internal
+     */
+    get isOpen(): boolean;
+    /** Get the briefcase Id of this iModel */
+    getBriefcaseId(): BriefcaseId;
+    /**
+     * Use a prepared ECSQL statement, potentially from the statement cache. If the requested statement doesn't exist
+     * in the statement cache, a new statement is prepared. After the callback completes, the statement is reset and saved
+     * in the statement cache so it can be reused in the future. Use this method for ECSQL statements that will be
+     * reused often and are expensive to prepare. The statement cache holds the most recently used statements, discarding
+     * the oldest statements as it fills. For statements you don't intend to reuse, instead use [[withStatement]].
+     * @param sql The SQLite SQL statement to execute
+     * @param callback the callback to invoke on the prepared statement
+     * @param logErrors Determines if error will be logged if statement fail to prepare
+     * @returns the value returned by `callback`.
+     * @see [[withStatement]]
+     * @public
+     */
+    withPreparedStatement<T>(ecsql: string, callback: (stmt: ECSqlStatement) => T, logErrors?: boolean): T;
+    /**
+     * Prepared and execute a callback on an ECSQL statement. After the callback completes the statement is disposed.
+     * Use this method for ECSQL statements are either not expected to be reused, or are not expensive to prepare.
+     * For statements that will be reused often, instead use [[withPreparedStatement]].
+     * @param sql The SQLite SQL statement to execute
+     * @param callback the callback to invoke on the prepared statement
+     * @param logErrors Determines if error will be logged if statement fail to prepare
+     * @returns the value returned by `callback`.
+     * @see [[withPreparedStatement]]
+     * @public
+     */
+    withStatement<T>(ecsql: string, callback: (stmt: ECSqlStatement) => T, logErrors?: boolean): T;
+    /** Allow to execute query and read results along with meta data. The result are streamed.
+     * @param params The values to bind to the parameters (if the ECSQL has any).
+     * @param config Allow to specify certain flags which control how query is executed.
+     * @returns Returns *ECSqlQueryReader* which help iterate over result set and also give access to meta data.
+     * @beta
+     * */
+    createQueryReader(ecsql: string, params?: QueryBinder, config?: QueryOptions): ECSqlReader;
+    /** Execute a query and stream its results
+     * The result of the query is async iterator over the rows. The iterator will get next page automatically once rows in current page has been read.
+     * [ECSQL row]($docs/learning/ECSQLRowFormat).
+     *
+     * See also:
+     * - [ECSQL Overview]($docs/learning/backend/ExecutingECSQL)
+     * - [Code Examples]($docs/learning/backend/ECSQLCodeExamples)
+     *
+     * @param ecsql The ECSQL statement to execute
+     * @param params The values to bind to the parameters (if the ECSQL has any).
+     * @param rowFormat Specify what format the row will be returned. It default to Array format though to make it compilable with previous version use *QueryRowFormat.UseJsPropertyNames*
+     * @param options Allow to specify certain flags which control how query is executed.
+     * @returns Returns the query result as an *AsyncIterableIterator<any>*  which lazy load result as needed. The row format is determined by *rowFormat* parameter.
+     * See [ECSQL row format]($docs/learning/ECSQLRowFormat) for details about the format of the returned rows.
+     * @throws [IModelError]($common) If there was any error while submitting, preparing or stepping into query
+     */
+    query(ecsql: string, params?: QueryBinder, rowFormat?: QueryRowFormat, options?: QueryOptions): AsyncIterableIterator<any>;
+    /** Compute number of rows that would be returned by the ECSQL.
+     *
+     * See also:
+     * - [ECSQL Overview]($docs/learning/backend/ExecutingECSQL)
+     * - [Code Examples]($docs/learning/backend/ECSQLCodeExamples)
+     *
+     * @param ecsql The ECSQL statement to execute
+     * @param params The values to bind to the parameters (if the ECSQL has any).
+     * See "[iModel.js Types used in ECSQL Parameter Bindings]($docs/learning/ECSQLParameterTypes)" for details.
+     * @returns Return row count.
+     * @throws [IModelError]($common) If the statement is invalid
+     */
+    queryRowCount(ecsql: string, params?: QueryBinder): Promise<number>;
+    /** Cancel any previous query with same token and run execute the current specified query.
+     * The result of the query is async iterator over the rows. The iterator will get next page automatically once rows in current page has been read.
+     * [ECSQL row]($docs/learning/ECSQLRowFormat).
+     *
+     * See also:
+     * - [ECSQL Overview]($docs/learning/backend/ExecutingECSQL)
+     * - [Code Examples]($docs/learning/backend/ECSQLCodeExamples)
+     *
+     * @param ecsql The ECSQL statement to execute
+     * @param token None empty restart token. The previous query with same token would be cancelled. This would cause
+     * exception which user code must handle.
+     * @param params The values to bind to the parameters (if the ECSQL has any).
+     * @param rowFormat Specify what format the row will be returned. It default to Array format though to make it compilable with previous version use *QueryRowFormat.UseJsPropertyNames*
+     * @param options Allow to specify certain flags which control how query is executed.
+     * @returns Returns the query result as an *AsyncIterableIterator<any>*  which lazy load result as needed. The row format is determined by *rowFormat* parameter.
+     * See [ECSQL row format]($docs/learning/ECSQLRowFormat) for details about the format of the returned rows.
+     * @throws [IModelError]($common) If there was any error while submitting, preparing or stepping into query
+     */
+    restartQuery(token: string, ecsql: string, params?: QueryBinder, rowFormat?: QueryRowFormat, options?: QueryOptions): AsyncIterableIterator<any>;
+    /**
+     * Use a prepared SQL statement, potentially from the statement cache. If the requested statement doesn't exist
+     * in the statement cache, a new statement is prepared. After the callback completes, the statement is reset and saved
+     * in the statement cache so it can be reused in the future. Use this method for SQL statements that will be
+     * reused often and are expensive to prepare. The statement cache holds the most recently used statements, discarding
+     * the oldest statements as it fills. For statements you don't intend to reuse, instead use [[withSqliteStatement]].
+     * @param sql The SQLite SQL statement to execute
+     * @param callback the callback to invoke on the prepared statement
+     * @param logErrors Determine if errors are logged or not
+     * @returns the value returned by `callback`.
+     * @see [[withPreparedStatement]]
+     * @public
+     */
+    withPreparedSqliteStatement<T>(sql: string, callback: (stmt: SqliteStatement) => T, logErrors?: boolean): T;
+    /**
+     * Prepared and execute a callback on a SQL statement. After the callback completes the statement is disposed.
+     * Use this method for SQL statements are either not expected to be reused, or are not expensive to prepare.
+     * For statements that will be reused often, instead use [[withPreparedSqliteStatement]].
+     * @param sql The SQLite SQL statement to execute
+     * @param callback the callback to invoke on the prepared statement
+     * @param logErrors Determine if errors are logged or not
+     * @returns the value returned by `callback`.
+     * @public
+     */
+    withSqliteStatement<T>(sql: string, callback: (stmt: SqliteStatement) => T, logErrors?: boolean): T;
+    /** Prepare an SQL statement.
+     * @param sql The SQL statement to prepare
+     * @throws [[IModelError]] if there is a problem preparing the statement.
+     * @internal
+     */
+    prepareSqliteStatement(sql: string, logErrors?: boolean): SqliteStatement;
+    /** Query for a set of entity ids, given an EntityQueryParams
+     * @param params The query parameters. The `limit` and `offset` members should be used to page results.
+     * @returns an Id64Set with results of query
+     * @throws [[IModelError]] if the generated statement is invalid or [IModelDb.maxLimit]($backend) exceeded when collecting ids.
+     *
+     * *Example:*
+     * ``` ts
+     * [[include:ECSQL-backend-queries.select-element-by-code-value-using-queryEntityIds]]
+     * ```
+     */
+    queryEntityIds(params: EntityQueryParams): Id64Set;
+    /** Clear all in-memory caches held in this IModelDb. */
+    clearCaches(): void;
+    /** Update the project extents for this iModel.
+     * <p><em>Example:</em>
+     * ``` ts
+     * [[include:IModelDb.updateProjectExtents]]
+     * ```
+     */
+    updateProjectExtents(newExtents: AxisAlignedBox3d): void;
+    /** Compute an appropriate project extents for this iModel based on the ranges of all spatial elements.
+     * Typically, the result is simply the union of the ranges of all spatial elements. However, the algorithm also detects "outlier elements",
+     * whose placements locate them so far from the rest of the spatial geometry that they are considered statistically insignificant. The
+     * range of an outlier element does not contribute to the computed extents.
+     * @param options Specifies the level of detail desired in the return value.
+     * @returns the computed extents.
+     * @note This method does not modify the IModel's stored project extents. @see [[updateProjectExtents]].
+     */
+    computeProjectExtents(options?: ComputeProjectExtentsOptions): ComputedProjectExtents;
+    /** Update the [EcefLocation]($docs/learning/glossary#eceflocation) of this iModel.  */
+    updateEcefLocation(ecef: EcefLocation): void;
+    /** Update the IModelProps of this iModel in the database. */
+    updateIModelProps(): void;
+    /** Commit pending changes to this iModel.
+     * @param description Optional description of the changes
+     * @throws [[IModelError]] if there is a problem saving changes or if there are pending, un-processed lock or code requests.
+     */
+    saveChanges(description?: string): void;
+    /** Abandon pending changes in this iModel. */
+    abandonChanges(): void;
+    /** @internal */
+    reverseTxns(numOperations: number): IModelStatus;
+    /** @internal */
+    reinstateTxn(): IModelStatus;
+    /** @internal */
+    restartTxnSession(): void;
+    /** Import an ECSchema. On success, the schema definition is stored in the iModel.
+     * This method is asynchronous (must be awaited) because, in the case where this IModelDb is a briefcase, this method first obtains the schema lock from the iModel server.
+     * You must import a schema into an iModel before you can insert instances of the classes in that schema. See [[Element]]
+     * @param schemaFileName  array of Full paths to ECSchema.xml files to be imported.
+     * @throws [[IModelError]] if the schema lock cannot be obtained or there is a problem importing the schema.
+     * @note Changes are saved if importSchemas is successful and abandoned if not successful.
+     * @see querySchemaVersion
+     */
+    importSchemas(schemaFileNames: LocalFileName[]): Promise<void>;
+    /** Import ECSchema(s) serialized to XML. On success, the schema definition is stored in the iModel.
+     * This method is asynchronous (must be awaited) because, in the case where this IModelDb is a briefcase, this method first obtains the schema lock from the iModel server.
+     * You must import a schema into an iModel before you can insert instances of the classes in that schema. See [[Element]]
+     * @param serializedXmlSchemas  The xml string(s) created from a serialized ECSchema.
+     * @throws [[IModelError]] if the schema lock cannot be obtained or there is a problem importing the schema.
+     * @note Changes are saved if importSchemaStrings is successful and abandoned if not successful.
+     * @see querySchemaVersion
+     * @alpha
+     */
+    importSchemaStrings(serializedXmlSchemas: string[]): Promise<void>;
+    /** Find an opened instance of any subclass of IModelDb, by filename
+     * @note this method returns an IModelDb if the filename is open for *any* subclass of IModelDb
+    */
+    static findByFilename(fileName: LocalFileName): IModelDb | undefined;
+    /** Find an open IModelDb by its key.
+     * @note This method is mainly for use by RPC implementations.
+     * @throws [[IModelNotFoundResponse]] if an open IModelDb matching the key is not found.
+     * @see [IModel.key]($common)
+     */
+    static findByKey(key: string): IModelDb;
+    /** Attempt to find an open IModelDb by key.
+     * @returns The matching IModelDb or `undefined`.
+     */
+    static tryFindByKey(key: string): IModelDb | undefined;
+    /** @internal */
+    static openDgnDb(file: {
+        path: LocalFileName;
+        key?: string;
+    }, openMode: OpenMode, upgradeOptions?: UpgradeOptions, props?: SnapshotOpenOptions): IModelJsNative.DgnDb;
+    /**
+     * Determines if the schemas in the Db must or can be upgraded by comparing them with those included in the
+     * current version of the software.
+     * @param filePath Full name of the briefcase including path
+     * @param forReadWrite Pass true if validating for read-write scenarios - note that the schema version requirements
+     * for opening the DgnDb read-write is more stringent than when opening the database read-only
+     * @throws [[IModelError]] If the Db was in an invalid state and that causes a problem with validating schemas
+     * @see [[BriefcaseDb.upgradeSchemas]] or [[StandaloneDb.upgradeSchemas]]
+     * @see ($docs/learning/backend/IModelDb.md#upgrading-schemas-in-an-imodel)
+     */
+    static validateSchemas(filePath: LocalFileName, forReadWrite: boolean): SchemaState;
+    /** Get the ClassMetaDataRegistry for this iModel.
+     * @internal
+     */
+    get classMetaDataRegistry(): MetaDataRegistry;
+    /** Get the linkTableRelationships for this IModel */
+    get relationships(): Relationships;
+    /** Get the CodeSpecs in this IModel. */
+    get codeSpecs(): CodeSpecs;
+    /** @internal */
+    insertCodeSpec(codeSpec: CodeSpec): Id64String;
+    /** Prepare an ECSQL statement.
+     * @param sql The ECSQL statement to prepare
+     * @param logErrors Determines if error will be logged if statement fail to prepare
+     * @throws [[IModelError]] if there is a problem preparing the statement.
+     */
+    prepareStatement(sql: string, logErrors?: boolean): ECSqlStatement;
+    /** Prepare an ECSQL statement.
+     * @param sql The ECSQL statement to prepare
+     * @returns `undefined` if there is a problem preparing the statement.
+     */
+    tryPrepareStatement(sql: string): ECSqlStatement | undefined;
+    /** Construct an entity (Element or Model) from an iModel.
+     * @throws [[IModelError]] if the entity cannot be constructed.
+     */
+    constructEntity<T extends Entity>(props: EntityProps): T;
+    /** Get the JavaScript class that handles a given entity class.  */
+    getJsClass<T extends typeof Entity>(classFullName: string): T;
+    /** Get metadata for a class. This method will load the metadata from the iModel into the cache as a side-effect, if necessary.
+     * @throws [[IModelError]] if the metadata cannot be found nor loaded.
+     */
+    getMetaData(classFullName: string): EntityMetaData;
+    /** Invoke a callback on each property of the specified class, optionally including superclass properties.
+     * @param iModel  The IModel that contains the schema
+     * @param classFullName The full class name to load the metadata, if necessary
+     * @param wantSuper If true, superclass properties will also be processed
+     * @param func The callback to be invoked on each property
+     * @param includeCustom If true (default), include custom-handled properties in the iteration. Otherwise, skip custom-handled properties.
+     * @note Custom-handled properties are core properties that have behavior enforced by C++ handlers.
+     */
+    static forEachMetaData(iModel: IModelDb, classFullName: string, wantSuper: boolean, func: PropertyCallback, includeCustom?: boolean): void;
+    /** @internal */
+    private loadMetaData;
+    /** Query if this iModel contains the definition of the specified class.
+     * @param classFullName The full name of the class, for example, SomeSchema:SomeClass
+     * @returns true if the iModel contains the class definition or false if not.
+     * @see querySchemaVersion
+     * @see importSchema
+     */
+    containsClass(classFullName: string): boolean;
+    /** Query for a schema of the specified name in this iModel.
+     * @returns The schema version as a semver-compatible string or `undefined` if the schema has not been imported.
+     */
+    querySchemaVersion(schemaName: string): string | undefined;
+    /** Retrieve a named texture image from this iModel, as a TextureData.
+     * @param props the texture load properties which must include the name of the texture to load
+     * @returns the TextureData or undefined if the texture image is not present.
+     * @alpha
+     */
+    queryTextureData(props: TextureLoadProps): Promise<TextureData | undefined>;
+    /** Query a "file property" from this iModel, as a string.
+     * @returns the property string or undefined if the property is not present.
+     */
+    queryFilePropertyString(prop: FilePropertyProps): string | undefined;
+    /** Query a "file property" from this iModel, as a blob.
+     * @returns the property blob or undefined if the property is not present.
+     */
+    queryFilePropertyBlob(prop: FilePropertyProps): Uint8Array | undefined;
+    /** Save a "file property" to this iModel
+     * @param prop the FilePropertyProps that describes the new property
+     * @param value either a string or a blob to save as the file property
+     */
+    saveFileProperty(prop: FilePropertyProps, strValue: string | undefined, blobVal?: Uint8Array): void;
+    /** delete a "file property" from this iModel
+     * @param prop the FilePropertyProps that describes the property
+     */
+    deleteFileProperty(prop: FilePropertyProps): void;
+    /** Query for the next available major id for a "file property" from this iModel.
+     * @param prop the FilePropertyProps that describes the property
+     * @returns the next available (that is, an unused) id for prop. If none are present, will return 0.
+     */
+    queryNextAvailableFileProperty(prop: FilePropertyProps): number;
+    /** @internal */
+    requestSnap(sessionId: string, props: SnapRequestProps): Promise<SnapResponseProps>;
+    /** Cancel a previously requested snap.
+     * @internal
+     */
+    cancelSnap(sessionId: string): void;
+    /** Get the clip containment status for the supplied elements. */
+    getGeometryContainment(props: GeometryContainmentRequestProps): Promise<GeometryContainmentResponseProps>;
+    /** Get the mass properties for the supplied elements. */
+    getMassProperties(props: MassPropertiesRequestProps): Promise<MassPropertiesResponseProps>;
+    /** Get the IModel coordinate corresponding to each GeoCoordinate point in the input */
+    getIModelCoordinatesFromGeoCoordinates(props: IModelCoordinatesRequestProps): Promise<IModelCoordinatesResponseProps>;
+    /** Get the GeoCoordinate (longitude, latitude, elevation) corresponding to each IModel Coordinate point in the input */
+    getGeoCoordinatesFromIModelCoordinates(props: GeoCoordinatesRequestProps): Promise<GeoCoordinatesResponseProps>;
+    /** Export meshes suitable for graphics APIs from arbitrary geometry in elements in this IModelDb.
+     *  * Requests can be slow when processing many elements so it is expected that this function be used on a dedicated backend,
+     *    or that shared backends export a limited number of elements at a time.
+     *  * Vertices are exported in the IModelDb's world coordinate system, which is right-handed with Z pointing up.
+     *  * The results of changing [ExportGraphicsOptions]($core-backend) during the [ExportGraphicsOptions.onGraphics]($core-backend) callback are not defined.
+     *
+     * Example that prints the mesh for element 1 to stdout in [OBJ format](https://en.wikipedia.org/wiki/Wavefront_.obj_file)
+     * ```ts
+     * const onGraphics: ExportGraphicsFunction = (info: ExportGraphicsInfo) => {
+     *   const mesh: ExportGraphicsMesh = info.mesh;
+     *   for (let i = 0; i < mesh.points.length; i += 3) {
+     *     process.stdout.write(`v ${mesh.points[i]} ${mesh.points[i + 1]} ${mesh.points[i + 2]}\n`);
+     *     process.stdout.write(`vn ${mesh.normals[i]} ${mesh.normals[i + 1]} ${mesh.normals[i + 2]}\n`);
+     *   }
+     *
+     *   for (let i = 0; i < mesh.params.length; i += 2) {
+     *     process.stdout.write(`vt ${mesh.params[i]} ${mesh.params[i + 1]}\n`);
+     *   }
+     *
+     *   for (let i = 0; i < mesh.indices.length; i += 3) {
+     *     const p1 = mesh.indices[i];
+     *     const p2 = mesh.indices[i + 1];
+     *     const p3 = mesh.indices[i + 2];
+     *     process.stdout.write(`f ${p1}/${p1}/${p1} ${p2}/${p2}/${p2} ${p3}/${p3}/${p3}\n`);
+     *   }
+     * };
+     *
+     * iModel.exportGraphics(({ onGraphics, elementIdArray: ["0x1"] }));
+     * ```
+     * @returns 0 if successful, status otherwise
+     * @public
+     */
+    exportGraphics(exportProps: ExportGraphicsOptions): DbResult;
+    /**
+     * Exports meshes suitable for graphics APIs from a specified [GeometryPart]($core-backend)
+     * in this IModelDb.
+     * The expected use case is to call [IModelDb.exportGraphics]($core-backend) and supply the
+     * optional partInstanceArray argument, then call this function for each unique GeometryPart from
+     * that list.
+     *  * The results of changing [ExportPartGraphicsOptions]($core-backend) during the
+     *    [ExportPartGraphicsOptions.onPartGraphics]($core-backend) callback are not defined.
+     *  * See export-gltf under test-apps in the iModel.js monorepo for a working reference.
+     * @returns 0 is successful, status otherwise
+     * @public
+     */
+    exportPartGraphics(exportProps: ExportPartGraphicsOptions): DbResult;
+    /** Request geometry stream information from an element in binary format instead of json.
+     * @returns DbResult.BE_SQLITE_OK if successful
+     * @alpha
+     */
+    elementGeometryRequest(requestProps: ElementGeometryRequest): DbResult;
+    /** Update the geometry stream for the supplied element from binary format data instead of json.
+     * @returns DbResult.BE_SQLITE_OK if successful
+     * @alpha
+     */
+    elementGeometryUpdate(updateProps: ElementGeometryUpdate): DbResult;
+    /** Create brep geometry for inclusion in an element's geometry stream.
+     * @returns DbResult.BE_SQLITE_OK if successful
+     * @throws [[IModelError]] to report issues with input geometry or parameters
+     * @see [IModelDb.elementGeometryUpdate]($core-backend)
+     * @alpha
+     */
+    createBRepGeometry(createProps: BRepGeometryCreate): DbResult;
+    /** Generate graphics for an element or geometry stream.
+     * @see [readElementGraphics]($frontend) to convert the result to a [RenderGraphic]($frontend) for display.
+     */
+    generateElementGraphics(request: ElementGraphicsRequestProps): Promise<Uint8Array | undefined>;
+}
+/** @public */
+export declare namespace IModelDb {
+    /** The collection of models in an [[IModelDb]].
+     * @public
+     */
+    class Models {
+        private _iModel;
+        /** @internal */
+        constructor(_iModel: IModelDb);
+        /** Get the ModelProps with the specified identifier.
+         * @param modelId The Model identifier.
+         * @throws [[IModelError]] if the model is not found or cannot be loaded.
+         * @see tryGetModelProps
+         */
+        getModelProps<T extends ModelProps>(id: Id64String): T;
+        /** Get the ModelProps with the specified identifier.
+         * @param modelId The Model identifier.
+         * @returns The ModelProps or `undefined` if the model is not found.
+         * @throws [[IModelError]] if the model cannot be loaded.
+         * @note Useful for cases when a model may or may not exist and throwing an `Error` would be overkill.
+         * @see getModelProps
+         */
+        tryGetModelProps<T extends ModelProps>(id: Id64String): T | undefined;
+        /** Query for the last modified time of the specified Model.
+         * @internal
+         */
+        queryLastModifiedTime(modelId: Id64String): string;
+        /** Get the Model with the specified identifier.
+         * @param modelId The Model identifier.
+         * @param modelClass Optional class to validate instance against. This parameter can accept abstract or concrete classes, but should be the same as the template (`T`) parameter.
+         * @throws [[IModelError]] if the model is not found, cannot be loaded, or fails validation when `modelClass` is specified.
+         * @see tryGetModel
+         */
+        getModel<T extends Model>(modelId: Id64String, modelClass?: EntityClassType<Model>): T;
+        /** Get the Model with the specified identifier.
+         * @param modelId The Model identifier.
+         * @param modelClass Optional class to validate instance against. This parameter can accept abstract or concrete classes, but should be the same as the template (`T`) parameter.
+         * @returns The Model or `undefined` if the model is not found or fails validation when `modelClass` is specified.
+         * @throws [[IModelError]] if the model cannot be loaded.
+         * @note Useful for cases when a model may or may not exist and throwing an `Error` would be overkill.
+         * @see getModel
+         */
+        tryGetModel<T extends Model>(modelId: Id64String, modelClass?: EntityClassType<Model>): T | undefined;
+        /** Read the properties for a Model as a json string.
+         * @param modelIdArg a json string with the identity of the model to load. Must have either "id" or "code".
+         * @returns a json string with the properties of the model.
+         * @throws [[IModelError]] if the model is not found or cannot be loaded.
+         * @see tryGetModelJson
+         * @internal
+         */
+        getModelJson<T extends ModelProps>(modelIdArg: ModelLoadProps): T;
+        /** Read the properties for a Model as a json string.
+         * @param modelIdArg a json string with the identity of the model to load. Must have either "id" or "code".
+         * @returns a json string with the properties of the model or `undefined` if the model is not found.
+         * @see getModelJson
+         */
+        private tryGetModelJson;
+        /** Get the sub-model of the specified Element.
+         * See [[IModelDb.Elements.queryElementIdByCode]] for more on how to find an element by Code.
+         * @param modeledElementId Identifies the modeled element.
+         * @param modelClass Optional class to validate instance against. This parameter can accept abstract or concrete classes, but should be the same as the template (`T`) parameter.
+         * @throws [[IModelError]] if the sub-model is not found, cannot be loaded, or fails validation when `modelClass` is specified.
+         * @see tryGetSubModel
+         */
+        getSubModel<T extends Model>(modeledElementId: Id64String | GuidString | Code, modelClass?: EntityClassType<Model>): T;
+        /** Get the sub-model of the specified Element.
+         * See [[IModelDb.Elements.queryElementIdByCode]] for more on how to find an element by Code.
+         * @param modeledElementId Identifies the modeled element.
+         * @param modelClass Optional class to validate instance against. This parameter can accept abstract or concrete classes, but should be the same as the template (`T`) parameter.
+         * @returns The sub-model or `undefined` if the specified element does not have a sub-model or fails validation when `modelClass` is specified.
+         * @see getSubModel
+         */
+        tryGetSubModel<T extends Model>(modeledElementId: Id64String | GuidString | Code, modelClass?: EntityClassType<Model>): T | undefined;
+        /** Create a new model in memory.
+         * See the example in [[InformationPartitionElement]].
+         * @param modelProps The properties to use when creating the model.
+         * @throws [[IModelError]] if there is a problem creating the model.
+         */
+        createModel<T extends Model>(modelProps: ModelProps): T;
+        /** Insert a new model.
+         * @param props The data for the new model.
+         * @returns The newly inserted model's Id.
+         * @throws [[IModelError]] if unable to insert the model.
+         */
+        insertModel(props: ModelProps): Id64String;
+        /** Update an existing model.
+         * @param props the properties of the model to change
+         * @throws [[IModelError]] if unable to update the model.
+         */
+        updateModel(props: UpdateModelOptions): void;
+        /** Mark the geometry of [[GeometricModel]] as having changed, by recording an indirect change to its GeometryGuid property.
+         * Typically the GeometryGuid changes automatically when [[GeometricElement]]s within the model are modified, but
+         * explicitly updating it is occasionally useful after modifying definition elements like line styles or materials that indirectly affect the appearance of
+         * [[GeometricElement]]s that reference those definition elements in their geometry streams.
+         * Cached [Tile]($frontend)s are only invalidated after the geometry guid of the model changes.
+         * @note This will throw IModelError with [IModelStatus.VersionTooOld]($core-bentley) if a version of the BisCore schema older than 1.0.11 is present in the iModel.
+         * @throws IModelError if unable to update the geometry guid.
+         * @see [[TxnManager.onModelGeometryChanged]] for the event emitted in response to such a change.
+         */
+        updateGeometryGuid(modelId: Id64String): void;
+        /** Delete one or more existing models.
+         * @param ids The Ids of the models to be deleted
+         * @throws [[IModelError]]
+         */
+        deleteModel(ids: Id64Arg): void;
+    }
+    /** The collection of elements in an [[IModelDb]].
+     * @public
+     */
+    class Elements {
+        private _iModel;
+        /** @internal */
+        constructor(_iModel: IModelDb);
+        /** Read element data from the iModel as JSON
+         * @param elementIdArg a json string with the identity of the element to load. Must have one of "id", "federationGuid", or "code".
+         * @returns The JSON properties of the element.
+         * @throws [[IModelError]] if the element is not found or cannot be loaded.
+         * @see tryGetElementJson
+         * @internal
+         */
+        getElementJson<T extends ElementProps>(elementId: ElementLoadProps): T;
+        /** Read element data from the iModel as JSON
+         * @param elementIdArg a json string with the identity of the element to load. Must have one of "id", "federationGuid", or "code".
+         * @returns The JSON properties of the element or `undefined` if the element is not found.
+         * @throws [[IModelError]] if the element exists, but cannot be loaded.
+         * @see getElementJson
+         */
+        private tryGetElementJson;
+        /** Get properties of an Element by Id, FederationGuid, or Code
+         * @throws [[IModelError]] if the element is not found or cannot be loaded.
+         * @see tryGetElementProps
+         */
+        getElementProps<T extends ElementProps>(elementId: Id64String | GuidString | Code | ElementLoadProps): T;
+        /** Get properties of an Element by Id, FederationGuid, or Code
+         * @returns The properties of the element or `undefined` if the element is not found.
+         * @throws [[IModelError]] if the element exists, but cannot be loaded.
+         * @note Useful for cases when an element may or may not exist and throwing an `Error` would be overkill.
+         * @see getElementProps
+         */
+        tryGetElementProps<T extends ElementProps>(elementId: Id64String | GuidString | Code | ElementLoadProps): T | undefined;
+        /** Get an element by Id, FederationGuid, or Code
+         * @param elementId either the element's Id, Code, or FederationGuid, or an ElementLoadProps
+         * @param elementClass Optional class to validate instance against. This parameter can accept abstract or concrete classes, but should be the same as the template (`T`) parameter.
+         * @throws [[IModelError]] if the element is not found, cannot be loaded, or fails validation when `elementClass` is specified.
+         * @see tryGetElement
+         */
+        getElement<T extends Element>(elementId: Id64String | GuidString | Code | ElementLoadProps, elementClass?: EntityClassType<Element>): T;
+        /** Get an element by Id, FederationGuid, or Code
+         * @param elementId either the element's Id, Code, or FederationGuid, or an ElementLoadProps
+         * @param elementClass Optional class to validate instance against. This parameter can accept abstract or concrete classes, but should be the same as the template (`T`) parameter.
+         * @returns The element or `undefined` if the element is not found or fails validation when `elementClass` is specified.
+         * @throws [[IModelError]] if the element exists, but cannot be loaded.
+         * @note Useful for cases when an element may or may not exist and throwing an `Error` would be overkill.
+         * @see getElement
+         */
+        tryGetElement<T extends Element>(elementId: Id64String | GuidString | Code | ElementLoadProps, elementClass?: EntityClassType<Element>): T | undefined;
+        /** Query for the Id of the element that has a specified code.
+         * This method is for the case where you know the element's Code.
+         * If you only know the code *value*, then in the simplest case, you can query on that
+         * and filter the results.
+         * In the simple case, call [[IModelDb.queryEntityIds]], specifying the code value in the where clause of the query params.
+         * Or, you can execute an ECSQL select statement. See
+         * [frequently used ECSQL queries]($docs/learning/backend/ECSQL-queries.md) for an example.
+         * @param code The code to look for
+         * @returns The element that uses the code or undefined if the code is not used.
+         * @throws IModelError if the code is invalid
+         */
+        queryElementIdByCode(code: Code): Id64String | undefined;
+        /** Query for the last modified time of the specified element.
+         * @internal
+         */
+        queryLastModifiedTime(elementId: Id64String): string;
+        /** Create a new instance of an element.
+         * @param elProps The properties of the new element.
+         * @throws [[IModelError]] if there is a problem creating the element.
+         */
+        createElement<T extends Element>(elProps: ElementProps): T;
+        /** Insert a new element into the iModel.
+         * @param elProps The properties of the new element.
+         * @returns The newly inserted element's Id.
+         * @throws [[IModelError]] if unable to insert the element.
+         */
+        insertElement(elProps: ElementProps): Id64String;
+        /** Update some properties of an existing element.
+         * To support clearing a property value, every property name that is present in the `elProps` object will be updated even if the value is `undefined`.
+         * To keep an individual element property unchanged, it should either be excluded from the `elProps` parameter or set to its current value.
+         * @param elProps the properties of the element to update.
+         * @note As described above, this is a special case where there is a difference between a property being excluded and a property being present in `elProps` but set to `undefined`.
+         * @throws [[IModelError]] if unable to update the element.
+         */
+        updateElement(elProps: ElementProps): void;
+        /** Delete one or more elements from this iModel.
+         * @param ids The set of Ids of the element(s) to be deleted
+         * @throws [[IModelError]]
+         * @see deleteDefinitionElements
+         */
+        deleteElement(ids: Id64Arg): void;
+        /** DefinitionElements can only be deleted if it can be determined that they are not referenced by other Elements.
+         * This *usage query* can be expensive since it may involve scanning the GeometryStreams of all GeometricElements.
+         * Since [[deleteElement]] does not perform these additional checks, it fails in order to prevent potentially referenced DefinitionElements from being deleted.
+         * This method performs those expensive checks and then calls *delete* if not referenced.
+         * @param ids The Ids of the DefinitionElements to attempt to delete. To prevent multiple passes over the same GeometricElements, it is best to pass in the entire array of
+         * DefinitionElements rather than calling this method separately for each one. Ids that are not valid DefinitionElements will be ignored.
+         * @returns An IdSet of the DefinitionElements that are used and were therefore not deleted.
+         * @see deleteElement
+         * @beta
+         */
+        deleteDefinitionElements(definitionElementIds: Id64Array): Id64Set;
+        /** Query for the child elements of the specified element.
+         * @returns Returns an array of child element identifiers.
+         * @throws [[IModelError]]
+         */
+        queryChildren(elementId: Id64String): Id64String[];
+        /** Returns true if the specified Element has a sub-model.
+         * @see [[IModelDb.Models.getSubModel]]
+         */
+        hasSubModel(elementId: Id64String): boolean;
+        /** Get the root subject element. */
+        getRootSubject(): Subject;
+        /** Query for aspects of a particular class (polymorphically) associated with this element.
+         * @throws [[IModelError]]
+         * @note Most cases should use the [[getAspects]] wrapper rather than calling this method directly.
+         * @internal
+         */
+        _queryAspects(elementId: Id64String, fromClassFullName: string, excludedClassFullNames?: Set<string>): ElementAspect[];
+        /** Query for aspect by ECInstanceId
+         * @throws [[IModelError]]
+         */
+        private _queryAspect;
+        /** Get a single ElementAspect by its instance Id.
+         * @throws [[IModelError]]
+         */
+        getAspect(aspectInstanceId: Id64String): ElementAspect;
+        /** Get the ElementAspect instances that are owned by the specified element.
+         * @param elementId Get ElementAspects associated with this Element
+         * @param aspectClassFullName Optionally filter ElementAspects polymorphically by this class name
+         * @throws [[IModelError]]
+         */
+        getAspects(elementId: Id64String, aspectClassFullName?: string): ElementAspect[];
+        /** Insert a new ElementAspect into the iModel.
+         * @param aspectProps The properties of the new ElementAspect.
+         * @throws [[IModelError]] if unable to insert the ElementAspect.
+         */
+        insertAspect(aspectProps: ElementAspectProps): void;
+        /** Update an exist ElementAspect within the iModel.
+         * @param aspectProps The properties to use to update the ElementAspect.
+         * @throws [[IModelError]] if unable to update the ElementAspect.
+         */
+        updateAspect(aspectProps: ElementAspectProps): void;
+        /** Delete one or more ElementAspects from this iModel.
+         * @param aspectInstanceIds The set of instance Ids of the ElementAspect(s) to be deleted
+         * @throws [[IModelError]] if unable to delete the ElementAspect.
+         */
+        deleteAspect(aspectInstanceIds: Id64Arg): void;
+    }
+    /** The collection of views in an [[IModelDb]].
+     * @public
+     */
+    class Views {
+        private _iModel;
+        /** @internal */
+        constructor(_iModel: IModelDb);
+        /** Query for the array of ViewDefinitionProps of the specified class and matching the specified IsPrivate setting.
+         * @param className Query for view definitions of this class.
+         * @param wantPrivate If true, include private view definitions.
+         */
+        queryViewDefinitionProps(className?: string, limit?: number, offset?: number, wantPrivate?: boolean): ViewDefinitionProps[];
+        /** Default parameters for iterating/querying ViewDefinitions. Includes all subclasses of ViewDefinition, excluding only those marked 'private'. */
+        static readonly defaultQueryParams: ViewQueryParams;
+        /** Iterate all ViewDefinitions matching the supplied query.
+         * @param params Specifies the query by which views are selected.
+         * @param callback Function invoked for each ViewDefinition matching the query. Return false to terminate iteration, true to continue.
+         * @returns true if all views were iterated, false if iteration was terminated early due to callback returning false.
+         *
+         * **Example: Finding all views of a specific DrawingModel**
+         * ``` ts
+         * [[include:IModelDb.Views.iterateViews]]
+         * ```
+         */
+        iterateViews(params: ViewQueryParams, callback: (view: ViewDefinition) => boolean): boolean;
+        getViewStateData(viewDefinitionId: string, options?: ViewStateLoadProps): ViewStateProps;
+        private getViewThumbnailArg;
+        /** Get the thumbnail for a view.
+         * @param viewDefinitionId The Id of the view for thumbnail
+         * @returns the ThumbnailProps, or undefined if no thumbnail exists.
+         */
+        getThumbnail(viewDefinitionId: Id64String): ThumbnailProps | undefined;
+        /** Save a thumbnail for a view.
+         * @param viewDefinitionId The Id of the view for thumbnail
+         * @param thumbnail The thumbnail data.
+         * @returns 0 if successful
+         */
+        saveThumbnail(viewDefinitionId: Id64String, thumbnail: ThumbnailProps): number;
+        /** Set the default view property the iModel
+         * @param viewId The Id of the ViewDefinition to use as the default
+         */
+        setDefaultViewId(viewId: Id64String): void;
+    }
+    /** Represents the current state of a pollable tile content request.
+     * Note: lack of a "completed" state because polling a completed request returns the content as a Uint8Array.
+     * @internal
+     */
+    enum TileContentState {
+        New = 0,
+        Pending = 1,
+        Loading = 2
+    }
+    /** @internal */
+    class Tiles {
+        private _iModel;
+        /** @internal */
+        constructor(_iModel: IModelDb);
+        /** @internal */
+        requestTileTreeProps(id: string): Promise<IModelTileTreeProps>;
+        private pollTileContent;
+        /** @internal */
+        requestTileContent(treeId: string, tileId: string): Promise<IModelJsNative.TileContent>;
+        /** @internal */
+        getTileContent(treeId: string, tileId: string): Promise<Uint8Array>;
+    }
+}
+/**
+ * Argument to a function that can accept a valid access token.
+ * @public
+ */
+export interface TokenArg {
+    /** If present, the access token for the requested operation. If not present, use [[IModelHost.getAccessToken]] */
+    readonly accessToken?: AccessToken;
+}
+/**
+ * Arguments to open a BriefcaseDb
+ * @public
+ */
+export declare type OpenBriefcaseArgs = OpenBriefcaseProps & {
+    rpcActivity?: RpcActivity;
+};
+/**
+ * A local copy of an iModel from iModelHub that can pull and potentially push changesets.
+ * BriefcaseDb raises a set of events to allow apps and subsystems to track its object life cycle, including [[onOpen]] and [[onOpened]].
+ * @public
+ */
+export declare class BriefcaseDb extends IModelDb {
+    /** Manages local changes to this briefcase. */
+    readonly txns: TxnManager;
+    /** override superclass method */
+    get isBriefcase(): boolean;
+    readonly briefcaseId: BriefcaseId;
+    /**
+     * Event raised just before a BriefcaseDb is opened. Supplies the arguments that will be used to open the BriefcaseDb.
+     * Throw an exception to stop the open.
+     *
+     * **Example:**
+     * ``` ts
+     * [[include:BriefcaseDb.onOpen]]
+     * ```
+     */
+    static readonly onOpen: BeEvent<(_args: OpenBriefcaseArgs) => void>;
+    /**
+     * Event raised just after a BriefcaseDb is opened. Supplies the newly opened BriefcaseDb and the arguments that were used to open it.
+     *
+     * **Example:**
+     * ``` ts
+     * [[include:BriefcaseDb.onOpened]]
+     * ```
+     */
+    static readonly onOpened: BeEvent<(_iModelDb: BriefcaseDb, _args: OpenBriefcaseArgs) => void>;
+    static findByKey(key: string): BriefcaseDb;
+    static tryFindByKey(key: string): BriefcaseDb | undefined;
+    /** The Guid that identifies the *context* that owns this iModel. */
+    get iTwinId(): GuidString;
+    /**
+     * Determine whether this BriefcaseDb should use a lock server.
+     * All must be true:
+     * - file is open for write
+     * - has an assigned briefcaseId
+     * - the "no locking" flag is not present. This is a property of an iModel, established when the iModel is created in IModelHub.
+     */
+    protected get useLockServer(): boolean;
+    protected constructor(args: {
+        nativeDb: IModelJsNative.DgnDb;
+        key: string;
+        openMode: OpenMode;
+        briefcaseId: number;
+    });
+    /** Upgrades the profile or domain schemas. File must be closed before this call and is always left closed. */
+    private static doUpgrade;
+    /** Upgrades the schemas in the iModel based on the current version of the software. Follows a sequence of operations -
+     * * Acquires a schema lock to prevent other users from making any other changes while upgrade is happening
+     * * Updates the local briefcase with the schema changes.
+     * * Pushes the resulting changeset(s) to iModelHub.
+     * Note that the upgrade requires that the local briefcase be closed, and may result in one or two change sets depending on whether both
+     * profile and domain schemas need to get upgraded.
+     * @see ($docs/learning/backend/IModelDb.md#upgrading-schemas-in-an-imodel)
+    */
+    static upgradeSchemas(briefcase: OpenBriefcaseArgs): Promise<void>;
+    /** Open a briefcase file and return a new BriefcaseDb to interact with it.
+     * @param args parameters that specify the file name, and options for opening the briefcase file
+     */
+    static open(args: OpenBriefcaseArgs): Promise<BriefcaseDb>;
+    private closeAndReopen;
+    /** Pull and apply changesets from iModelHub */
+    pullChanges(arg?: PullChangesArgs): Promise<void>;
+    /** Push changes to iModelHub. */
+    pushChanges(arg: PushChangesArgs): Promise<void>;
+}
+/** A *snapshot* iModel database file that is used for archival and data transfer purposes.
+ * @see [Snapshot iModels]($docs/learning/backend/AccessingIModels.md#snapshot-imodels)
+ * @see [About IModelDb]($docs/learning/backend/IModelDb.md)
+ * @public
+ */
+export declare class SnapshotDb extends IModelDb {
+    get isSnapshot(): boolean;
+    private _daemonReattach;
+    private _createClassViewsOnClose?;
+    private constructor();
+    static findByKey(key: string): SnapshotDb;
+    static tryFindByKey(key: string): SnapshotDb | undefined;
+    /** Create an *empty* local [Snapshot]($docs/learning/backend/AccessingIModels.md#snapshot-imodels) iModel file.
+     * Snapshots are not synchronized with iModelHub, so do not have a change timeline.
+     * > Note: A *snapshot* cannot be modified after [[close]] is called.
+     * @param filePath The file that will contain the new iModel *snapshot*
+     * @param options The parameters that define the new iModel *snapshot*
+     * @returns A writeable SnapshotDb
+     * @see [Snapshot iModels]($docs/learning/backend/AccessingIModels.md#snapshot-imodels)
+     */
+    static createEmpty(filePath: LocalFileName, options: CreateEmptySnapshotIModelProps): SnapshotDb;
+    /** Create a local [Snapshot]($docs/learning/backend/AccessingIModels.md#snapshot-imodels) iModel file, using this iModel as a *seed* or starting point.
+     * Snapshots are not synchronized with iModelHub, so do not have a change timeline.
+     * > Note: A *snapshot* cannot be modified after [[close]] is called.
+     * @param iModelDb The snapshot will be initialized from the current contents of this iModelDb
+     * @param snapshotFile The file that will contain the new iModel *snapshot*
+     * @param options Optional properties that determine how the snapshot iModel is created.
+     * @returns A writeable SnapshotDb
+     * @see [Snapshot iModels]($docs/learning/backend/AccessingIModels.md#snapshot-imodels)
+     */
+    static createFrom(iModelDb: IModelDb, snapshotFile: string, options?: CreateSnapshotIModelProps): SnapshotDb;
+    /** open this SnapshotDb read/write, strictly to apply incoming changesets. Used for creating new checkpoints.
+     * @internal
+     */
+    static openForApplyChangesets(path: LocalFileName, props?: SnapshotOpenOptions): SnapshotDb;
+    /** Open a read-only iModel *snapshot*.
+     * @param path the full path of the snapshot iModel file to open.
+     * @param props options for opening snapshot
+     * @see [[close]]
+     * @throws [[IModelError]] If the file is not found or is not a valid *snapshot*.
+     */
+    static openFile(path: LocalFileName, opts?: SnapshotOpenOptions): SnapshotDb;
+    /** Open a previously downloaded V1 checkpoint file.
+     * @note The key is generated by this call is predictable and is formed from the IModelId and ChangeSetId.
+     * This is so every backend working on the same checkpoint will use the same key, to permit multiple backends
+     * servicing the same checkpoint.
+     * @internal
+     */
+    static openCheckpointV1(fileName: LocalFileName, checkpoint: CheckpointProps): SnapshotDb;
+    /** Open a V2 *checkpoint*, a special form of snapshot iModel that represents a read-only snapshot of an iModel from iModelHub at a particular point in time.
+     * > Note: The checkpoint daemon must already be running and a checkpoint must already exist in iModelHub's storage *before* this function is called.
+     * @param checkpoint The checkpoint to open
+     * @note The key is generated by this call is predictable and is formed from the IModelId and ChangeSetId.
+     * This is so every backend working on the same checkpoint will use the same key, to permit multiple backends
+     * servicing the same checkpoint.
+     * @throws [[IModelError]] If the checkpoint is not found in iModelHub or the checkpoint daemon is not supported in the current environment.
+     * @internal
+     */
+    static openCheckpointV2(checkpoint: CheckpointProps): Promise<SnapshotDb>;
+    /** Used to refresh the daemon's accessToken if this is a V2 checkpoint.
+     * @internal
+     */
+    reattachDaemon(accessToken: AccessToken): Promise<void>;
+    /** @internal */
+    beforeClose(): void;
+}
+/**
+ * Standalone iModels are read/write files that are not associated with an iTwin or managed by iModelHub.
+ * They are relevant only for testing, or for small-scale single-user scenarios.
+ * Standalone iModels are designed such that the API for Standalone iModels and Briefcase
+ * iModels (those synchronized with iModelHub) are as similar and consistent as possible.
+ * This leads to a straightforward process where the a user starts with StandaloneDb and can
+ * optionally choose to upgrade to an iTwin.
+ *
+ * Some additional details. Standalone iModels:
+ * - always have [Guid.empty]($bentley) for their iTwinId (they are "unassociated" files)
+ * - always have BriefcaseId === [BriefcaseIdValue.Unassigned]($common)
+ * - are connected to the frontend via [BriefcaseConnection.openStandalone]($frontend)
+ * - may be opened without supplying any user credentials
+ * - may be opened read/write
+ * - cannot apply a changeset to nor generate a changesets (since there is no timeline from which to get/push changesets)
+ * @public
+ */
+export declare class StandaloneDb extends BriefcaseDb {
+    get isStandalone(): boolean;
+    protected get useLockServer(): boolean;
+    static findByKey(key: string): StandaloneDb;
+    static tryFindByKey(key: string): StandaloneDb | undefined;
+    /** Create an *empty* standalone iModel.
+     * @param filePath The file path for the iModel
+     * @param args The parameters that define the new iModel
+     */
+    static createEmpty(filePath: LocalFileName, args: CreateEmptyStandaloneIModelProps): StandaloneDb;
+    /**
+     * Upgrades the schemas in the standalone iModel file.
+     * Note that the upgrade requires that the file be closed, and will leave it back in the closed state.
+     * @param filePath Full path name of the standalone iModel file.
+     * @see ($docs/learning/backend/IModelDb.md#upgrading-schemas-in-an-imodel)
+     * @see [[StandaloneDb.validateSchemas]]
+     */
+    static upgradeStandaloneSchemas(filePath: LocalFileName): void;
+    /** Open a standalone iModel file.
+     * @param filePath The path of the standalone iModel file.
+     * @param openMode Optional open mode for the standalone iModel. The default is read/write.
+     * @throws [[IModelError]] if the file is not a standalone iModel.
+     * @see [BriefcaseConnection.openStandalone]($frontend) to open a StandaloneDb from the frontend
+     */
+    static openFile(filePath: LocalFileName, openMode?: OpenMode, options?: StandaloneOpenOptions): StandaloneDb;
+}
+//# sourceMappingURL=IModelDb.d.ts.map