mirror of
https://github.com/mongodb/mongo.git
synced 2024-12-01 09:32:32 +01:00
40 lines
1.2 KiB
C++
40 lines
1.2 KiB
C++
// commands.h
|
|
|
|
/**
|
|
*
|
|
* 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 <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
class BSONObj;
|
|
class BSONObjBuilder;
|
|
|
|
// db "commands" (sent via db.$cmd.findOne(...))
|
|
// subclass to make a command.
|
|
class Command {
|
|
public:
|
|
string name;
|
|
|
|
/* run the given command
|
|
implement this...
|
|
return value is true if succeeded. if false, set errmsg text.
|
|
*/
|
|
virtual bool run(const char *ns, BSONObj& cmdObj, string& errmsg, BSONObjBuilder& result) = 0;
|
|
|
|
/* return true if only the admin ns has privileges to run this command. */
|
|
virtual bool adminOnly() { return false; }
|
|
|
|
Command(const char *_name);
|
|
};
|