Packages

c

io.dataos.spark.readers.mongo

MongoDbInput

case class MongoDbInput(name: String, nodes: List[String], subprotocol: String, database: String, table: String, username: String, password: String, queryParams: Option[String], options: Option[Map[String, String]], incremental: Option[Incremental]) extends IncrementalReader with DatasourceReader with Product with Serializable

Represents a MongoDB input configuration for data retrieval.

name

The name of the MongoDB input.

nodes

A list of MongoDB nodes/hosts to connect to.

subprotocol

The subprotocol for MongoDB connection (e.g., "mongodb" or "mongodb+srv").

database

The name of the MongoDB database to read from.

table

The name of the MongoDB collection (table) to read from.

username

The username for authentication (if required).

password

The password for authentication (if required).

queryParams

An optional string containing query parameters to append to the URL.

options

An optional map of additional options for the MongoDB input.

incremental

An optional incremental configuration for data processing.

Linear Supertypes
Serializable, Serializable, Product, Equals, DatasourceReader, Reader, IncrementalReader, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MongoDbInput
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. DatasourceReader
  7. Reader
  8. IncrementalReader
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new MongoDbInput(name: String, nodes: List[String], subprotocol: String, database: String, table: String, username: String, password: String, queryParams: Option[String], options: Option[Map[String, String]], incremental: Option[Incremental])

    name

    The name of the MongoDB input.

    nodes

    A list of MongoDB nodes/hosts to connect to.

    subprotocol

    The subprotocol for MongoDB connection (e.g., "mongodb" or "mongodb+srv").

    database

    The name of the MongoDB database to read from.

    table

    The name of the MongoDB collection (table) to read from.

    username

    The username for authentication (if required).

    password

    The password for authentication (if required).

    queryParams

    An optional string containing query parameters to append to the URL.

    options

    An optional map of additional options for the MongoDB input.

    incremental

    An optional incremental configuration for data processing.

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. val database: String
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. val incremental: Option[Incremental]
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. val name: String

    The name of the data reader.

    The name of the data reader.

    Definition Classes
    MongoDbInput → Reader
  13. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. val nodes: List[String]
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. val options: Option[Map[String, String]]
  18. val password: String
  19. def persistIncrementalState(): Unit

    Persists the incremental state if any.

    Persists the incremental state if any.

    Definition Classes
    IncrementalReader
  20. val queryParams: Option[String]
  21. def read(sparkSession: SparkSession): DataFrame

    Reads data and returns it as a DataFrame using the provided SparkSession.

    Reads data and returns it as a DataFrame using the provided SparkSession.

    sparkSession

    The SparkSession to use for reading data.

    returns

    A DataFrame containing the data read by the reader.

    Definition Classes
    MongoDbInput → Reader
  22. def readIncremental(df: DataFrame, incremental: Option[Incremental]): DataFrame

    Reads data from a DataFrame with optional incremental settings.

    Reads data from a DataFrame with optional incremental settings.

    df

    The DataFrame to read data from.

    incremental

    Optional Incremental settings to apply.

    returns

    A new DataFrame after applying incremental settings if provided, otherwise the original DataFrame.

    Definition Classes
    IncrementalReader
  23. val subprotocol: String
  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. val table: String
  26. val username: String
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from DatasourceReader

Inherited from Reader

Inherited from IncrementalReader

Inherited from AnyRef

Inherited from Any

Ungrouped