Delva/app.oreshkov.delva/BlockingJsonStore

BlockingJsonStore

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

interface BlockingJsonStore : BlockingReadableJsonStore(source)

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

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

Properties

creationOptions

abstract val creationOptions: CreationOptions

See ReadableJsonStore.creationOptions.

Functions

assignType

abstract fun assignType(node: NodeRef, type: String?)

See JsonStore.assignType.

assignTypes

abstract fun assignTypes(assignments: List<Pair<NodeRef, String?>>)

See JsonStore.assignTypes.

clearType

abstract fun clearType(type: String): Long

See JsonStore.clearType.

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.

delete

abstract fun delete(docId: DocId): Boolean

See JsonStore.delete.

deleteAll

abstract fun deleteAll(docIds: Collection<DocId>): Int

See JsonStore.deleteAll.

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.

insert

abstract fun insert(source: InputStream, types: Map<String, String> = emptyMap()): DocId

abstract fun insert(path: Path, types: Map<String, String> = emptyMap()): DocId

See JsonStore.insert.

abstract fun insert(json: String, types: Map<String, String> = emptyMap()): DocId

Inserts a document given as a string; meant for small documents.

insertAll

abstract fun insertAll(sources: Iterable<InsertSource>): List<InsertOutcome>

See JsonStore.insertAll.

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.

replace

@ExperimentalDelvaApi

abstract fun replace(docIds: Collection<DocId>, source: InputStream, types: Map<String, String> = emptyMap()): DocId

@ExperimentalDelvaApi

abstract fun replace(docIds: Collection<DocId>, path: Path, types: Map<String, String> = emptyMap()): DocId

@ExperimentalDelvaApi

abstract fun replace(docIds: Collection<DocId>, json: String, types: Map<String, String> = emptyMap()): DocId

See JsonStore.replace.

@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.

upsert

@ExperimentalDelvaApi

abstract fun upsert(source: InputStream, types: Map<String, String> = emptyMap()): DocId

@ExperimentalDelvaApi

abstract fun upsert(path: Path, types: Map<String, String> = emptyMap()): DocId

@ExperimentalDelvaApi

abstract fun upsert(json: String, types: Map<String, String> = emptyMap()): DocId

See JsonStore.upsert.

verify

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

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