io.github.zeal18.zio.mongodb.driver.ReadConcern.scala Maven / Gradle / Ivy
/*
* Copyright 2008-present 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 io.github.zeal18.zio.mongodb.driver
import com.mongodb.ReadConcern as JReadConcern
/** The readConcern option allows clients to choose a level of isolation for their reads.
*
* @note Requires MongoDB 3.2 or greater
*/
object ReadConcern {
/** Construct a new read concern
*
* @param readConcernLevel the read concern level
*/
def apply(readConcernLevel: ReadConcernLevel): ReadConcern = new JReadConcern(readConcernLevel)
/** Use the servers default read concern.
*/
val DEFAULT: ReadConcern = JReadConcern.DEFAULT
/** Return the node's most recent copy of data. Provides no guarantee that the data has been written to a majority of the nodes.
*/
val LOCAL: ReadConcern = JReadConcern.LOCAL
/** Return the node's most recent copy of the data confirmed as having been written to a majority of the nodes.
*/
val MAJORITY: ReadConcern = JReadConcern.MAJORITY
/** The linearizable read concern.
*
* This read concern is only compatible with [[org.mongodb.scala.ReadPreference$.primary]]
*
* @note Requires MongoDB 3.4 or greater
*/
val LINEARIZABLE: ReadConcern = JReadConcern.LINEARIZABLE
/** The snapshot read concern level.
*
* @note Requires MongoDB 4.0 or greater
*/
val SNAPSHOT: ReadConcern = JReadConcern.SNAPSHOT
/** The available read concern level.
*
* @note Requires MongoDB 4.0 or greater
*/
val AVAILABLE: ReadConcern = JReadConcern.AVAILABLE
}