API Reference › core-backend› ViewDefinitions › ViewStore › ViewStore.ViewDb

ViewStore.ViewDb Class

methods of cloud ViewDb for read access

Extends

Implements

Methods

Name Description
constructor(arg?: ViewStore.ViewDbCtorArgs): ViewStore.ViewDb    
addCategorySelector(args: { name?: string, owner?: string, selector: ViewStoreRpc.SelectorProps }): Promise<string>    
addDisplayStyle(args: { className: string, name?: string, owner?: string, settings: DisplayStyleSettingsProps }): Promise<string>    
addModelSelector(args: { name?: string, owner?: string, selector: ViewStoreRpc.SelectorProps }): Promise<string>    
addOrReplaceThumbnail(args: { owner?: string, thumbnail: ThumbnailProps, viewId: RowIdOrString }): Promise<void>    
addTagsToView(args: { owner?: string, tags: string[], viewId: RowIdOrString }): Promise<void>    
addTimeline(args: { name?: string, owner?: string, timeline: RenderSchedule.ScriptProps }): Promise<string>    
addView(args: ViewStoreRpc.AddViewArgs): Promise<string>    
addViewGroup(args: { name: string, owner?: string, parentId?: string }): Promise<string>    
changeDefaultViewId(args: { defaultView: RowIdOrString, group?: string }): Promise<void>    
createDDL(): void Protected create all the tables for a new ViewDb  
deleteCategorySelector(args: { id: RowIdOrString }): Promise<void>    
deleteCategorySelectorSync(id: RowIdOrString): void    
deleteDisplayStyle(args: { id: RowIdOrString }): Promise<void>    
deleteDisplayStyleSync(id: RowIdOrString): void    
deleteModelSelector(args: { id: RowIdOrString }): Promise<void>    
deleteModelSelectorSync(id: RowIdOrString): void    
deleteSearch(id: number): void    
deleteTag(arg: { name: string }): Promise<void>    
deleteTagSync(arg: { name: string }): void    
deleteThumbnail(arg: { viewId: string }): Promise<void>    
deleteThumbnailSync(id: string): void    
deleteTimeline(args: { id: RowIdOrString }): Promise<void>    
deleteTimelineSync(id: RowIdOrString): void    
deleteView(arg: { viewId: RowIdOrString }): Promise<void>    
deleteViewGroup(args: { name: string }): Promise<void>    
findViewGroup(groupName: string): number find a group with the specified name using path syntax (e.g., "group1/design/issues").  
findViewsByOwner(args: { owner: string }): Promise<ViewStoreRpc.ViewInfo[]> Find all views owned by the supplied owner name.  
getCategorySelector(args: ViewStoreRpc.NameOrId & ViewStoreRpc.QueryBindings): Promise<CategorySelectorProps> Get a category selector by Id.  
getDisplayStyle(args: ViewStoreRpc.NameOrId & { opts?: DisplayStyleLoadProps }): Promise<DisplayStyleProps> Get a display style by Id.  
getDisplayStyleSync(args: ViewStoreRpc.NameOrId & { opts?: DisplayStyleLoadProps }): DisplayStyleProps    
getModelSelector(args: ViewStoreRpc.NameOrId & ViewStoreRpc.QueryBindings): Promise<ModelSelectorProps> Get a model selector by Id.  
getModelSelectorSync(args: ViewStoreRpc.NameOrId & ViewStoreRpc.QueryBindings): ModelSelectorProps    
getTagsForView(viewId: RowIdOrString): undefined | string[] get the array of tags for the specified view.  
getThumbnail(args: { viewId: RowIdOrString }): Promise<undefined | ThumbnailProps> Get a thumbnail for a view.  
getThumbnailSync(args: { viewId: RowIdOrString }): undefined | ThumbnailProps    
getTimeline(args: ViewStoreRpc.NameOrId): Promise<RenderTimelineProps> Get a render timeline by Id.  
getTimelineSync(args: ViewStoreRpc.NameOrId): RenderTimelineProps    
getViewByName(arg: { groupId?: RowIdOrString, name: string }): Promise<undefined | ViewStoreRpc.ViewInfo> Get a view by name.  
getViewByNameSync(arg: { groupId?: RowIdOrString, name: string }): undefined | ViewStoreRpc.ViewInfo    
getViewDefinition(args: { viewId: RowIdOrString }): Promise<ViewDefinitionProps> Get a view definition by viewId.  
getViewDefinitionSync(args: { viewId: RowIdOrString }): ViewDefinitionProps    
getViewGroupInfo(args: { groupId?: string }): Promise<undefined | ViewStoreRpc.ViewGroupInfo> get the properties of a ViewGroup by id.  
getViewGroups(args: { parent?: string }): Promise<{ id: string, name: string }[]> Get a list of ViewGroups that are children of the supplied parent.  
getViewInfo(args: { viewId: RowIdOrString }): Promise<undefined | ViewStoreRpc.ViewInfo> Get the ViewInfo for a view by Id.  
queryViews(queryParams: ViewStoreRpc.QueryParams): Promise<ViewStoreRpc.ViewInfo[]> Query for a list of ViewInfos for views that match the supplied QueryParams.  
queryViewsSync(queryParams: ViewStoreRpc.QueryParams): ViewStoreRpc.ViewInfo[]    
removeTagFromView(args: { tag: string, viewId: RowIdOrString }): Promise<void>    
renameCategorySelector(args: { id: RowIdOrString, name?: string }): Promise<void>    
renameDisplayStyle(args: { id: RowIdOrString, name?: string }): Promise<void>    
renameModelSelector(args: { id: RowIdOrString, name?: string }): Promise<void>    
renameSearch(args: { id: RowIdOrString, name: string }): Promise<void>    
renameTag(args: { newName: string, oldName: string }): Promise<void>    
renameTimeline(args: { id: RowIdOrString, name?: string }): Promise<void>    
renameView(args: { name: string, viewId: RowIdOrString }): Promise<void>    
renameViewGroup(args: { groupId: RowIdOrString, name: string }): Promise<void>    
updateCategorySelector(args: ViewStoreRpc.NameOrId & { selector: ViewStoreRpc.SelectorProps }): Promise<void>    
updateDisplayStyle(args: ViewStoreRpc.NameOrId & { className: string, settings: DisplayStyleSettingsProps }): Promise<void>    
updateModelSelector(args: ViewStoreRpc.NameOrId & { selector: ViewStoreRpc.SelectorProps }): Promise<void>    
updateTimeline(args: ViewStoreRpc.NameOrId & { timeline: RenderSchedule.ScriptProps }): Promise<void>    
updateViewDefinition(args: { viewDefinition: ViewDefinitionProps, viewId: RowIdOrString }): Promise<void>    
updateViewShared(arg: { isShared: boolean, owner?: string, viewId: RowIdOrString }): Promise<void>    

Inherited methods

Name Inherited from Description
abandonChanges(): void VersionedSqliteDb Abandon (cancel) the outermost transaction, discarding all changes since last save.
closeDb(saveChanges?: boolean): void VersionedSqliteDb Close SQLiteDb.
createDb(dbName: string): void VersionedSqliteDb Create a SQLiteDb
createDb(dbName: string, container?: CloudSqlite.CloudContainer, params?: SQLiteDb.CreateParams): void VersionedSqliteDb  
createTable(args: { addTimestamp?: boolean, columns: string, constraints?: string, tableName: string }): void Protected VersionedSqliteDb Create a new table in this database.
dispose(): void VersionedSqliteDb alias for closeDb.
executeSQL(sql: string): DbResult VersionedSqliteDb execute an SQL statement
getRequiredVersions(): SQLiteDb.RequiredVersionRanges VersionedSqliteDb Get the required version ranges necessary to open this VersionedSqliteDb.
openDb(dbName: string, openMode: OpenMode | SQLiteDb.OpenParams, container?: CloudSqlite.CloudContainer): void VersionedSqliteDb Open this database and verify that this version of the software meets the required version range (as appropriate, read or write) stored in the database.
readLastModTime(tableName: string, rowId: number): Date VersionedSqliteDb Get the last modified date for a row in a table of this database.
saveChanges(): void VersionedSqliteDb Commit the outermost transaction, writing changes to the file.
setRequiredVersions(versions: SQLiteDb.RequiredVersionRanges): void VersionedSqliteDb Change the "versions required to open this database" property stored in this database.
upgradeSchema(arg: { dbName: string, lockContainer?: { container: CloudSqlite.CloudContainer, user: string }, upgradeFn: () => void }): Promise<void | () => void> VersionedSqliteDb  
vacuum(args?: SQLiteDb.VacuumDbArgs): void VersionedSqliteDb vacuum this database
verifyVersions(): void Protected VersionedSqliteDb Verify that this version of the software meets the required version range (as appropriate, read or write) stored in the database.
withOpenDb<T>(args: SQLiteDb.WithOpenDbArgs, operation: () => T): T VersionedSqliteDb Open a database, perform an operation, then close the database.
withPreparedSqliteStatement<T>(sql: string, callback: (stmt: SqliteStatement) => T): T VersionedSqliteDb Use a prepared SQL statement, potentially from the statement cache.
withSavePoint(savePointName: string, operation: () => void): void VersionedSqliteDb Perform an operation on this database within a savepoint.
withSqliteStatement<T>(sql: string, callback: (stmt: SqliteStatement) => T): T VersionedSqliteDb Prepare and execute a callback on a SQL statement.
createNewDb(fileName: string): void Static VersionedSqliteDb Create a new database file for the subclass of VersionedSqliteDb.

Properties

Name Type Description
guidMap Accessor IModelDb.GuidMapper    
iModel Accessor IModelDb    
myVersion string The current semver "persistence version" of this class.  

Inherited properties

Name Type Inherited from Description
_versionProps Protected Static { name: "versions", namespace: "SQLiteDb" } VersionedSqliteDb  
isOpen Accessor ReadOnly boolean VersionedSqliteDb Returns true if this SQLiteDb is open
isReadonly Accessor ReadOnly boolean VersionedSqliteDb Returns true if this SQLiteDb is open readonly

Defined in

Last Updated: 15 May, 2024