Delva/app.oreshkov.delva/BlockingReadableJsonStore

BlockingReadableJsonStore

@SubclassOptInRequired(markerClass = [DelvaImplementationApi::class])

interface BlockingReadableJsonStore(source)

The operations of ReadableJsonStore without coroutines, obtained from ReadableJsonStore.blocking. Thread-safe.

It is a view of a store and deliberately not AutoCloseable: the store owns the files, so it is the store that is closed, typically with JsonStore.open(dir).use { … }.

Inheritors

BlockingJsonStore

BlockingSecondaryJsonStore

Properties

creationOptions

abstract val creationOptions: CreationOptions

See ReadableJsonStore.creationOptions.

Functions

count

@ExperimentalDelvaApi

abstract fun count(query: DocumentKeyQuery, atMost: Long = Long.MAX_VALUE): Long

abstract fun count(query: JsonPathQuery, atMost: Long = Long.MAX_VALUE): Long

abstract fun count(query: KeyValueQuery, atMost: Long = Long.MAX_VALUE): Long

See ReadableJsonStore.count.

countOfType

abstract fun countOfType(type: String): Long

See ReadableJsonStore.countOfType.

diff

abstract fun diff(a: CompareOperand, b: CompareOperand, options: DiffOptions = DiffOptions()): List<Difference>

The differences of ReadableJsonStore.diff, at most DiffOptions.maxDifferences of them.

explain

abstract fun explain(query: JsonPathQuery): QueryPlan

See ReadableJsonStore.explain.

get

@ExperimentalDelvaApi

abstract fun get(key: String): DocId?

See ReadableJsonStore.get.

info

abstract fun info(): StoreInfo

See ReadableJsonStore.info.

isEqual

abstract fun isEqual(a: CompareOperand, b: CompareOperand, options: CompareOptions = CompareOptions()): Boolean

See ReadableJsonStore.isEqual.

listTypes

abstract fun listTypes(): List<TypeInfo>

See ReadableJsonStore.listTypes.

objectsOfType

abstract fun objectsOfType(type: String, after: NodeRef? = null, limit: Int = 100): List<NodeRef>

See ReadableJsonStore.objectsOfType.

objectsOfTypePage

abstract fun objectsOfTypePage(type: String, after: Cursor? = null, limit: Int = 100): TypePage

See ReadableJsonStore.objectsOfTypePage.

pathOf

abstract fun pathOf(node: NodeRef): String

See ReadableJsonStore.pathOf.

@ExperimentalDelvaApi

abstract fun search(query: DocumentKeyQuery): SearchResult

abstract fun search(query: JsonPathQuery): SearchResult

See ReadableJsonStore.search.

abstract fun search(query: KeyValueQuery): SearchResult

Starts a search on the current state; close the result when done.

select

abstract fun select(node: NodeRef, path: JsonPath): SelectResult

See ReadableJsonStore.select.

typeOf

abstract fun typeOf(node: NodeRef): String?

See ReadableJsonStore.typeOf.

verify

abstract fun verify(progress: VerifyProgress = VerifyProgress { _, _, _ -> }): VerifyReport

See ReadableJsonStore.verify; throwing from progress stops the scrub with that exception.