Class/Object

com.coxautodata.waimak.dataflow.spark

SparkDataFlow

Related Docs: object SparkDataFlow | package spark

Permalink

class SparkDataFlow extends DataFlow with Logging

Introduces spark session into the data flows

Linear Supertypes
DataFlow, Logging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SparkDataFlow
  2. DataFlow
  3. Logging
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SparkDataFlow(info: SparkDataFlowInfo)

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def actions(acs: Seq[DataFlowAction]): SparkDataFlow.this.type

    Permalink
    Definition Classes
    SparkDataFlowDataFlow
  5. def actions: Seq[DataFlowAction]

    Permalink

    Actions to execute, these will be scheduled when inputs become available.

    Actions to execute, these will be scheduled when inputs become available. Executed actions must be removed from the sate.

    Definition Classes
    SparkDataFlowDataFlow
  6. def addAction[A <: DataFlowAction](action: A): SparkDataFlow.this.type

    Permalink

    Creates new state of the dataflow by adding an action to it.

    Creates new state of the dataflow by adding an action to it.

    action

    - action to add

    returns

    - new state with action

    Definition Classes
    DataFlow
    Exceptions thrown

    DataFlowException when: 1) at least one of the input labels is not present in the inputs 2) at least one of the input labels is not present in the outputs of existing actions

  7. def addInput(label: String, value: Option[Any]): SparkDataFlow.this.type

    Permalink

    Creates new state of the dataflow by adding an input.

    Creates new state of the dataflow by adding an input. Duplicate labels are handled in prepareForExecution()

    label

    - name of the input

    value

    - values of the input

    returns

    - new state with the input

    Definition Classes
    DataFlow
  8. def addInterceptor(interceptor: InterceptorAction, guidToIntercept: String): SparkDataFlow.this.type

    Permalink

    Creates new state of the data flow by replacing the action that is intercepted with action that intercepts it.

    Creates new state of the data flow by replacing the action that is intercepted with action that intercepts it. The action to replace will differ from the intercepted action in the InterceptorAction in the case of replacing an existing InterceptorAction

    Definition Classes
    DataFlow
  9. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  10. def buildCommits(): SparkDataFlow.this.type

    Permalink

    During data flow preparation for execution stage, it interacts with data committer to add actions that implement stages of the data committer.

    During data flow preparation for execution stage, it interacts with data committer to add actions that implement stages of the data committer.

    This build uses tags to separate the stages of the data committer: cache, move, finish.

    Attributes
    protected[com.coxautodata.waimak.dataflow]
    Definition Classes
    DataFlow
  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def commit(commitName: String, partitions: Seq[String] = Seq.empty, repartition: Boolean = true, cacheLabels: Boolean = true)(labels: String*): SparkDataFlow.this.type

    Permalink

    Groups labels to commit under a commit name.

    Groups labels to commit under a commit name. Can be called multiple times with same same commit name, thus adding labels to it. There can be multiple commit names defined in a single data flow.

    commitName

    name of the commit, which will be used to define its push implementation

    partitions

    list of partition columns for the labels specified in this commit invocation. It will not impact labels from previous or following invocations of the commit with same commit name.

    repartition

    to repartition the data

    cacheLabels

    request the committer to cache the underlying labels on the flow before writing them out if caching is supported by the data committer. If caching is not supported this parameter is ignored.

    labels

    labels added to the commit name with partitions config

    Definition Classes
    DataFlow
  13. def commitMeta(cm: CommitMeta): SparkDataFlow.this.type

    Permalink
    Definition Classes
    SparkDataFlowDataFlow
  14. def commitMeta: CommitMeta

    Permalink
    Definition Classes
    SparkDataFlowDataFlow
  15. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  17. def executed(executed: DataFlowAction, outputs: Seq[Option[Any]]): SparkDataFlow.this.type

    Permalink

    Creates new state of the dataflow by removing executed action from the actions list and adds its outputs to the inputs.

    Creates new state of the dataflow by removing executed action from the actions list and adds its outputs to the inputs.

    executed

    - executed actions

    outputs

    - outputs of the executed action

    returns

    - next stage data flow without the executed action, but with its outpus as inputs

    Definition Classes
    SparkDataFlowDataFlow
    Exceptions thrown

    DataFlowException if number of provided outputs is not equal to the number of output labels of the action

  18. def executionPool(executionPoolName: String)(nestedFlow: (SparkDataFlow.this.type) ⇒ SparkDataFlow.this.type): SparkDataFlow.this.type

    Permalink

    Creates a code block with all actions inside of it being run on the specified execution pool.

    Creates a code block with all actions inside of it being run on the specified execution pool. Same execution pool name can be used multiple times and nested pools are allowed, the name closest to the action will be assigned to it.

    Ex: flow.executionPool("pool_1") { _.addAction(a1) .addAction(a2) .executionPool("pool_2") { _.addAction(a3) .addAction(a4) }..addAction(a5) }

    So actions a1, a2, a5 will be in the pool_1 and actions a3, a4 in the pool_2

    executionPoolName

    pool name to assign to all actions inside of it, but it can be overwritten by the nested execution pools.

    Definition Classes
    DataFlow
  19. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. val flowContext: SparkFlowContext

    Permalink
    Definition Classes
    SparkDataFlowDataFlow
  21. def getActionByGuid(actionGuid: String): DataFlowAction

    Permalink

    Guids are unique, find action by guid

    Guids are unique, find action by guid

    Definition Classes
    DataFlow
  22. def getActionByOutputLabel(outputLabel: String): DataFlowAction

    Permalink

    Output labels are unique.

    Output labels are unique. Finds action that produces outputLabel.

    Definition Classes
    DataFlow
  23. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  24. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  25. def inputs(inp: DataFlowEntities): SparkDataFlow.this.type

    Permalink
    Definition Classes
    SparkDataFlowDataFlow
  26. def inputs: DataFlowEntities

    Permalink

    Inputs that were explicitly set or produced by previous actions, these are inputs for all following actions.

    Inputs that were explicitly set or produced by previous actions, these are inputs for all following actions. Inputs are preserved in the data flow state, even if they are no longer required by the remaining actions. //TODO: explore the option of removing the inputs that are no longer required by remaining actions!!!

    Definition Classes
    SparkDataFlowDataFlow
  27. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  28. def isTraceEnabled(): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  29. def isValidFlowDAG: Try[SparkDataFlow.this.type]

    Permalink

    Flow DAG is valid iff: 1.

    Flow DAG is valid iff: 1. All output labels and existing input labels unique 2. Each action depends on labels that are produced by actions or already present in inputs 3. Active tags is empty 4. Active dependencies is zero 5. No cyclic dependencies in labels 6. No cyclic dependencies in tags 7. No cyclic dependencies in label tag combination

    Definition Classes
    DataFlow
  30. def logDebug(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  31. def logDebug(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  32. def logError(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  33. def logError(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  34. def logInfo(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  35. def logInfo(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  36. def logName: String

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  37. def logTrace(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  38. def logTrace(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  39. def logWarning(msg: ⇒ String, throwable: Throwable): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  40. def logWarning(msg: ⇒ String): Unit

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  41. def map[R >: SparkDataFlow.this.type](f: (SparkDataFlow.this.type) ⇒ R): R

    Permalink

    Transforms the current dataflow by applying a function to it.

    Transforms the current dataflow by applying a function to it.

    f

    A function that transforms a dataflow object

    returns

    New dataflow

    Definition Classes
    DataFlow
  42. def mapOption[R >: SparkDataFlow.this.type](f: (SparkDataFlow.this.type) ⇒ Option[R]): R

    Permalink

    Optionally transform a dataflow depending on the output of the applying function.

    Optionally transform a dataflow depending on the output of the applying function. If the transforming function returns a None then the original dataflow is returned.

    f

    A function that returns an Option[DataFlow]

    returns

    DataFlow object that may have been transformed

    Definition Classes
    DataFlow
  43. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  44. def nextRunnable(executionPoolsAvailable: Set[String]): Seq[DataFlowAction]

    Permalink

    Returns actions that are ready to run: 1.

    Returns actions that are ready to run: 1. have no input labels; 2. whose inputs have been created 3. all actions whose dependent tags have been run 4. belong to the available pool

    will not include actions that are skipped.

    executionPoolsAvailable

    set of execution pool for which to schedule actions

    Definition Classes
    DataFlow
  45. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  46. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  47. def prepareForExecution(): Try[SparkDataFlow.this.type]

    Permalink

    A function called just before the flow is executed.

    A function called just before the flow is executed. By default, this function has just checks the tagging state of the flow, and could be overloaded to have implementation specific preparation steps. An overloaded function should call this function first. It would be responsible for preparing an execution environment such as cleaning temporary directories.

    Definition Classes
    SparkDataFlowDataFlow
  48. def push(commitName: String)(committer: DataCommitter): SparkDataFlow.this.type

    Permalink

    Associates commit name with an implementation of a data committer.

    Associates commit name with an implementation of a data committer. There must be only one data committer per one commit name.

    Definition Classes
    DataFlow
  49. def schedulingMeta(sc: SchedulingMeta): SparkDataFlow.this.type

    Permalink
    Definition Classes
    SparkDataFlowDataFlow
  50. def schedulingMeta: SchedulingMeta

    Permalink
    Definition Classes
    SparkDataFlowDataFlow
  51. def schedulingMeta(mutateState: (SchedulingMetaState) ⇒ SchedulingMetaState)(nestedFlow: (SparkDataFlow.this.type) ⇒ SparkDataFlow.this.type): SparkDataFlow.this.type

    Permalink

    Generic method that can be used to add context and state to all actions inside the block.

    Generic method that can be used to add context and state to all actions inside the block.

    mutateState

    function that adds attributes to the state

    nestedFlow

    all actions inside of this flow will be associated with the mutated state

    Definition Classes
    DataFlow
  52. def spark: SparkSession

    Permalink
  53. def sqlTables: Set[String]

    Permalink

    Execution of the flow is lazy, but registration of the datasets as sql tables can only happen when data set is created.

    Execution of the flow is lazy, but registration of the datasets as sql tables can only happen when data set is created. With multiple threads consuming same table, registration of the data set as an sql table needs to happen in synchronised code.

    Labels that need to be registered as temp spark views before the execution starts. This is necessary if they are to be reused by multiple parallel threads.

  54. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  55. def tag[S <: DataFlow](tags: String*)(taggedFlow: (SparkDataFlow.this.type) ⇒ S): SparkDataFlow.this.type

    Permalink

    Tag all actions added during the taggedFlow lambda function with any given number of tags.

    Tag all actions added during the taggedFlow lambda function with any given number of tags. These tags can then be used by the tagDependency() action to create a dependency in the running order of actions by tag.

    tags

    Tags to apply to added actions

    taggedFlow

    An intermediate flow that actions can be added to that will be be marked with the tag

    Definition Classes
    DataFlow
  56. def tagDependency[S <: DataFlow](depTags: String*)(tagDependentFlow: (SparkDataFlow.this.type) ⇒ S): SparkDataFlow.this.type

    Permalink

    Mark all actions added during the tagDependentFlow lambda function as having a dependency on the tags provided.

    Mark all actions added during the tagDependentFlow lambda function as having a dependency on the tags provided. These actions will only be run once all tagged actions have finished.

    depTags

    Tags to create a dependency on

    tagDependentFlow

    An intermediate flow that actions can be added to that will depended on tagged actions to have completed before running

    Definition Classes
    DataFlow
  57. def tagState(ts: DataFlowTagState): SparkDataFlow.this.type

    Permalink
    Definition Classes
    SparkDataFlowDataFlow
  58. def tagState: DataFlowTagState

    Permalink
    Definition Classes
    SparkDataFlowDataFlow
  59. def tempFolder: Option[Path]

    Permalink

    Folder into which the temp data will be saved before commit into the output storage: folders, RDBMs, Key Value tables.

  60. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  61. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  63. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from DataFlow

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped