Onyx 0.14.4 API documentation

Public variables and functions:

• await-job-completion
• build-resume-point
• clear-checkpoints
• clear-job-data
• clear-tenancy
• gc
• gc-checkpoints
• job-ids-history
• job-snapshot-coordinates
• job-state
• kill-job
• map-set-workflow->workflow
• named-job-snapshot-coordinates
• shutdown-env
• shutdown-peer
• shutdown-peer-group
• shutdown-peers
• start-env
• start-peer-group
• start-peers
• submit-job
• subscribe-to-log
• validate-submission

Public variables and functions:

• assume-checkpoint-coordinate
• cancel!
• complete?
• gc-checkpoint!
• gc-replica-epoch-watermark!
• read-all-replica-epoch-watermarks
• read-checkpoint
• read-checkpoint-coordinate
• read-replica-epoch-low-watermark
• stop
• storage
• watch-checkpoint-coordinate
• write-checkpoint
• write-checkpoint-coordinate
• write-replica-epoch-low-watermark
• write-replica-epoch-watermark

Public variables and functions:

• checkpoint-compress
• checkpoint-compress-opts
• checkpoint-decompress
• checkpoint-decompress-opts
• messaging-compress
• messaging-compress-opts
• messaging-decompress
• messaging-decompress-opts
• statedb-compress
• statedb-decompress
• window-log-compress
• window-log-decompress
• window-log-decompress-opts
• zookeeper-compress
• zookeeper-compress-opts
• zookeeper-decompress
• zookeeper-decompress-opts

Public variables and functions:

• lookup-categories
• lookup-doc

Public variables and functions:

• apply-log-entry
• connected?
• fire-side-effects!
• force-write-chunk
• gc-log-entry
• group-exists?
• IEmitEvent
• job-status
• monitoring-agent
• new-task-state!
• on-delete
• reactions
• read-chunk
• read-job-name-metadata
• read-log-entry
• register-pulse
• replica-diff
• subscribe-to-log
• update-origin!
• write-chunk
• write-job-name-metadata
• write-log-entry

Public variables and functions:

• build-pred-fn
• compile-fc-exception-path
• compile-fc-happy-path
• compile-flow-conditions
• egress-tasks
• only-relevant-branches
• pred-fn?

Public variables and functions:

• apply-post-transformation
• choose-output-paths
• flow-conditions-transform
• join-output-paths
• maybe-attach-segment
• route-data

Public variables and functions:

• attempt-deletion-past-successful-checkpoint-count
• build-checkpoint-targets
• gc-checkpoints
• gc-log
• storage-connection

Public variables and functions:

• model
• model-display-order
• peer-scheduler-event-types
• trigger-event-types
• version-deprecations

Public variables and functions:

• -read_batch
• -write_batch
• cast-types
• casts
• coerce-catalog
• coerce-flow-conditions
• coerce-lifecycles
• coerce-trigger
• coerce-windows
• coerce-workflow

Public variables and functions:

• add-task
• base-schemas
• compose-schemas
• register-job
• vschema-merge

Public variables and functions:

• already-joined?

Public variables and functions:

Public variables and functions:

• register-peer-info

Public variables and functions:

• allocations->peers
• build-stop-task-fn
• grouped-task?
• input-task?
• job->peers
• job-allocations->peer-ids
• job-peer-count
• leaf-tasks
• messenger-slot-id
• peer->allocated-job
• promote-orphans
• remove-peers
• replica->job-peers
• root-tasks
• src-peers
• start-new-lifecycle
• start-task!
• state-task?
• stop-lifecycle-peer-group!
• to-graph
• upstream-peers

Public variables and functions:

Public variables and functions:

Public variables and functions:

• abort?
• deallocated-replica

Public variables and functions:

• apply-kill-job
• enforce-flux-policy

Public variables and functions:

• deallocated-replica

Public variables and functions:

• already-joined?

Public variables and functions:

• already-joined?
• disallowed-candidates
• still-joining?

Public variables and functions:

Public variables and functions:

• job-scheduler-replica-update
• task-scheduler-replica-update

Public variables and functions:

• children
• close
• connect
• create
• create-all
• create-mode
• data
• delete
• delete-with-children
• event-to-map
• exists
• make-watcher
• set-data
• stat-to-map

Public variables and functions:

• create-log-entry

Public variables and functions:

• ->FailureDetector
• failure-detector
• map->FailureDetector
• monitor-target-group!

Public variables and functions:

• base-replica
• starting-replica

Public variables and functions:

• active-job-invariant
• all-coordinators-exist
• all-groups-invariant
• all-jobs-have-coordinator
• all-peers-are-group-indexed
• all-peers-are-reverse-group-indexed
• all-tasks-have-non-zero-peers
• allocations-invariant
• group-index-keys-never-nil
• group-index-vals-never-nil
• no-extra-coordinators
• peer-site-invariant
• short-identifiers-correct
• slot-id-invariant
• version-invariant

Public variables and functions:

• ->ZooKeeper
• await-entry!
• catalog-path
• checkpoint-path
• checkpoint-path-version
• checkpoint-task-key
• chunk-path
• clean-up-broken-connections
• clear-job-data
• clear-tenancy
• current-replica
• epoch-low-watermark-path
• epoch-path
• exception-path
• find-log-parameters
• flow-path
• global-metadata-path
• initialize-origin!
• job-config-path
• job-hash-path
• job-metadata-path
• job-name-path
• job-paths
• latest-checkpoint-path
• lifecycles-path
• log-parameters-path
• log-path
• map->ZooKeeper
• origin-path
• pad-sequential-id
• parse-task-key
• poll-znode-timeout-ms
• prefix-path
• pulse-path
• read-checkpoint-coord
• read-log-entry
• read-log-parameters
• read-origin
• receive-event
• resume-point-path
• root-path
• savepoint-path
• seek-and-put-entry!
• seek-to-new-origin!
• task-path
• tenancy-alive?
• throw-subscriber-closed
• triggers-path
• windows-path
• workflow-path
• znode
• znode-path
• zookeeper

Public variables and functions:

• -main

Public variables and functions:

• ->EmbeddedMediaDriver
• delete-aeron-directory-safe
• get-threading-model
• map->EmbeddedMediaDriver
• new-embedded-media-driver

Public variables and functions:

• ->EndpointStatus
• drained?
• fragment-limit-receiver
• initial-statuses
• new-endpoint-status
• new-peer-status
• statuses->min-epoch
• statuses->ready?

Public variables and functions:

• ->AeronMessengerPeerGroup
• cleanup
• gc-sleep-ns
• gc-state-loop
• map->AeronMessengerPeerGroup
• media-driver-healthy?

Public variables and functions:

• ->LocalDispatch
• ->Publisher
• ->RemoteDispatch
• assert-not-closed
• LocalRemoteDispatch
• map->LocalDispatch
• new-publisher
• reconcile-pub

Public variables and functions:

• ->StatusPublisher
• new-status-publisher

Public variables and functions:

• ->Subscriber
• assert-epoch-correct!
• available-image
• check-correlation-id-alignment
• counters->counter
• fragment-limit-receiver
• invalid-replica-found!
• lookup-ticket
• new-error-handler
• new-subscription
• unavailable-image

Public variables and functions:

• action->kw
• channel
• heartbeat-stream-id
• image->map
• max-aeron-message-length
• short-circuit?
• stream-id
• try-close-conn
• try-close-publication
• try-close-subscription

Public variables and functions:

• build-final-publication-info
• messenger-connections
• next-messenger-state!
• transition-messenger

Public variables and functions:

• EndpointStatus

Public variables and functions:

• assign-task-resources
• build-messenger
• build-messenger-group
• get-peer-site
• Messenger
• MessengerGroup

Public variables and functions:

• Publisher

Public variables and functions:

• PStatusPublisher

Public variables and functions:

• Subscriber

Public variables and functions:

• deserialize
• serialize

Public variables and functions:

• ->Comms
• CommsMap
• get-init-short-circuit
• get-short-circuit
• map->Comms

Public variables and functions:

• ->CustomMonitoringAgent
• map->CustomMonitoringAgent

Public variables and functions:

• emit-count
• emit-latency
• emit-latency-2
• emit-latency-value
• measure-latency

Public variables and functions:

• ->Monitoring
• ->TaskMonitoring
• cleanup-keyword
• count-written-batch
• job-metric->metric-str
• map->Monitoring
• map->TaskMonitoring
• new-lifecycle-latency
• new-monitoring
• new-read-batch
• new-task-monitoring
• new-write-batch
• normalize-tag
• update-rv-epoch
• update-timer!
• update-timer-ns!

Public variables and functions:

• ->NoOpMonitoringAgent
• map->NoOpMonitoringAgent
• no-op-monitoring-agent

Public variables and functions:

• ->LogWriter
• ->OnyxComm
• ->ReplicaSubscription
• close-outbox!
• log-writer
• map->LogWriter
• map->OnyxComm
• map->ReplicaSubscription
• onyx-comm
• outbox-loop
• replica-subscription

Public variables and functions:

• ENDPOINT_BEHIND
• initialize-epoch
• load-balance-slot-id
• NOT_READY
• UNALIGNED_SUBSCRIBER

Public variables and functions:

• ->PeerCoordinator
• barrier-period
• check-peer-timeout!
• checkpoint-complete?
• complete-job
• completed-checkpoint
• Coordinator
• coordinator-backoff-ms
• coordinator-iteration
• emit-replica
• emit-seal-barrier
• evict-peer!
• initialise-state
• input-publications
• make-task-data
• map->PeerCoordinator
• merged-statuses
• new-peer-coordinator
• next-replica
• offer-barriers
• offer-heartbeats
• periodic-barrier
• schedule-next-barrier
• shutdown
• start-coordinator!
• start-messenger
• stop-coordinator!
• write-coordinate

Public variables and functions:

• ->NullWriter
• function
• map->NullWriter
• throw-exceptions!

Public variables and functions:

• downstream-timed-out-peers
• upstream-timed-out-peers

Public variables and functions:

• check-compatible-log-versions!
• version

Public variables and functions:

• build-fn-java
• get-method-java
• instantiate-plugin-instance
• resolve-fn
• resolve-task-fn
• start-lifecycle?

Public variables and functions:

• ->PeerGroupManager
• action
• annotate-reaction
• futures-stuck-park-ms
• idle-backoff-ms
• map->PeerGroupManager
• media-driver-backoff-ms
• peer-group-error-backoff-ms
• peer-group-manager
• peer-group-manager-loop
• peers-allocated-proportion
• poll-inbox!
• remove-shutdown-futs
• safe-stop-vpeer!
• setup-group-state
• shutting-down-task-metrics
• spin-park-ms
• spin-until-tasks-shutdown
• start-communicator!
• transition-group
• transition-peers
• update-scheduler-lag!

Public variables and functions:

• ->OnyxStateStoreGroup
• add-new-db
• map->OnyxStateStoreGroup
• new-state-store-group
• process-store
• processing-loop
• remove-db
• required-event-keys
• state-key

Public variables and functions:

• coordinates->input-resume-point
• coordinates->output-resume-point
• coordinates->windows-resume-point
• read-checkpoint
• recover-input
• recover-output
• recover-windows
• resume-point->coordinates
• state-reindex
• windows-to-fetch

Public variables and functions:

• merge-statuses

Public variables and functions:

• ->MessengerOutput
• add-segment
• new-messenger-output
• try-sends

Public variables and functions:

• ->NullWriter
• map->NullWriter
• output

Public variables and functions:

• BarrierSynchronization
• Checkpointed
• Input
• Output
• Plugin
• WatermarkedInput

Public variables and functions:

• ->AbsSeqReader
• inject-lifecycle-seq
• inject-seq-via-lifecycle
• input
• map->AbsSeqReader
• reader-calls

Public variables and functions:

• PTaskStateMachine

Public variables and functions:

• ->DummyQueryServer
• map->DummyQueryServer
• query-server

Public variables and functions:

Public variables and functions:

• select-job-requiring-peer

Public variables and functions:

• reuse-spare-peers

Public variables and functions:

• ban-smaller-sites
• choose-candidates
• find-colocated-peers
• get-peer-site
• global-saturation-lower-bound
• large-enough-sites
• non-colocated-tasks
• select-peers
• site->peers

Public variables and functions:

• actual-usage
• add-allocation-versions
• add-messaging-short-ids
• anti-jitter-constraints
• assign-coordinators
• assign-task-resources
• assign-task-slot-ids
• btr-place-scheduling
• build-current-model
• build-job-and-task->node
• build-node->task
• build-peer->task
• build-peer->vm
• calculate-capacity
• capacity-constraints
• change-peer-allocations
• claim-spare-peers
• constrainted-tasks-for-peer
• deallocate-starved-jobs
• full-allocation?
• grouped-task?
• grouping-task-constraints
• input-task?
• job->planned-task-capacity
• job-claim-peers
• job-coverable?
• job-lower-bound
• job-offer-n-peers
• job-upper-bound
• messaging-long-form
• n-no-op-tasks
• n-qualified-peers
• no-tagged-peers-constraints
• peer-running-constraints
• reallocate-peers
• reconfigure-cluster-workload
• remove-job
• slot-ids
• src-peers
• task-tagged-constraints
• to-node-array
• unassign-task-slot-ids
• unconstrained-tasks
• unrolled-tasks
• update-peer-site
• update-slot-id-for-peer

Public variables and functions:

• assign-capacity-constraint?
• choose-acker
• choose-downstream-peers
• preallocated-grouped-task?
• task-constraints
• task-distribute-peer-count

Public variables and functions:

Public variables and functions:

• desired-allocation
• drop-jobs-overflow
• min-allocations
• rotate
• select-job-requiring-peer
• sort-jobs-by-pct

Public variables and functions:

• largest-remainder-allocations
• percentage-balanced-taskload
• reduce-overallocated-peers
• remove-grouping-tasks
• rescale-task-percentages
• tasks-by-pct

Public variables and functions:

• ->RestrictedKwNamespace
• add-event-schema
• add-state-event-schema
• AeronIdleStrategy
• BarrierCoordinate
• base-task-map
• build-allowed-key-ns
• Catalog
• combine-restricted-ns
• deprecated
• EnvConfig
• Epoch
• Event
• FlowAction
• FlowCondition
• FluxPolicy
• FnPath
• Function
• function-task-map
• GroupId
• grouping-task?
• information-model->schema
• InitialiseMode
• input-task-map
• InputResumeDefinition
• InputResumeMode
• java?
• Job
• JobConfig
• JobId
• JobMetadata
• JobName
• JobScheduler
• Language
• Lifecycle
• LifecycleCall
• LifecycleState
• LogEntry
• lookup-schema
• map->RestrictedKwNamespace
• Messaging
• NamespacedKeyword
• NonNamespacedKeyword
• output-task-map
• OutputResumeDefinition
• OutputResumeMode
• partial-clojure-fn-task
• partial-clojure-plugin
• partial-fn-task
• partial-grouping-task
• partial-input-task
• partial-java-fn-task
• partial-java-plugin
• partial-output-task
• partial-reduce-task
• PartialJob
• PartialWorkflow
• PeerClientConfig
• PeerConfig
• PeerId
• PeerSchedulerEvent
• PeerSite
• PeerZKClientConfig
• PosInt
• Reactions
• reduce-task-map
• RefinementCall
• Replica
• ReplicaDiff
• ReplicaVersion
• restricted-ns
• ResumeCoordinate
• ResumePoint
• schema-name->schema
• SegmentKey
• SlotId
• SlotMigration
• SpecialFlowTasks
• SPosInt
• State
• StateAggregationCall
• StateEvent
• StateFilterImpl
• StateLogImpl
• Storage
• TaskId
• TaskMap
• TaskName
• TaskScheduler
• TenancyId
• TenancyIdStr
• Trigger
• TriggerCall
• TriggerDelay
• TriggerDelayElements
• TriggerEvent
• TriggerEventType
• TriggerId
• TriggerPeriod
• TriggerPeriodElements
• TriggerRefinement
• TriggerState
• TriggerThreshold
• TriggerThresholdElements
• type->schema
• UniqueTaskMap
• Unit
• UnsupportedFlowKey
• UnsupportedTriggerKey
• UnsupportedWindowKey
• valid-min-peers-max-peers-n-peers?
• Window
• WindowBase
• WindowExtension
• WindowId
• WindowResumeDefinition
• WindowResumeMode
• WindowState
• WindowType
• Workflow

Public variables and functions:

• model

Public variables and functions:

• ->StateBackend
• db-empty?
• get-state-idx
• items
• read-txn
• seek-items
• set-state-idx
• stat

Public variables and functions:

• read-open-checkpoint-db

Public variables and functions:

• create-db
• open-db-reader
• State

Public variables and functions:

• ->StateCheckpointDecoder
• ->StateCheckpointEncoder
• current-schema-version
• empty-checkpoint-encoder
• new-decoder
• SDecoder
• SEncoder

Public variables and functions:

• ->GroupDecoder
• get-group-id
• PDecoder

Public variables and functions:

• ->GroupEncoder
• group-id->bytes
• PEncoder

Public variables and functions:

• ->GroupReverseDecoder
• PDecoder

Public variables and functions:

• ->GroupReverseEncoder
• PEncoder

Public variables and functions:

• ->GroupedEntryDecoder
• ->GroupedGlobalEntryDecoder
• ->UngroupedEntryDecoder
• ->UngroupedGlobalEntryDecoder
• PDecoder

Public variables and functions:

• ->GroupedEntryEncoder
• ->GroupedGlobalEntryEncoder
• ->UngroupedEntryEncoder
• ->UngroupedGlobalEntryEncoder
• PEncoder

Public variables and functions:

• build-coders
• equals
• event->state-serializers
• get-trigger-coder
• get-window-coder
• instantiate
• max-window-key-size-bytes
• state-serializers

Public variables and functions:

• arg-or-default
• default-vals

Public variables and functions:

• app
• path-seq
• PathSeq

Public variables and functions:

• create-task
• discover-tasks
• find-task
• gen-task-ids
• grouping-task?
• max-depth
• only
• remove-dupes
• to-dependency-graph
• workflow-depth

Public variables and functions:

• swap-pair!

Public variables and functions:

• deserializable-exception
• exception?
• index-of
• kw->fn
• ms->ns
• now
• ns->ms

Public variables and functions:

• random-uuid

Public variables and functions:

• ->CheckpointManager
• accelerate-client
• checkpoint-task-key
• list-keys
• map->CheckpointManager
• max-read-checkpoint-retries
• new-client
• read-checkpointed-bytes
• s3-object-input-stream
• set-endpoint
• set-region
• transfer-manager
• upload
• upload-synchronous

Public variables and functions:

• ->OnyxClient
• ->OnyxDevelopmentEnv
• ->OnyxPeer
• ->OnyxPeerGroup
• ->OnyxTask
• client-components
• development-components
• map->OnyxClient
• map->OnyxDevelopmentEnv
• map->OnyxPeer
• map->OnyxPeerGroup
• map->OnyxTask
• onyx-client
• onyx-development-env
• onyx-peer-group
• onyx-task
• onyx-vpeer-system
• peer-components
• peer-group-components
• rethrow-component
• task-components

Public variables and functions:

• default-channel-size
• input
• output

Public variables and functions:

• function

Public variables and functions:

• output

Public variables and functions:

• close-reader
• in-file-calls
• inject-in-reader
• input-file
• input-materialized
• input-serialized

Public variables and functions:

• ->TestPeers
• add-test-env-peers!
• feedback-exception!
• find-task
• get-counts
• job->min-peers-per-task
• job-allocation-counts
• load-config
• map->TestPeers
• playback-log
• shutdown-env
• shutdown-peer
• shutdown-peer-group
• try-start-env
• try-start-group
• try-start-peers
• validate-enough-peers!
• with-components
• with-test-env

Public variables and functions:

• exceeds-percentile-watermark?
• exceeds-watermark?
• next-fire-time
• percentile-watermark
• percentile-watermark-fire?
• punctuation
• punctuation-fire?
• punctuation-init-locals
• punctuation-init-state
• punctuation-next-state
• segment
• segment-fire?
• segment-init-state
• segment-next-state
• timer
• timer-fire?
• timer-init-state
• timer-next-state
• watermark
• watermark-fire?
• watermark-init-locals

Public variables and functions:

• ->Link
• ->MonitorEvent
• ->MonitorEventBytes
• ->MonitorEventLatency
• ->MonitorEventLatencyBytes
• ->MonitorTaskEventCount
• ->Result
• ->Route
• ->StateEvent
• ->TriggerState
• barrier
• barrier-id
• checkpointed-state-event
• heartbeat
• heartbeat-id
• map->Link
• map->MonitorEvent
• map->MonitorEventBytes
• map->MonitorEventLatency
• map->MonitorEventLatencyBytes
• map->MonitorTaskEventCount
• map->Result
• map->Route
• map->StateEvent
• map->TriggerState
• max-control-message-size
• message
• message-id
• new-state-event
• ready
• ready-id
• ready-reply
• ready-reply-id

Public variables and functions:

• average
• average-aggregation-apply-fn
• average-aggregation-create-fn
• average-aggregation-fn-init
• average-super-aggregation
• collect-by-key
• collect-by-key-aggregation-apply-log
• collect-by-key-aggregation-fn
• collect-by-key-aggregation-fn-init
• collect-by-key-super-aggregation
• collect-key-value
• collect-key-value-aggregation-apply-log
• collect-key-value-aggregation-fn
• collect-key-value-aggregation-fn-init
• collect-key-value-super-aggregation
• conj
• conj-aggregation-apply-log
• conj-aggregation-fn
• conj-aggregation-fn-init
• conj-super-aggregation
• count
• count-aggregation-apply-fn
• count-aggregation-create-state-update
• count-aggregation-fn-init
• count-super-aggregation
• max
• max-aggregation-fn
• max-create-aggregation-apply-fn
• max-super-aggregation
• min
• min-aggregation-apply-fn
• min-aggregation-create-fn
• min-super-aggregation
• set-value-aggregation-apply-log
• sum
• sum-aggregation-fn-init
• sum-aggregation-function
• sum-create-state-update-fn
• sum-super-aggregation

Public variables and functions:

• ICoerceKey
• standard-units-for
• to-standard-units

Public variables and functions:

• ->FixedWindow
• ->GlobalWindow
• ->SessionWindow
• ->SlidingWindow
• bounding-extents
• extent-serializer
• IWindow
• map->FixedWindow
• map->GlobalWindow
• map->SessionWindow
• map->SlidingWindow
• ordered-log?
• window-id-impl-extents
• windowing-builder