Class/Object

ksb.csle.component.reader

MongodbReader

Related Docs: object MongodbReader | package reader

Permalink

class MongodbReader extends BaseReader[DataFrame, BatchReaderInfo, SparkSession]

:: ApplicationDeveloperApi ::

Reader that loads records from MongoDB.

Linear Supertypes
BaseReader[DataFrame, BatchReaderInfo, SparkSession], BaseDoer, Logging, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MongodbReader
  2. BaseReader
  3. BaseDoer
  4. Logging
  5. Serializable
  6. Serializable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MongodbReader(o: BatchReaderInfo)

    Permalink

    o

    Object that contains message ksb.csle.common.proto.DatasourceProto.MongodbInfo MongodbInfo contains attributes as follows:

    • serverAddress: MongoDB address (e.g. 192.168.0.3:27017) (required)
    • dbName: Database name to access (required)
    • collectionName: Collection name to access (required)
    • userName: User name if requires authentication (optional)
    • password: Password if requires authentication (optional)
    • cleaningDataInconsistency: Clean the record if has inconsistent data (optional)
    • field: Schema of input record (optional)

    MongodbInfo

    message MongodbInfo {
      required string serverAddress = 1;
      required string dbName = 2;
      required string collectionName = 3;
      optional string userName = 4;
      optional string password = 5;
      optional bool cleaningDataInconsistency = 6;
      repeated FieldInfo field = 7;
    }

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. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def close: Unit

    Permalink

    Close the connection with MongoDB.

    Close the connection with MongoDB.

    Definition Classes
    MongodbReader → BaseReader
    Annotations
    @throws( classOf[Exception] )
  7. final def eq(arg0: AnyRef): Boolean

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

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. final def getClass(): Class[_]

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

    Permalink
    Definition Classes
    AnyRef → Any
  12. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  13. val logger: Logger

    Permalink
    Attributes
    protected
    Definition Classes
    Logging
  14. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  15. final def notify(): Unit

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

    Permalink
    Definition Classes
    AnyRef
  17. val o: BatchReaderInfo

    Permalink

    Object that contains message ksb.csle.common.proto.DatasourceProto.MongodbInfo MongodbInfo contains attributes as follows:

    Object that contains message ksb.csle.common.proto.DatasourceProto.MongodbInfo MongodbInfo contains attributes as follows:

    • serverAddress: MongoDB address (e.g. 192.168.0.3:27017) (required)
    • dbName: Database name to access (required)
    • collectionName: Collection name to access (required)
    • userName: User name if requires authentication (optional)
    • password: Password if requires authentication (optional)
    • cleaningDataInconsistency: Clean the record if has inconsistent data (optional)
    • field: Schema of input record (optional)

    MongodbInfo

    message MongodbInfo {
      required string serverAddress = 1;
      required string dbName = 2;
      required string collectionName = 3;
      optional string userName = 4;
      optional string password = 5;
      optional bool cleaningDataInconsistency = 6;
      repeated FieldInfo field = 7;
    }
  18. def read(session: SparkSession): Dataset[Row]

    Permalink

    Load records in as DataFrame from MongoDB.

    Load records in as DataFrame from MongoDB.

    session

    Spark session

    returns

    DataFrame DataFrame read from MongoDB

    Definition Classes
    MongodbReader → BaseReader
    Annotations
    @throws( classOf[Exception] )
  19. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  20. def toString(): String

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

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

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

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

Inherited from BaseReader[DataFrame, BatchReaderInfo, SparkSession]

Inherited from BaseDoer

Inherited from Logging

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped