Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Name

Description

Default Value

pipeline

Array containing a pipeline of stages for documents to pass through before being output from the interface.

[]

(in this case, you'll get records from the desired collection without any transformations)

skip

Number that specifies a number of records that should be skipped from the beginning. This parameter will be transformed into $skip aggregation stage and executed at the very end.

0

limit

Number that specifies a number of records that will be cut from the final results. This parameter will be transformed into $limit aggregation stage and executed at the very end.

10000

maxTimeMS

Number that specifies the time limit for the query in Mongo.

0

(if nothing else was set to MAX_TIME_MS environment variable)

batchSize

Specifies the number of documents to return in each batch of the response from the MongoDB instance. Defaults to 100

100

hint

Specifies a Mongo collection index to use instead of the chosen index selected during the query planner stage. We recommend only using this parameter in the rare cases when Mongo isn’t choosing the best index during the initial query planner stage.

desiredIndexName

Example

A simple request to this interface using all of the available parameters looks like the request below.

...