C# Class MongoDB.Driver.Builders.MapReduceOptionsBuilder

Inheritance: BuilderBase, IMongoMapReduceOptions

Mostrar archivo Open project: CloudMetal/mongo-csharp-driver Class Usage Examples

Public Methods

Method	Description
MapReduceOptionsBuilder ( ) : System	Initializes a new instance of the MapReduceOptionsBuilder class.
SetFinalize ( BsonJavaScript finalize ) : MapReduceOptionsBuilder	Sets the finalize function.
SetJSMode ( bool value ) : MapReduceOptionsBuilder	Sets whether to use jsMode for the map reduce operation.
SetKeepTemp ( bool value ) : MapReduceOptionsBuilder	Sets whether to keep the temp collection (obsolete in 1.8.0+).
SetLimit ( int value ) : MapReduceOptionsBuilder	Sets the number of documents to send to the map function (useful in combination with SetSortOrder).
SetOutput ( MapReduceOutput output ) : MapReduceOptionsBuilder	Sets the output option (see MapReduceOutput).
SetQuery ( IMongoQuery query ) : MapReduceOptionsBuilder	Sets the optional query that filters which documents are sent to the map function (also useful in combination with SetSortOrder and SetLimit).
SetScope ( IMongoScope scope ) : MapReduceOptionsBuilder	Sets a scope that contains variables that can be accessed by the map, reduce and finalize functions.
SetSortOrder ( ) : MapReduceOptionsBuilder	Sets the sort order (useful in combination with SetLimit, your map function should not depend on the order the documents are sent to it).
SetSortOrder ( IMongoSortBy sortBy ) : MapReduceOptionsBuilder	Sets the sort order (useful in combination with SetLimit, your map function should not depend on the order the documents are sent to it).
SetVerbose ( bool value ) : MapReduceOptionsBuilder	Sets whether the server should be more verbose when logging map/reduce operations.
ToBsonDocument ( ) : BsonDocument	Returns the result of the builder as a BsonDocument.

Protected Methods

Method	Description
Serialize ( BsonWriter bsonWriter, Type nominalType, IBsonSerializationOptions options ) : void	Serializes the result of the builder to a BsonWriter.

Private Methods

Method	Description
AddOptions ( BsonDocument options ) : MapReduceOptionsBuilder

Method Details

MapReduceOptionsBuilder() public method

Initializes a new instance of the MapReduceOptionsBuilder class.

public MapReduceOptionsBuilder ( ) : System
return	System

Serialize() protected method

Serializes the result of the builder to a BsonWriter.

protected Serialize ( BsonWriter bsonWriter, Type nominalType, IBsonSerializationOptions options ) : void
bsonWriter	BsonWriter	The writer.
nominalType	System.Type	The nominal type.
options	IBsonSerializationOptions	The serialization options.
return	void

SetFinalize() public method

Sets the finalize function.

public SetFinalize ( BsonJavaScript finalize ) : MapReduceOptionsBuilder
finalize	BsonJavaScript	The finalize function.
return	MapReduceOptionsBuilder

SetJSMode() public method

Sets whether to use jsMode for the map reduce operation.

public SetJSMode ( bool value ) : MapReduceOptionsBuilder
value	bool	Whether to use jsMode.
return	MapReduceOptionsBuilder

SetKeepTemp() public method

Sets whether to keep the temp collection (obsolete in 1.8.0+).

public SetKeepTemp ( bool value ) : MapReduceOptionsBuilder
value	bool	Whether to keep the temp collection.
return	MapReduceOptionsBuilder

SetLimit() public method

Sets the number of documents to send to the map function (useful in combination with SetSortOrder).

public SetLimit ( int value ) : MapReduceOptionsBuilder
value	int	The number of documents to send to the map function.
return	MapReduceOptionsBuilder

SetOutput() public method

Sets the output option (see MapReduceOutput).

public SetOutput ( MapReduceOutput output ) : MapReduceOptionsBuilder
output	MapReduceOutput	The output option.
return	MapReduceOptionsBuilder

SetQuery() public method

Sets the optional query that filters which documents are sent to the map function (also useful in combination with SetSortOrder and SetLimit).

public SetQuery ( IMongoQuery query ) : MapReduceOptionsBuilder
query	IMongoQuery	The query.
return	MapReduceOptionsBuilder

SetScope() public method

Sets a scope that contains variables that can be accessed by the map, reduce and finalize functions.

public SetScope ( IMongoScope scope ) : MapReduceOptionsBuilder
scope	IMongoScope	The scope.
return	MapReduceOptionsBuilder

SetSortOrder() public method

Sets the sort order (useful in combination with SetLimit, your map function should not depend on the order the documents are sent to it).

public SetSortOrder ( ) : MapReduceOptionsBuilder
return	MapReduceOptionsBuilder

SetSortOrder() public method

Sets the sort order (useful in combination with SetLimit, your map function should not depend on the order the documents are sent to it).

public SetSortOrder ( IMongoSortBy sortBy ) : MapReduceOptionsBuilder
sortBy	IMongoSortBy	The sort order.
return	MapReduceOptionsBuilder

SetVerbose() public method

Sets whether the server should be more verbose when logging map/reduce operations.

public SetVerbose ( bool value ) : MapReduceOptionsBuilder
value	bool	Whether the server should be more verbose.
return	MapReduceOptionsBuilder

ToBsonDocument() public method

Returns the result of the builder as a BsonDocument.

public ToBsonDocument ( ) : BsonDocument
return	BsonDocument