@itwin/core-common/lib/esm/ChangesetProps.d.ts

iTwin.js components common to frontend and backend

/**
 * @packageDocumentation
 * @module iModels
 */
/** @public */
export type LocalFileName = string;
/** @public */
export type LocalDirName = string;
/** A string that identifies a changeset.
 * @note this string is *not* a Guid. It is generated internally based on the content of the changeset.
 * @public
 * @extensions
 */
export type ChangesetId = string;
/** The index of a changeset, assigned by iModelHub.
 * @note 0 means "before the first changeset." Values less than 0 are invalid.
 * @public
 * @extensions
 */
export type ChangesetIndex = number;
/** Both the index and Id of a changeset
 * @public
 * @extensions
 */
export interface ChangesetIndexAndId {
    readonly index: ChangesetIndex;
    readonly id: ChangesetId;
}
/** The Id and optionally the index of a changeset
 * @public
 * @extensions
 */
export interface ChangesetIdWithIndex {
    readonly index?: ChangesetIndex;
    readonly id: ChangesetId;
}
/** either changeset index, id, or both
* @public
 * @extensions
*/
export type ChangesetIndexOrId = ChangesetIndexAndId | {
    readonly index: ChangesetIndex;
    readonly id?: never;
} | {
    readonly id: ChangesetId;
    readonly index?: never;
};
/** Value to indicate whether a changeset contains schema changes or not
 * @public
 * @extensions
 */
export declare enum ChangesetType {
    /** changeset does *not* contain schema changes. */
    Regular = 0,
    /** changeset *does* contain schema changes. */
    Schema = 1,
    /** Schema changeset pushed by iModel with SchemaSync enabled */
    SchemaSync = 65
}
/** Properties of a changeset
 * @public
 */
export interface ChangesetProps {
    /** The index (sequence number) from IModelHub for this changeset. Larger index values were pushed later. */
    index: ChangesetIndex;
    /** the ChangesetId */
    id: ChangesetId;
    /** the ChangeSetId of the parent changeset of this changeset */
    parentId: ChangesetId;
    /** The type of changeset */
    changesType: ChangesetType;
    /** The user-supplied description of the work this changeset holds */
    description: string;
    /** The BriefcaseId of the briefcase that created this changeset */
    briefcaseId: number;
    /** The date this changeset was uploaded to the hub */
    pushDate: string;
    /** The identity of the user that created this changeset */
    userCreated: string;
    /** The size, in bytes, of this changeset */
    size: number;
    /** The uncompressed size, in bytes, of this changeset */
    uncompressedSize?: number;
}
/** Properties of a changeset file
 * @public
 */
export interface ChangesetFileProps extends ChangesetProps {
    /** The full pathname of the local file holding this changeset. */
    pathname: LocalFileName;
}
/**
 * A range of changesets
 * @public
 * @extensions
 */
export interface ChangesetRange {
    /** index of the first changeset */
    first: ChangesetIndex;
    /** index of last changeset. If undefined, all changesets after first are returned. */
    end?: ChangesetIndex;
}
/**
 * Statistics for a single SQL statement executed during changeset application.
 * @beta
 */
export interface PerStatementHealthStats {
    sqlStatement: string;
    dbOperation: string;
    rowCount: number;
    elapsedMs: number;
    fullTableScans: number;
}
/**
 * Aggregated health statistics for a changeset application.
 * @beta
 */
export interface ChangesetHealthStats {
    changesetId: string;
    uncompressedSizeBytes: number;
    sha1ValidationTimeMs: number;
    insertedRows: number;
    updatedRows: number;
    deletedRows: number;
    totalElapsedMs: number;
    totalFullTableScans: number;
    perStatementStats: [PerStatementHealthStats];
}
//# sourceMappingURL=ChangesetProps.d.ts.map