com.mongodb.spark.config.ReadConcernConfig.scala Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of mongo-spark-connector_2.12 Show documentation
mongo-spark-connector
There is a newer version: 10.2.3
Show newest version
/*
 * Copyright 2016 MongoDB, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.mongodb.spark.config

import java.util

import com.mongodb.spark.notNull
import scala.collection.JavaConverters._
import scala.collection.Map
import scala.util.Try

import org.apache.spark.SparkConf

import com.mongodb.{ReadConcern, ReadConcernLevel}
import org.apache.spark.api.java.JavaSparkContext
import org.apache.spark.sql.{SQLContext, SparkSession}

/**
 * The `ReadConcernConfig` companion object
 *
 * @since 1.0
 */
object ReadConcernConfig extends MongoInputConfig {

  type Self = ReadConcernConfig

  /**
   * Creates a `ReadConcernConfig` from a `ReadConcern` instance
   *
   * @param readConcern the read concern
   * @return the configuration
   */
  def apply(readConcern: ReadConcern): ReadConcernConfig = {
    new ReadConcernConfig(Option(readConcern.asDocument().get("level")) match {
      case Some(level) => Some(level.asString().getValue)
      case None        => None
    })
  }

  override def apply(options: collection.Map[String, String], default: Option[ReadConcernConfig]): ReadConcernConfig = {
    val cleanedOptions = stripPrefix(options)

    val defaultReadConcernConfig: ReadConcernConfig = default.getOrElse(
      Option(connectionString(cleanedOptions).getReadConcern) match {
        case Some(readCon) => ReadConcernConfig(readCon)
        case None          => ReadConcernConfig()
      }
    )

    options.get(readConcernLevelProperty).map(level => new ReadConcernConfig(Some(level))).getOrElse(defaultReadConcernConfig)
  }

  /**
   * Default configuration
   *
   * @return the configuration
   */
  def create(): ReadConcernConfig = ReadConcernConfig()

  /**
   * Creates a `ReadConcernConfig` from a `ReadConcern` instance
   *
   * @param readConcern the read concern
   * @return the configuration
   */
  def create(readConcern: ReadConcern): ReadConcernConfig = {
    notNull("readConcern", readConcern)
    apply(readConcern)
  }

  override def create(sparkConf: SparkConf): ReadConcernConfig = {
    notNull("sparkConf", sparkConf)
    apply(sparkConf)
  }

  override def create(options: util.Map[String, String]): ReadConcernConfig = {
    notNull("options", options)
    apply(options.asScala)
  }

  override def create(options: util.Map[String, String], default: ReadConcernConfig): ReadConcernConfig = {
    notNull("options", options)
    notNull("default", default)
    apply(options.asScala, Some(default))
  }

  override def create(javaSparkContext: JavaSparkContext): ReadConcernConfig = {
    notNull("javaSparkContext", javaSparkContext)
    apply(javaSparkContext.getConf)
  }

  override def create(sparkConf: SparkConf, options: util.Map[String, String]): ReadConcernConfig = {
    notNull("sparkConf", sparkConf)
    notNull("options", options)
    apply(sparkConf, options.asScala)
  }

  @deprecated("As of Spark 2.0 SQLContext was replaced by SparkSession. Use the SparkSession method instead", "2.0.0")
  override def create(sqlContext: SQLContext): ReadConcernConfig = {
    notNull("sqlContext", sqlContext)
    create(sqlContext.sparkSession)
  }

  override def create(sparkSession: SparkSession): ReadConcernConfig = {
    notNull("sparkSession", sparkSession)
    apply(sparkSession)
  }
}

/**
 * The `ReadConcern` configuration used by the [[ReadConfig]].
 *
 * @param readConcernLevel the optional read concern level. If None the servers default level will be used.
 * @since 1.0
 */
case class ReadConcernConfig(private val readConcernLevel: Option[String] = None) extends MongoClassConfig {
  require(Try(readConcern).isSuccess, s"Invalid ReadConcernConfig configuration")

  type Self = ReadConcernConfig

  override def asOptions: collection.Map[String, String] = readConcernLevel match {
    case Some(level) => Map(ReadConcernConfig.readConcernLevelProperty -> level)
    case None        => Map()
  }

  override def withOption(key: String, value: String): ReadConcernConfig = ReadConcernConfig(this.asOptions + (key -> value))

  override def withOptions(options: collection.Map[String, String]): ReadConcernConfig = ReadConcernConfig(options, Some(this))

  override def withOptions(options: util.Map[String, String]): ReadConcernConfig = withOptions(options.asScala)

  override def asJavaOptions: util.Map[String, String] = asOptions.asJava

  /**
   * The `ReadConcern` that this config represents
   *
   * @return the ReadConcern
   */
  def readConcern: ReadConcern = {
    readConcernLevel match {
      case Some(level) => new ReadConcern(ReadConcernLevel.fromString(level))
      case None        => ReadConcern.DEFAULT
    }
  }

}