wow-dataset-registry-domain/me.ahoo.wow.datasetregistry.domain

Package-level declarations

Types

A dataset of the registry (dataset platform design §4.1, §4.2). It is drafted once from a table, revised and reviewed any number of times, and published when its draft passes the publication gate:

DatasetDraft

data class DatasetDraft(val document: ObjectNode, val skipped: List<SkippedColumn> = emptyList())

A declaration drafted from a table, and the columns it leaves out.

DatasetPublicationCheck

fun interface DatasetPublicationCheck

Proves that this instance can serve QueryDataset before it is published: its name is not taken by a dataset of a declaration file, and its declaration compiles against its table. A refusal is a DatasetRegistryException.

DatasetRegistryBoundedContext

@BoundedContext(name = "dataset-registry")

object DatasetRegistryBoundedContext

DatasetRegistryException

class DatasetRegistryException(errorCode: String, errorMsg: String, cause: Throwable? = null) : WowException

A dataset registry rule the request broke, under one of DatasetRegistryErrorCodes.

DatasetState

class DatasetState(val id: String)

A dataset of the registry: its draft (a declaration being written, and the sensitivity reviews of its fields) and the version it serves, if any. The aggregate id is the dataset's name.

DatasetTableInspector

fun interface DatasetTableInspector

Drafts a dataset declaration from a table of the backend that serves datasets, such as ClickHouse's system.columns, in the named source (the default one when null); the draft's storage binding names that source. An unknown table or source is a DatasetRegistryException.invalid.