MongoDB C++ Driver  mongocxx-3.1.0
Public Member Functions | List of all members
mongocxx::options::create_view Class Reference

Class representing the optional arguments to a view creation operation. More...

#include <create_view.hpp>

Public Member Functions

create_viewcollation (bsoncxx::document::view_or_value collation)
 Sets the default collation for this view. More...
 
const stdx::optional< bsoncxx::document::view_or_value > & collation () const
 Gets the default collation for this view. More...
 
create_viewpipeline (pipeline pipeline)
 Sets the pipeline that will be used to compute this view. More...
 
const stdx::optional< class pipeline > & pipeline () const
 Gets the pipeline that will be used to compute this view. More...
 
bsoncxx::document::value to_document () const
 Return a bson document representing the options set on this object. More...
 
 operator bsoncxx::document::value () const
 

Detailed Description

Class representing the optional arguments to a view creation operation.

See also
https://docs.mongodb.com/master/core/views/

Member Function Documentation

create_view& mongocxx::options::create_view::collation ( bsoncxx::document::view_or_value  collation)

Sets the default collation for this view.

Parameters
collationThe default collation for the view.
See also
https://docs.mongodb.com/master/reference/collation/
const stdx::optional<bsoncxx::document::view_or_value>& mongocxx::options::create_view::collation ( ) const

Gets the default collation for this view.

Returns
The default collation for the view.
See also
https://docs.mongodb.com/master/reference/collation/
mongocxx::options::create_view::operator bsoncxx::document::value ( ) const
Deprecated:
This method is deprecated. To determine which options are set on this object, use the provided accessors instead.
create_view& mongocxx::options::create_view::pipeline ( pipeline  pipeline)

Sets the pipeline that will be used to compute this view.

Parameters
pipelinePipeline that will be used to compute the view.
const stdx::optional<class pipeline>& mongocxx::options::create_view::pipeline ( ) const

Gets the pipeline that will be used to compute this view.

Returns
Pipeline that will be used to compute the view.
bsoncxx::document::value mongocxx::options::create_view::to_document ( ) const

Return a bson document representing the options set on this object.

Deprecated:
This method is deprecated. To determine which options are set on this object, use the provided accessors instead.
Returns
Options, as a document.

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