diff options
Diffstat (limited to 'src/mongo/db/query/lite_parsed_query.h')
| -rw-r--r-- | src/mongo/db/query/lite_parsed_query.h | 537 |
1 files changed, 298 insertions, 239 deletions
diff --git a/src/mongo/db/query/lite_parsed_query.h b/src/mongo/db/query/lite_parsed_query.h index de34ea0ffd6..f0744eeb782 100644 --- a/src/mongo/db/query/lite_parsed_query.h +++ b/src/mongo/db/query/lite_parsed_query.h @@ -35,245 +35,304 @@ namespace mongo { - class NamespaceString; - class QueryMessage; - class Status; - template<typename T> class StatusWith; +class NamespaceString; +class QueryMessage; +class Status; +template <typename T> +class StatusWith; + +/** + * Parses the QueryMessage or find command received from the user and makes the various fields + * more easily accessible. + */ +class LiteParsedQuery { +public: + /** + * Parses a find command object, 'cmdObj'. Caller must indicate whether or not this lite + * parsed query is an explained query or not via 'isExplain'. + * + * Returns a heap allocated LiteParsedQuery on success or an error if 'cmdObj' is not well + * formed. + */ + static StatusWith<std::unique_ptr<LiteParsedQuery>> makeFromFindCommand( + const NamespaceString& nss, const BSONObj& cmdObj, bool isExplain); + + /** + * Constructs a LiteParseQuery object as though it is from a legacy QueryMessage. + */ + static StatusWith<std::unique_ptr<LiteParsedQuery>> makeAsOpQuery(const std::string& ns, + int ntoskip, + int ntoreturn, + int queryoptions, + const BSONObj& query, + const BSONObj& proj, + const BSONObj& sort, + const BSONObj& hint, + const BSONObj& minObj, + const BSONObj& maxObj, + bool snapshot, + bool explain); + + /** + * Constructs a LiteParseQuery object that can be used to serialize to find command + * BSON object. + */ + static StatusWith<std::unique_ptr<LiteParsedQuery>> makeAsFindCmd(const NamespaceString& ns, + const BSONObj& query, + boost::optional<int> limit); + + /** + * Converts this LPQ into a find command. + */ + BSONObj asFindCommand() const; /** - * Parses the QueryMessage or find command received from the user and makes the various fields - * more easily accessible. + * Helper functions to parse maxTimeMS from a command object. Returns the contained value, + * or an error on parsing fail. When passed an EOO-type element, returns 0 (special value + * for "allow to run indefinitely"). */ - class LiteParsedQuery { - public: - /** - * Parses a find command object, 'cmdObj'. Caller must indicate whether or not this lite - * parsed query is an explained query or not via 'isExplain'. - * - * Returns a heap allocated LiteParsedQuery on success or an error if 'cmdObj' is not well - * formed. - */ - static StatusWith<std::unique_ptr<LiteParsedQuery>> - makeFromFindCommand(const NamespaceString& nss, const BSONObj& cmdObj, bool isExplain); - - /** - * Constructs a LiteParseQuery object as though it is from a legacy QueryMessage. - */ - static StatusWith<std::unique_ptr<LiteParsedQuery>> makeAsOpQuery(const std::string& ns, - int ntoskip, - int ntoreturn, - int queryoptions, - const BSONObj& query, - const BSONObj& proj, - const BSONObj& sort, - const BSONObj& hint, - const BSONObj& minObj, - const BSONObj& maxObj, - bool snapshot, - bool explain); - - /** - * Constructs a LiteParseQuery object that can be used to serialize to find command - * BSON object. - */ - static StatusWith<std::unique_ptr<LiteParsedQuery>> - makeAsFindCmd(const NamespaceString& ns, - const BSONObj& query, - boost::optional<int> limit); - - /** - * Converts this LPQ into a find command. - */ - BSONObj asFindCommand() const; - - /** - * Helper functions to parse maxTimeMS from a command object. Returns the contained value, - * or an error on parsing fail. When passed an EOO-type element, returns 0 (special value - * for "allow to run indefinitely"). - */ - static StatusWith<int> parseMaxTimeMSCommand(const BSONObj& cmdObj); - - /** - * Same as parseMaxTimeMSCommand, but for a query object. - */ - static StatusWith<int> parseMaxTimeMSQuery(const BSONObj& queryObj); - - /** - * Helper function to identify text search sort key - * Example: {a: {$meta: "textScore"}} - */ - static bool isTextScoreMeta(BSONElement elt); - - /** - * Helper function to identify recordId projection. - * - * Example: {a: {$meta: "recordId"}}. - */ - static bool isRecordIdMeta(BSONElement elt); - - /** - * Helper function to validate a sort object. - * Returns true if each element satisfies one of: - * 1. a number with value 1 - * 2. a number with value -1 - * 3. isTextScoreMeta - */ - static bool isValidSortOrder(const BSONObj& sortObj); - - /** - * Returns true if the query described by "query" should execute - * at an elevated level of isolation (i.e., $isolated was specified). - */ - static bool isQueryIsolated(const BSONObj& query); - - // Names of the maxTimeMS command and query option. - static const std::string cmdOptionMaxTimeMS; - static const std::string queryOptionMaxTimeMS; - - // Names of the $meta projection values. - static const std::string metaTextScore; - static const std::string metaGeoNearDistance; - static const std::string metaGeoNearPoint; - static const std::string metaRecordId; - static const std::string metaIndexKey; - - const std::string& ns() const { return _ns; } - - const BSONObj& getFilter() const { return _filter; } - const BSONObj& getProj() const { return _proj; } - const BSONObj& getSort() const { return _sort; } - const BSONObj& getHint() const { return _hint; } - - static const int kDefaultBatchSize; - - int getSkip() const { return _skip; } - boost::optional<int> getLimit() const { return _limit; } - boost::optional<int> getBatchSize() const { return _batchSize; } - bool wantMore() const { return _wantMore; } - - bool isFromFindCommand() const { return _fromCommand; } - bool isExplain() const { return _explain; } - - const std::string& getComment() const { return _comment; } - - int getMaxScan() const { return _maxScan; } - int getMaxTimeMS() const { return _maxTimeMS; } - - const BSONObj& getMin() const { return _min; } - const BSONObj& getMax() const { return _max; } - - bool returnKey() const { return _returnKey; } - bool showRecordId() const { return _showRecordId; } - bool isSnapshot() const { return _snapshot; } - bool hasReadPref() const { return _hasReadPref; } - - bool isTailable() const { return _tailable; } - bool isSlaveOk() const { return _slaveOk; } - bool isOplogReplay() const { return _oplogReplay; } - bool isNoCursorTimeout() const { return _noCursorTimeout; } - bool isAwaitData() const { return _awaitData; } - bool isExhaust() const { return _exhaust; } - bool isPartial() const { return _partial; } - - /** - * Return options as a bit vector. - */ - int getOptions() const; - - // - // Old parsing code: SOON TO BE DEPRECATED. - // - - /** - * Parse the provided QueryMessage and return a heap constructed LiteParsedQuery, which - * represents it or an error. - */ - static StatusWith<std::unique_ptr<LiteParsedQuery>> fromLegacyQueryMessage( - const QueryMessage& qm); - - private: - LiteParsedQuery() = default; - - /** - * Parsing code calls this after construction of the LPQ is complete. There are additional - * semantic properties that must be checked even if "lexically" the parse is OK. - */ - Status validate() const; - - Status init(const std::string& ns, int ntoskip, int ntoreturn, int queryOptions, - const BSONObj& queryObj, const BSONObj& proj, bool fromQueryMessage); - - Status initFullQuery(const BSONObj& top); - - static StatusWith<int> parseMaxTimeMS(const BSONElement& maxTimeMSElt); - - /** - * Updates the projection object with a $meta projection for the returnKey option. - */ - void addReturnKeyMetaProj(); - - /** - * Updates the projection object with a $meta projection for the showRecordId option. - */ - void addShowRecordIdMetaProj(); - - /** - * Initializes options based on the value of the 'options' bit vector. - * - * This contains flags such as tailable, exhaust, and noCursorTimeout. - */ - void initFromInt(int options); - - /** - * Add the meta projection to this object if needed. - */ - void addMetaProjection(); - - /** - * Returns OK if this is valid in the find command context. - */ - Status validateFindCmd(); - - std::string _ns; - - BSONObj _filter; - BSONObj _proj; - BSONObj _sort; - // The hint provided, if any. If the hint was by index key pattern, the value of '_hint' is - // the key pattern hinted. If the hint was by index name, the value of '_hint' is - // {$hint: <String>}, where <String> is the index name hinted. - BSONObj _hint; - - int _skip = 0; - bool _wantMore = true; - - boost::optional<int> _limit; - boost::optional<int> _batchSize; - - bool _fromCommand = false; - bool _explain = false; - - std::string _comment; - - int _maxScan = 0; - int _maxTimeMS = 0; - - BSONObj _min; - BSONObj _max; - - bool _returnKey = false; - bool _showRecordId = false; - bool _snapshot = false; - bool _hasReadPref = false; - - // Options that can be specified in the OP_QUERY 'flags' header. - bool _tailable = false; - bool _slaveOk = false; - bool _oplogReplay = false; - bool _noCursorTimeout = false; - bool _awaitData = false; - bool _exhaust = false; - bool _partial = false; - }; - -} // namespace mongo + static StatusWith<int> parseMaxTimeMSCommand(const BSONObj& cmdObj); + + /** + * Same as parseMaxTimeMSCommand, but for a query object. + */ + static StatusWith<int> parseMaxTimeMSQuery(const BSONObj& queryObj); + + /** + * Helper function to identify text search sort key + * Example: {a: {$meta: "textScore"}} + */ + static bool isTextScoreMeta(BSONElement elt); + + /** + * Helper function to identify recordId projection. + * + * Example: {a: {$meta: "recordId"}}. + */ + static bool isRecordIdMeta(BSONElement elt); + + /** + * Helper function to validate a sort object. + * Returns true if each element satisfies one of: + * 1. a number with value 1 + * 2. a number with value -1 + * 3. isTextScoreMeta + */ + static bool isValidSortOrder(const BSONObj& sortObj); + + /** + * Returns true if the query described by "query" should execute + * at an elevated level of isolation (i.e., $isolated was specified). + */ + static bool isQueryIsolated(const BSONObj& query); + + // Names of the maxTimeMS command and query option. + static const std::string cmdOptionMaxTimeMS; + static const std::string queryOptionMaxTimeMS; + + // Names of the $meta projection values. + static const std::string metaTextScore; + static const std::string metaGeoNearDistance; + static const std::string metaGeoNearPoint; + static const std::string metaRecordId; + static const std::string metaIndexKey; + + const std::string& ns() const { + return _ns; + } + + const BSONObj& getFilter() const { + return _filter; + } + const BSONObj& getProj() const { + return _proj; + } + const BSONObj& getSort() const { + return _sort; + } + const BSONObj& getHint() const { + return _hint; + } + + static const int kDefaultBatchSize; + + int getSkip() const { + return _skip; + } + boost::optional<int> getLimit() const { + return _limit; + } + boost::optional<int> getBatchSize() const { + return _batchSize; + } + bool wantMore() const { + return _wantMore; + } + + bool isFromFindCommand() const { + return _fromCommand; + } + bool isExplain() const { + return _explain; + } + + const std::string& getComment() const { + return _comment; + } + + int getMaxScan() const { + return _maxScan; + } + int getMaxTimeMS() const { + return _maxTimeMS; + } + + const BSONObj& getMin() const { + return _min; + } + const BSONObj& getMax() const { + return _max; + } + + bool returnKey() const { + return _returnKey; + } + bool showRecordId() const { + return _showRecordId; + } + bool isSnapshot() const { + return _snapshot; + } + bool hasReadPref() const { + return _hasReadPref; + } + + bool isTailable() const { + return _tailable; + } + bool isSlaveOk() const { + return _slaveOk; + } + bool isOplogReplay() const { + return _oplogReplay; + } + bool isNoCursorTimeout() const { + return _noCursorTimeout; + } + bool isAwaitData() const { + return _awaitData; + } + bool isExhaust() const { + return _exhaust; + } + bool isPartial() const { + return _partial; + } + + /** + * Return options as a bit vector. + */ + int getOptions() const; + + // + // Old parsing code: SOON TO BE DEPRECATED. + // + + /** + * Parse the provided QueryMessage and return a heap constructed LiteParsedQuery, which + * represents it or an error. + */ + static StatusWith<std::unique_ptr<LiteParsedQuery>> fromLegacyQueryMessage( + const QueryMessage& qm); + +private: + LiteParsedQuery() = default; + + /** + * Parsing code calls this after construction of the LPQ is complete. There are additional + * semantic properties that must be checked even if "lexically" the parse is OK. + */ + Status validate() const; + + Status init(const std::string& ns, + int ntoskip, + int ntoreturn, + int queryOptions, + const BSONObj& queryObj, + const BSONObj& proj, + bool fromQueryMessage); + + Status initFullQuery(const BSONObj& top); + + static StatusWith<int> parseMaxTimeMS(const BSONElement& maxTimeMSElt); + + /** + * Updates the projection object with a $meta projection for the returnKey option. + */ + void addReturnKeyMetaProj(); + + /** + * Updates the projection object with a $meta projection for the showRecordId option. + */ + void addShowRecordIdMetaProj(); + + /** + * Initializes options based on the value of the 'options' bit vector. + * + * This contains flags such as tailable, exhaust, and noCursorTimeout. + */ + void initFromInt(int options); + + /** + * Add the meta projection to this object if needed. + */ + void addMetaProjection(); + + /** + * Returns OK if this is valid in the find command context. + */ + Status validateFindCmd(); + + std::string _ns; + + BSONObj _filter; + BSONObj _proj; + BSONObj _sort; + // The hint provided, if any. If the hint was by index key pattern, the value of '_hint' is + // the key pattern hinted. If the hint was by index name, the value of '_hint' is + // {$hint: <String>}, where <String> is the index name hinted. + BSONObj _hint; + + int _skip = 0; + bool _wantMore = true; + + boost::optional<int> _limit; + boost::optional<int> _batchSize; + + bool _fromCommand = false; + bool _explain = false; + + std::string _comment; + + int _maxScan = 0; + int _maxTimeMS = 0; + + BSONObj _min; + BSONObj _max; + + bool _returnKey = false; + bool _showRecordId = false; + bool _snapshot = false; + bool _hasReadPref = false; + + // Options that can be specified in the OP_QUERY 'flags' header. + bool _tailable = false; + bool _slaveOk = false; + bool _oplogReplay = false; + bool _noCursorTimeout = false; + bool _awaitData = false; + bool _exhaust = false; + bool _partial = false; +}; + +} // namespace mongo |