Object/Class

com.mongodb.spark.config

WriteConfig

Related Docs: class WriteConfig | package config

Permalink

object WriteConfig extends MongoOutputConfig

The WriteConfig companion object

Since

1.0

Linear Supertypes
MongoOutputConfig, MongoCompanionConfig, Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WriteConfig
  2. MongoOutputConfig
  3. MongoCompanionConfig
  4. Serializable
  5. Serializable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. type Self = WriteConfig

    Permalink

    The type of the MongoConfig

    The type of the MongoConfig

    Definition Classes
    WriteConfigMongoCompanionConfig

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 apply(options: Map[String, String], default: Option[WriteConfig]): WriteConfig

    Permalink

    Create a configuration from the values in the Map, using the optional default configuration for any default values.

    Create a configuration from the values in the Map, using the optional default configuration for any default values.

    Note: Values in the map do not need to be prefixed with the configPrefix.

    options

    a map of properties and their string values

    default

    the optional default configuration, used for determining the default values for the properties

    returns

    the configuration

    Definition Classes
    WriteConfigMongoCompanionConfig
  5. def apply(databaseName: String, collectionName: String, connectionString: Option[String], replaceDocument: Boolean, maxBatchSize: Int, localThreshold: Int, writeConcern: WriteConcern): WriteConfig

    Permalink

    Creates a WriteConfig

    Creates a WriteConfig

    databaseName

    the database name

    collectionName

    the collection name

    connectionString

    the optional connection string used in the creation of this configuration

    replaceDocument

    replaces the whole document, when saving a Dataset that contains an _id field. If false only updates / sets the fields declared in the Dataset.

    maxBatchSize

    the maxBatchSize when performing a bulk update/insert. Defaults to 512.

    localThreshold

    the local threshold in milliseconds used when choosing among multiple MongoDB servers to send a request. Only servers whose ping time is less than or equal to the server with the fastest ping time plus the local threshold will be chosen.

    writeConcern

    the WriteConcern to use

    returns

    the write config

    Since

    2.1

  6. def apply(databaseName: String, collectionName: String, connectionString: Option[String], replaceDocument: Boolean, localThreshold: Int, writeConcern: WriteConcern): WriteConfig

    Permalink

    Creates a WriteConfig

    Creates a WriteConfig

    databaseName

    the database name

    collectionName

    the collection name

    connectionString

    the optional connection string used in the creation of this configuration

    replaceDocument

    replaces the whole document, when saving a Dataset that contains an _id field. If false only updates / sets the fields declared in the Dataset.

    localThreshold

    the local threshold in milliseconds used when choosing among multiple MongoDB servers to send a request. Only servers whose ping time is less than or equal to the server with the fastest ping time plus the local threshold will be chosen.

    writeConcern

    the WriteConcern to use

    returns

    the write config

    Since

    2.1

  7. def apply(databaseName: String, collectionName: String, connectionString: Option[String], localThreshold: Int, writeConcern: WriteConcern): WriteConfig

    Permalink

    Creates a WriteConfig

    Creates a WriteConfig

    databaseName

    the database name

    collectionName

    the collection name

    connectionString

    the optional connection string used in the creation of this configuration

    localThreshold

    the local threshold in milliseconds used when choosing among multiple MongoDB servers to send a request. Only servers whose ping time is less than or equal to the server with the fastest ping time plus the local threshold will be chosen.

    writeConcern

    the WriteConcern to use

    returns

    the write config

    Since

    2.1

  8. def apply(databaseName: String, collectionName: String, connectionString: String, localThreshold: Int, writeConcern: WriteConcern): WriteConfig

    Permalink

    Creates a WriteConfig

    Creates a WriteConfig

    databaseName

    the database name

    collectionName

    the collection name

    connectionString

    the connection string used in the creation of this configuration

    localThreshold

    the local threshold in milliseconds used when choosing among multiple MongoDB servers to send a request. Only servers whose ping time is less than or equal to the server with the fastest ping time plus the local threshold will be chosen.

    writeConcern

    the WriteConcern to use

    returns

    the write config

  9. def apply(databaseName: String, collectionName: String, localThreshold: Int, writeConcern: WriteConcern): WriteConfig

    Permalink

    Creates a WriteConfig

    Creates a WriteConfig

    databaseName

    the database name

    collectionName

    the collection name

    localThreshold

    the local threshold in milliseconds used when choosing among multiple MongoDB servers to send a request. Only servers whose ping time is less than or equal to the server with the fastest ping time plus the local threshold will be chosen.

    writeConcern

    the WriteConcern to use

    returns

    the write config

  10. def apply(options: Map[String, String]): Self

    Permalink

    Create a configuration from the values in the Map

    Create a configuration from the values in the Map

    Note: Values in the map do not need to be prefixed with the configPrefix.

    options

    a map of properties and their string values

    returns

    the configuration

    Definition Classes
    MongoCompanionConfig
  11. def apply(sparkConf: SparkConf, options: Map[String, String]): Self

    Permalink

    Create a configuration from the sparkConf

    Create a configuration from the sparkConf

    Uses the prefixed properties that are set in the Spark configuration to create the config.

    sparkConf

    the spark configuration

    options

    overloaded parameters

    returns

    the configuration

    Definition Classes
    MongoCompanionConfig
    See also

    configPrefix

  12. def apply(sparkConf: SparkConf): Self

    Permalink

    Create a configuration from the sparkConf

    Create a configuration from the sparkConf

    Uses the prefixed properties that are set in the Spark configuration to create the config.

    sparkConf

    the spark configuration

    returns

    the configuration

    Definition Classes
    MongoCompanionConfig
    See also

    configPrefix

  13. def apply(sparkSession: SparkSession): Self

    Permalink

    Create a configuration from the sqlContext

    Create a configuration from the sqlContext

    Uses the prefixed properties that are set in the Spark configuration to create the config.

    sparkSession

    the SparkSession

    returns

    the configuration

    Definition Classes
    MongoCompanionConfig
    See also

    configPrefix

  14. def apply(sparkContext: SparkContext): Self

    Permalink

    Create a configuration from the sparkContext

    Create a configuration from the sparkContext

    Uses the prefixed properties that are set in the Spark configuration to create the config.

    sparkContext

    the spark context

    returns

    the configuration

    Definition Classes
    MongoCompanionConfig
    See also

    configPrefix

  15. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. def collectionName(collectionNameProperty: String, options: Map[String, String], default: Option[String] = None): String

    Permalink
    Attributes
    protected
    Definition Classes
    MongoCompanionConfig
  18. val collectionNameProperty: String

    Permalink

    The collection name property

    The collection name property

    Definition Classes
    MongoOutputConfig
  19. val configPrefix: String

    Permalink

    The configuration prefix string for the current configuration scope

    The configuration prefix string for the current configuration scope

    Definition Classes
    MongoOutputConfigMongoCompanionConfig
  20. def connectionString(options: Map[String, String]): ConnectionString

    Permalink
    Attributes
    protected
    Definition Classes
    MongoCompanionConfig
  21. def create(sparkSession: SparkSession): WriteConfig

    Permalink

    Create a configuration easily from the Java API using the JavaSparkContext

    Create a configuration easily from the Java API using the JavaSparkContext

    Uses the prefixed properties that are set in the Spark configuration to create the config.

    sparkSession

    the SparkSession

    returns

    the configuration

    Definition Classes
    WriteConfigMongoCompanionConfig
    See also

    configPrefix

  22. def create(sqlContext: SQLContext): WriteConfig

    Permalink

    Create a configuration easily from the Java API using the JavaSparkContext

    Create a configuration easily from the Java API using the JavaSparkContext

    Uses the prefixed properties that are set in the Spark configuration to create the config.

    sqlContext

    the SQL context

    returns

    the configuration

    Definition Classes
    WriteConfigMongoCompanionConfig
    See also

    configPrefix

  23. def create(sparkConf: SparkConf, options: Map[String, String]): WriteConfig

    Permalink

    Create a configuration from the sparkConf

    Create a configuration from the sparkConf

    Uses the prefixed properties that are set in the Spark configuration to create the config.

    sparkConf

    the spark configuration

    options

    overloaded parameters

    returns

    the configuration

    Definition Classes
    WriteConfigMongoCompanionConfig
    See also

    configPrefix

  24. def create(options: Map[String, String], default: WriteConfig): WriteConfig

    Permalink

    Create a configuration easily from the Java API using the values in the Map, using the optional default configuration for any default values.

    Create a configuration easily from the Java API using the values in the Map, using the optional default configuration for any default values.

    Note: Values in the map do not need to be prefixed with the configPrefix.

    options

    a map of properties and their string values

    default

    the optional default configuration, used for determining the default values for the properties

    returns

    the configuration

    Definition Classes
    WriteConfigMongoCompanionConfig
  25. def create(options: Map[String, String]): WriteConfig

    Permalink

    Create a configuration easily from the Java API using the values in the Map

    Create a configuration easily from the Java API using the values in the Map

    Note: Values in the map do not need to be prefixed with the configPrefix.

    options

    a map of properties and their string values

    returns

    the configuration

    Definition Classes
    WriteConfigMongoCompanionConfig
  26. def create(sparkConf: SparkConf): WriteConfig

    Permalink

    Create a configuration easily from the Java API using the sparkConf

    Create a configuration easily from the Java API using the sparkConf

    Uses the prefixed properties that are set in the Spark configuration to create the config.

    sparkConf

    the spark configuration

    returns

    the configuration

    Definition Classes
    WriteConfigMongoCompanionConfig
    See also

    configPrefix

  27. def create(javaSparkContext: JavaSparkContext): WriteConfig

    Permalink

    Create a configuration easily from the Java API using the JavaSparkContext

    Create a configuration easily from the Java API using the JavaSparkContext

    Uses the prefixed properties that are set in the Spark configuration to create the config.

    javaSparkContext

    the java spark context

    returns

    the configuration

    Definition Classes
    WriteConfigMongoCompanionConfig
    See also

    configPrefix

  28. def create(databaseName: String, collectionName: String, connectionString: String, replaceDocument: Boolean, maxBatchSize: Int, localThreshold: Int, writeConcern: WriteConcern): WriteConfig

    Permalink

    Creates a WriteConfig

    Creates a WriteConfig

    databaseName

    the database name

    collectionName

    the collection name

    connectionString

    the optional connection string used in the creation of this configuration

    replaceDocument

    replaces the whole document, when saving a Dataset that contains an _id field. If false only updates / sets the fields declared in the Dataset.

    maxBatchSize

    the maxBatchSize when performing a bulk update/insert. Defaults to 512.

    localThreshold

    the local threshold in milliseconds used when choosing among multiple MongoDB servers to send a request. Only servers whose ping time is less than or equal to the server with the fastest ping time plus the local threshold will be chosen.

    writeConcern

    the WriteConcern to use

    returns

    the write config

    Since

    2.1

  29. def create(databaseName: String, collectionName: String, connectionString: String, replaceDocument: Boolean, localThreshold: Int, writeConcern: WriteConcern): WriteConfig

    Permalink

    Creates a WriteConfig

    Creates a WriteConfig

    databaseName

    the database name

    collectionName

    the collection name

    connectionString

    the optional connection string used in the creation of this configuration

    replaceDocument

    replaces the whole document, when saving a Dataset that contains an _id field. If false only updates / sets the fields declared in the Dataset.

    localThreshold

    the local threshold in milliseconds used when choosing among multiple MongoDB servers to send a request. Only servers whose ping time is less than or equal to the server with the fastest ping time plus the local threshold will be chosen.

    writeConcern

    the WriteConcern to use

    returns

    the write config

    Since

    2.1

  30. def create(databaseName: String, collectionName: String, connectionString: String, localThreshold: Int, writeConcern: WriteConcern): WriteConfig

    Permalink

    Creates a WriteConfig

    Creates a WriteConfig

    databaseName

    the database name

    collectionName

    the collection name

    connectionString

    the optional connection string used in the creation of this configuration

    localThreshold

    the local threshold in milliseconds used when choosing among multiple MongoDB servers to send a request. Only servers whose ping time is less than or equal to the server with the fastest ping time plus the local threshold will be chosen.

    writeConcern

    the WriteConcern to use

    returns

    the write config

  31. def databaseName(databaseNameProperty: String, options: Map[String, String], default: Option[String] = None): String

    Permalink
    Attributes
    protected
    Definition Classes
    MongoCompanionConfig
  32. val databaseNameProperty: String

    Permalink

    The database name property

    The database name property

    Definition Classes
    MongoOutputConfig
  33. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  36. def getBoolean(newValue: Option[String], existingValue: Option[Boolean] = None, defaultValue: Boolean): Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    MongoCompanionConfig
  37. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  38. def getInt(newValue: Option[String], existingValue: Option[Int] = None, defaultValue: Int): Int

    Permalink
    Attributes
    protected
    Definition Classes
    MongoCompanionConfig
  39. def getOptionsFromConf(sparkConf: SparkConf): Map[String, String]

    Permalink

    Gets an options map from the SparkConf

    Gets an options map from the SparkConf

    sparkConf

    the SparkConf

    returns

    the options

    Definition Classes
    MongoCompanionConfig
  40. def getString(newValue: Option[String], existingValue: Option[String] = None, defaultValue: String): String

    Permalink
    Attributes
    protected
    Definition Classes
    MongoCompanionConfig
  41. def hashCode(): Int

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

    Permalink
    Definition Classes
    Any
  43. val localThresholdProperty: String

    Permalink

    The localThreshold property

    The localThreshold property

    The local threshold in milliseconds is used when choosing among multiple MongoDB servers to send a request. Only servers whose ping time is less than or equal to the server with the fastest ping time *plus* the local threshold will be chosen.

    For example when choosing which MongoS to send a request through a localThreshold of 0 would pick the MongoS with the fastest ping time.

    Default: 15 ms

    Definition Classes
    MongoOutputConfig
  44. val maxBatchSizeProperty: String

    Permalink

    The maxBatchSize property

    The maxBatchSize property

    The maximum size of the batch when performing a bulk update / insert operation.

    Default: 513

    Definition Classes
    MongoOutputConfig
    Since

    2.1

  45. val mongoURIProperty: String

    Permalink

    The mongo URI property

    The mongo URI property

    Represents a connection string.

    Any values set in the connection string will override any default values for the configuration.

    Definition Classes
    MongoCompanionConfig
  46. final def ne(arg0: AnyRef): Boolean

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

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

    Permalink
    Definition Classes
    AnyRef
  49. val replaceDocumentProperty: String

    Permalink

    The replaceDocument property

    The replaceDocument property

    When saving a Dataset with an _id field, the whole document will be replaced if true. Otherwise, only the fields in the Dataset will be updated.

    Default: true

    Definition Classes
    MongoOutputConfig
    Since

    2.1

  50. def stripPrefix(options: Map[String, String]): Map[String, String]

    Permalink

    Strip the prefix from options

    Strip the prefix from options

    options

    options that may contain the prefix

    returns

    prefixLess options

    Definition Classes
    MongoCompanionConfig
  51. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  56. val writeConcernJournalProperty: String

    Permalink

    The WriteConcern journal property

    The WriteConcern journal property

    Definition Classes
    MongoOutputConfig
    See also

    WriteConcernConfig

  57. val writeConcernWProperty: String

    Permalink

    The WriteConcern w property

    The WriteConcern w property

    Definition Classes
    MongoOutputConfig
    See also

    WriteConcernConfig

  58. val writeConcernWTimeoutMSProperty: String

    Permalink

    The WriteConcern wTimeoutMS property

    The WriteConcern wTimeoutMS property

    Definition Classes
    MongoOutputConfig
    See also

    WriteConcernConfig

Deprecated Value Members

  1. def apply(sqlContext: SQLContext): Self

    Permalink

    Create a configuration from the sqlContext

    Create a configuration from the sqlContext

    Uses the prefixed properties that are set in the Spark configuration to create the config.

    sqlContext

    the SQL context

    returns

    the configuration

    Definition Classes
    MongoCompanionConfig
    Annotations
    @deprecated
    Deprecated

    (Since version 2.0.0) As of Spark 2.0 SQLContext was replaced by SparkSession. Use the SparkSession method instead

    See also

    configPrefix

Inherited from MongoOutputConfig

Inherited from MongoCompanionConfig

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped