analytics-catalog-domain/me.ahoo.wow.analytics.catalog.domain.dataset/Dataset

Dataset

@AggregateRoot(lifecycle = [], ownership = Ownership.TENANT)

@Description(value = "A wide table over the catalog's sources: its definition, its versions and where each is published")

class Dataset(state: DatasetState)

A wide table over the catalog's sources (-2), named as its queries read it, <context>.<name>: an analyst drafts and revises its definition, which the catalog checks against its sources as they are each time (DatasetBinder), and publishes it, each version compiled into its own view (DatasetCompiler) which the publication creates in the warehouse; queries read the current version until the dataset is switched back to another or retired, whose views are dropped once the retention ends.

Constructors

Dataset

constructor(state: DatasetState)

Functions

onApprovePublication

@OnCommand(schedules = [DropDatasetViews::class])

suspend fun onApprovePublication(command: ApproveDatasetPublication, sources: DatasetSources, warehouse: DatasetWarehouse, policy: DatasetPolicy, scope: DecideScope): DatasetPublished

onDraft

@OnCommand

suspend fun onDraft(command: Command<DraftDataset>, sources: DatasetSources, known: KnownAggregates): DatasetDrafted

onDrop

@OnCommand

suspend fun onDrop(command: DropDatasetViews, warehouse: DatasetWarehouse): DatasetViewsDropped?

onPublish

@OnCommand(produces = [DatasetPublished::class, DatasetPublicationRequested::class], schedules = [DropDatasetViews::class])

suspend fun onPublish(command: PublishDataset, sources: DatasetSources, warehouse: DatasetWarehouse, policy: DatasetPolicy, scope: DecideScope): Decision

onRecompile

@OnCommand(produces = [DatasetPublished::class, DatasetNeedsRevision::class, DatasetRevisionCleared::class])

suspend fun onRecompile(command: RecompileDataset, sources: DatasetSources, warehouse: DatasetWarehouse, policy: DatasetPolicy): Decision

Compiles the published definition again after a source changed (-2). The same compilation changes nothing (or clears a revision it needed). Another one is published as the next version only when its contract holds: the view gives the same columns, by name and type, as the published one, and it takes no new approval, so only its masking or its rendering differs. Anything else (a definition that no longer compiles, columns that would change, a new approval) marks the dataset as needing revision; the published version goes on serving while its view still gives the columns it was published with, and is refused otherwise.

onRefusePublication

@OnCommand

fun onRefusePublication(command: RefuseDatasetPublication): DatasetPublicationRefused

onRetire

@OnCommand(schedules = [DropDatasetViews::class])

fun onRetire(command: RetireDataset, policy: DatasetPolicy, scope: DecideScope): DatasetRetired?

onRevise

@OnCommand(produces = [DatasetRevised::class, DatasetNeedsRevision::class])

suspend fun onRevise(command: ReviseDataset, sources: DatasetSources, policy: DatasetPolicy): Decision

Replaces the definition and title, checked as a draft's are. A dataset that needs revision says, from then on, what is wrong with the revised definition rather than with the one it replaced: none of it once the revision compiles, which a publication then serves.

onRollback

@OnCommand(schedules = [DropDatasetViews::class])

suspend fun onRollback(command: RollbackDataset, warehouse: DatasetWarehouse, scope: DecideScope): DatasetRolledBack?