Input
The following table describes the fields on the Input tab of the QueryDocument activity.
Input Item | Data Type | Description |
---|---|---|
The following fields are displayed when FIND_ONE in the Query Type list is selected on the General tab. | ||
CollectionName | String | In single or double quotation marks, specify the name of the collection where query operations are performed. |
QueryDocument | String | Enter a document name within double quotation marks. This document is used to query one or more documents from the collection. |
ReturnFieldsDocument | String | Enter a document name within double quotation marks. This document is used to decide the return field values in the queried documents. |
SortDocument | String | Enter a document name within double quotation marks. This document is used to define the sequence of the documents in the query result. |
The following fields are displayed when FIND_MANY in the Query Type list is selected on the General tab. | ||
CollectionName | String | In single or double quotation marks, specify the name of the collection where query operations are performed. |
QueryDocument | String | Enter a document name within double quotation marks. This document is used to query one or more documents from a specified collection. |
ReturnFieldsDocument | String | Enter a document name within double quotation marks. This document is used to decide the return field values in the queried documents. |
Skip | Integer | Enter a number to decide how many documents to skip before the query result is displayed. |
Limit | Integer | Enter a number to decide how many documents to display in the query result. |
HintDocument | String | Enter a document name within double quotation marks. This document contains an index name or index specification and is used to overwrite the default index in a collection. |
SortDocument | Integer | Enter a document name within double quotation marks. This document is used to define the sequence of the documents in the query result. |
The following fields are displayed when COUNT in the Query Type list is selected on the General tab. | ||
CollectionName | String | In single or double quotation marks, specify the name of the collection where query operations are performed. |
QueryDocument | String | Enter a document name within double quotation marks. This document is used to query one or more documents from a specified collection. |
Skip | Integer | Enter a number to decide how many documents to skip before the query result is displayed. |
Limit | Integer | Enter a number to decide how many documents to display as the query result. |
The following fields are displayed when DISTINCT in the Query Type list is selected on the General tab. | ||
CollectionName | String | Specify the name of the collection (within single or double quotation marks) where query operations are performed. |
QueryDocument | String | Enter a document name within double quotation marks. This document is used to query one or more documents from the collection. |
DistinctField | String | Enter a field name within single or double quotation marks. This value decides the distinct field values returned from the queried documents. |
The following fields are displayed when Aggregate in the Query Type list is selected on the General tab. | ||
CollectionName | String | In single or double quotation marks, specify the name of the collection where query operations are performed. |
Document | String | Enter a document name within double quotation marks. This document contains an aggregation pipeline or a map-reduce operation and is used to perform an aggregation in a collection.
For more information on defining an aggregation pipeline or a map-reduce operation, see http://docs.mongodb.org/manual/core/aggregation-introduction. |
The following fields are displayed when the Is GridFS check box, and FIND_ONE in the File Query Type list are selected on the General tab. | ||
BucketName | String | In single or double quotation marks, enter the name of the bucket where you can query a matching file. |
FileName | String | Enter the name for the file within single or double quotation marks. |
GenerateNewFile | String | In double quotation marks, enter the absolute path for the file where you want to save the query output result.
Condition: Available only when WRITE_TO_FILE in the File Content Output Type list is selected on the General tab. |
The following fields are displayed when the Is GridFS check box, and FIND_MANY in the File Query Type list are selected on the General tab. | ||
BucketName | String | In single or double quotation marks, enter the name of the bucket where you can query all matching files. |
QueryDocument | String | Enter a document name in double quotation marks. This document is used to query files from a bucket. |
OutputFileDirectory | String | In single or double quotation marks, enter the directory for the output file.
Condition: Available only when WRITE_TO_FILE in the File Content Output Type list is selected on the General tab |
Copyright © 2021. TIBCO Software Inc. All Rights Reserved.