/**
* Copyright (C) 2015 MongoDB Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see .
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the GNU Affero General Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#pragma once
#include
#include "mongo/bson/bsonobj.h"
#include "mongo/db/exec/plan_stage.h"
#include "mongo/db/index/sort_key_generator.h"
#include "mongo/db/query/index_bounds.h"
#include "mongo/db/query/stage_types.h"
namespace mongo {
class CollatorInterface;
class Collection;
class WorkingSetMember;
/**
* Passes results from the child through after adding the sort key for each result as
* WorkingSetMember computed data.
*/
class SortKeyGeneratorStage final : public PlanStage {
public:
SortKeyGeneratorStage(OperationContext* opCtx,
PlanStage* child,
WorkingSet* ws,
const BSONObj& sortSpecObj,
const CollatorInterface* collator);
bool isEOF() final;
StageType stageType() const final {
return STAGE_SORT_KEY_GENERATOR;
}
std::unique_ptr getStats() final;
const SpecificStats* getSpecificStats() const final;
static const char* kStageType;
protected:
StageState doWork(WorkingSetID* out) final;
private:
StatusWith getSortKeyFromIndexKey(const WorkingSetMember& member) const;
WorkingSet* const _ws;
// The raw sort pattern as expressed by the user.
const BSONObj _sortSpec;
const CollatorInterface* _collator;
std::unique_ptr _sortKeyGen;
};
} // namespace mongo