C# Class MongoDB.Driver.Builders.MapReduceOptions

A builder for the options of a Map/Reduce operation.
Mostrar archivo Open project: CloudMetal/mongo-csharp-driver

Public Methods

Method Description
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.

Method Details

SetFinalize() public static method

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

SetJSMode() public static method

Sets whether to use jsMode for the map reduce operation.
public static SetJSMode ( bool value ) : MapReduceOptionsBuilder
value bool Whether to use jsMode.
return MapReduceOptionsBuilder

SetKeepTemp() public static method

Sets whether to keep the temp collection (obsolete in 1.8.0+).
public static SetKeepTemp ( bool value ) : MapReduceOptionsBuilder
value bool Whether to keep the temp collection.
return MapReduceOptionsBuilder

SetLimit() public static method

Sets the number of documents to send to the map function (useful in combination with SetSortOrder).
public static SetLimit ( int value ) : MapReduceOptionsBuilder
value int The number of documents to send to the map function.
return MapReduceOptionsBuilder

SetOutput() public static method

Sets the output option (see MapReduceOutput).
public static SetOutput ( MapReduceOutput output ) : MapReduceOptionsBuilder
output MapReduceOutput The output option.
return MapReduceOptionsBuilder

SetQuery() public static method

Sets the optional query that filters which documents are sent to the map function (also useful in combination with SetSortOrder and SetLimit).
public static SetQuery ( IMongoQuery query ) : MapReduceOptionsBuilder
query IMongoQuery The query.
return MapReduceOptionsBuilder

SetScope() public static method

Sets a scope that contains variables that can be accessed by the map, reduce and finalize functions.
public static SetScope ( IMongoScope scope ) : MapReduceOptionsBuilder
scope IMongoScope The scope.
return MapReduceOptionsBuilder

SetSortOrder() public static 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 static SetSortOrder ( ) : MapReduceOptionsBuilder
return MapReduceOptionsBuilder

SetSortOrder() public static 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 static SetSortOrder ( IMongoSortBy sortBy ) : MapReduceOptionsBuilder
sortBy IMongoSortBy The sort order.
return MapReduceOptionsBuilder

SetVerbose() public static method

Sets whether the server should be more verbose when logging map/reduce operations.
public static SetVerbose ( bool value ) : MapReduceOptionsBuilder
value bool Whether the server should be more verbose.
return MapReduceOptionsBuilder