Packages

c

io.delta.flink.source.internal.builder

DeltaSourceBuilderBase

abstract class DeltaSourceBuilderBase[T, SELF] extends AnyRef

The base class for io.delta.flink.source.DeltaSource builder.

This builder carries a SELF type to make it convenient to extend this for subclasses, using the following pattern.


public class SubBuilder extends DeltaSourceBuilderBase> {
    ...

}

That way, all return values from builder method defined here are typed to the sub-class type and support fluent chaining.

We don't make the publicly visible builder generic with a SELF type, because it leads to generic signatures that can look complicated and confusing.

Linear Supertypes
AnyRef, Any
Known Subclasses
RowDataBoundedDeltaSourceBuilder, RowDataContinuousDeltaSourceBuilder, BoundedDeltaSourceBuilder, ContinuousDeltaSourceBuilder
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DeltaSourceBuilderBase
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new DeltaSourceBuilderBase(tablePath: Path, hadoopConfiguration: Configuration, snapshotSupplierFactory: SnapshotSupplierFactory)

    Attributes
    protected[builder]

Abstract Value Members

  1. abstract def build[V <: DeltaSource[T]](): V
  2. abstract def getApplicableOptions(): Collection[String]
    Attributes
    protected[builder]
  3. abstract def validateOptionExclusions(): Validator

    This method should implement any logic for validation of mutually exclusive options.

    This method should implement any logic for validation of mutually exclusive options.

    returns

    Validator instance with validation error message.

    Attributes
    protected[builder]

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def columnNames(columnNames: List[String]): SELF

    Sets a List of column names that should be read from Delta table.

  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. def getSourceConfiguration(): DeltaConnectorConfiguration

    returns

    A copy of DeltaConnectorConfiguration used by builder. The changes made on returned copy do not change the state of builder's configuration.

  12. def getSourceSchema(): SourceSchema

    Extracts Delta table schema from DeltaLog io.delta.standalone.actions.Metadata including column names and column types converted to org.apache.flink.table.types.logical.LogicalType.

    Extracts Delta table schema from DeltaLog io.delta.standalone.actions.Metadata including column names and column types converted to org.apache.flink.table.types.logical.LogicalType.

    If #userColumnNames were defined, only those columns will be included in extracted schema.

    returns

    A SourceSchema including Delta table column names with their types that should be read from Delta table.

    Attributes
    protected[builder]
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. def option(optionName: String, optionValue: Long): SELF

    Sets a configuration option.

  19. def option(optionName: String, optionValue: Int): SELF

    Sets a configuration option.

  20. def option(optionName: String, optionValue: Boolean): SELF

    Sets a configuration option.

  21. def option(optionName: String, optionValue: String): SELF

    Sets a configuration option.

  22. def prepareInapplicableOptionMessage(usedOptions: Collection[String], applicableOptions: Collection[String]): String
    Attributes
    protected[builder]
  23. def prepareOptionExclusionMessage(mutualExclusiveOptions: <repeated...>[String]): String
    Attributes
    protected[builder]
  24. def self(): SELF
    Attributes
    protected[builder]
    Annotations
    @SuppressWarnings()
  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. def validate(): Unit

    Validate definition of Delta source builder including mandatory and optional options.

    Validate definition of Delta source builder including mandatory and optional options.

    Attributes
    protected[builder]
  28. def validateInapplicableOptions(): Validator

    Validated builder options that were used but they might be not applicable for given builder type, for example using options from bounded mode like "versionAsOf" for continuous mode builder.

    Validated builder options that were used but they might be not applicable for given builder type, for example using options from bounded mode like "versionAsOf" for continuous mode builder.

    returns

    The Validator object with all (if any) validation error messages.

    Attributes
    protected[builder]
  29. def validateMandatoryOptions(): Validator
    Attributes
    protected[builder]
  30. def validateOptionalParameters(): Validator
    Attributes
    protected[builder]
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped