model-client/org.modelix.model.client2/IModelClientV2

IModelClientV2

This interface is meant exclusively for model client usage.

It is designed to ensure decoupling between model client usage operations and other aspects, such as lifecycle management. Users of this interface cannot incidentally depend on non-usage functionality. See also: Interface segregation principle

Specifically, this interface should not be used for managing the client's lifecycle, as the lifecycle management may vary depending on the specific implementation. If you need to manage the client's lifecycle, use the methods in the class interface of the concrete implementations, such as ModelClientV2.

Inheritors

IModelClientV2Internal

ModelClientV2

Functions

deleteBranch

abstract suspend fun deleteBranch(branch: BranchReference): Boolean

Deletes a branch from a repository if it exists.

deleteRepository

abstract suspend fun deleteRepository(repository: RepositoryId): Boolean

getClientId

abstract fun getClientId(): Int

getIdGenerator

abstract fun getIdGenerator(): IIdGenerator

getReplicatedModel

fun IModelClientV2.getReplicatedModel(branchRef: BranchReference): ReplicatedModel

fun IModelClientV2.getReplicatedModel(branchRef: BranchReference, scope: CoroutineScope): ReplicatedModel

getUserId

abstract fun getUserId(): String?

initRepository

abstract suspend fun initRepository(repository: RepositoryId, useRoleIds: Boolean = true): IVersion

initRepositoryWithLegacyStorage

abstract suspend fun initRepositoryWithLegacyStorage(repository: RepositoryId): IVersion

lazyLoadVersion

suspend fun IModelClientV2.lazyLoadVersion(branchRef: BranchReference, config: CacheConfiguration = CacheConfiguration()): IVersion

An overload of IModelClientV2.lazyLoadVersion that reads the current version hash of the branch from the server and then loads that version with lazy loading support.

fun IModelClientV2.lazyLoadVersion(repositoryId: RepositoryId, versionHash: String, config: CacheConfiguration = CacheConfiguration()): IVersion

This function loads parts of the model lazily while it is iterated and limits the amount of data that is cached on the client side.

listBranches

abstract suspend fun listBranches(repository: RepositoryId): List<BranchReference>

listRepositories

abstract suspend fun listRepositories(): List<RepositoryId>

loadVersion

abstract suspend fun ~~loadVersion~~(versionHash: String, baseVersion: IVersion?): IVersion

abstract suspend fun loadVersion(repositoryId: RepositoryId, versionHash: String, baseVersion: IVersion?): IVersion

poll

abstract suspend fun poll(branch: BranchReference, lastKnownVersion: IVersion?): IVersion

While pull returns immediately poll returns as soon as a new version, that is different from the given lastKnownVersion, is pushed to the server or after some timeout specified by the server (usually ~30 seconds).

pollHash

abstract suspend fun pollHash(branch: BranchReference, lastKnownHash: String?): String

abstract suspend fun pollHash(branch: BranchReference, lastKnownVersion: IVersion?): String

pull

abstract suspend fun pull(branch: BranchReference, lastKnownVersion: IVersion?): IVersion

pullHash

abstract suspend fun pullHash(branch: BranchReference): String

pullIfExists

abstract suspend fun pullIfExists(branch: BranchReference): IVersion?

push

abstract suspend fun push(branch: BranchReference, version: IVersion, baseVersion: IVersion?): IVersion

The pushed version is merged automatically by the server with the current head. The merge result is returned.

query

abstract suspend fun <R> query(branch: BranchReference, body: (IMonoStep<INode>) -> IMonoStep<R>): R

abstract suspend fun <R> query(repositoryId: RepositoryId, versionHash: String, body: (IMonoStep<INode>) -> IMonoStep<R>): R

runWrite

suspend fun <T> IModelClientV2.runWrite(branchRef: BranchReference, body: (INode) -> T): T

Performs a write transaction on the root node of the given branch.

runWriteOnBranch

suspend fun <T> IModelClientV2.runWriteOnBranch(branchRef: BranchReference, body: (IBranch) -> T): T

Performs a write transaction on the root node of the given branch.