mongocxx::options::index_view Class Reference

Class representing optional arguments to IndexView operations. More...

#include <index_view.hpp>

Public Member Functions
index_view &	max_time (std::chrono::milliseconds max_time)
	Sets the maximum amount of time for this operation to run (server-side) in milliseconds. More...
const bsoncxx::stdx::optional< std::chrono::milliseconds > &	max_time () const
	The current max_time setting. More...
index_view &	write_concern (mongocxx::write_concern write_concern)
	Sets the write concern for this operation. More...
const bsoncxx::stdx::optional< mongocxx::write_concern > &	write_concern () const
	Gets the current write concern. More...
index_view &	commit_quorum (std::int32_t commit_quorum)
	Sets the commit quorum for this operation. More...
index_view &	commit_quorum (std::string commit_quorum)
	Sets the commit quorum for this operation. More...
const stdx::optional< bsoncxx::document::value >	commit_quorum () const
	Gets the current commitQuorum setting. More...

Detailed Description

Class representing optional arguments to IndexView operations.

Member Function Documentation

commit_quorum() [1/3]

const stdx::optional<bsoncxx::document::value> mongocxx::options::index_view::commit_quorum

(

)

const

Gets the current commitQuorum setting.

This option may only be used with MongoDB version 4.4 or later.

Returns

The current commitQuorum setting.

See also

https://docs.mongodb.com/manual/reference/command/createIndexes

commit_quorum() [2/3]

index_view& mongocxx::options::index_view::commit_quorum

(

std::int32_t

commit_quorum

)

Sets the commit quorum for this operation.

This option may only be used with MongoDB version 4.4 or later.

Parameters

commit_quorum

Integer representing the minimum number of data-bearing voting replica set members (i.e. commit quorum), including the primary, that must report a successful index build before the primary marks the indexes as ready. A value of 0 disables quorum-voting behavior.

Returns

A reference to the object on which this member function is being called. This facilitates method chaining.

See also

https://docs.mongodb.com/manual/reference/command/createIndexes

commit_quorum() [3/3]

index_view& mongocxx::options::index_view::commit_quorum

(

std::string

commit_quorum

)

Sets the commit quorum for this operation.

This option may only be used with MongoDB version 4.4 or later.

Parameters

commit_quorum

String representing the minimum number of data-bearing voting replica set members (i.e. commit quorum), including the primary, that must report a successful index build before the primary marks the indexes as ready.

Returns

A reference to the object on which this member function is being called. This facilitates method chaining.

See also

https://docs.mongodb.com/manual/reference/command/createIndexes

max_time() [1/2]

const bsoncxx::stdx::optional<std::chrono::milliseconds>& mongocxx::options::index_view::max_time

(

)

const

The current max_time setting.

Returns

The current max allowed running time (in milliseconds).

See also

https://docs.mongodb.com/manual/reference/command/findAndModify/

max_time() [2/2]

index_view& mongocxx::options::index_view::max_time

(

std::chrono::milliseconds

max_time

)

Sets the maximum amount of time for this operation to run (server-side) in milliseconds.

Parameters

max_time

The max amount of time (in milliseconds).

Returns

A reference to the object on which this member function is being called. This facilitates method chaining.

See also

https://docs.mongodb.com/manual/reference/command/findAndModify/

write_concern() [1/2]

const bsoncxx::stdx::optional<mongocxx::write_concern>& mongocxx::options::index_view::write_concern

(

)

const

Gets the current write concern.

Returns

The current write concern.

See also

https://docs.mongodb.com/manual/reference/command/findAndModify/

write_concern() [2/2]

index_view& mongocxx::options::index_view::write_concern

(

mongocxx::write_concern

write_concern

)

Sets the write concern for this operation.

Parameters

write_concern

Object representing the write concern.

Returns

A reference to the object on which this member function is being called. This facilitates method chaining.

See also

https://docs.mongodb.com/manual/reference/command/findAndModify/

---

The documentation for this class was generated from the following file:

• src/mongocxx/options/index_view.hpp