diff options
author | Gabriel Marks <gabriel.marks@mongodb.com> | 2022-08-30 19:28:35 +0000 |
---|---|---|
committer | Evergreen Agent <no-reply@evergreen.mongodb.com> | 2022-08-30 21:12:24 +0000 |
commit | 36b8246daa269b1a21d63d3f0e11c31b274e6703 (patch) | |
tree | 121fc5483e0bdd2effb73d6ac5e913761bb43ba6 /docs | |
parent | 27f7896edc0828d0c4bae3d70bbec7e8b0a66d98 (diff) | |
download | mongo-36b8246daa269b1a21d63d3f0e11c31b274e6703.tar.gz |
SERVER-68342 Modify ServerParameter to take tenantId
Diffstat (limited to 'docs')
-rw-r--r-- | docs/server-parameters.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/server-parameters.md b/docs/server-parameters.md index 5281ec855ac..3e37f97cdf0 100644 --- a/docs/server-parameters.md +++ b/docs/server-parameters.md @@ -129,7 +129,7 @@ to consider the new setting valid. `lt`, `gt`, `lte`, `gte` fields provide for s or expression maps which evaluate to numeric values. For all other validation cases, specify callback as a C++ function or static method. Note that validation rules (including callback) may run in any order. To perform an action after all validation rules have completed, `on_update` should be -preferred instead. Callback prototype: `Status(const cpp_vartype&);` +preferred instead. Callback prototype: `Status(const cpp_vartype&, const boost::optional<TenantId>&);` Any symbols such as global variables or callbacks used by a server parameter must be imported using the usual IDL machinery via `globals.cpp_includes`. Similarly, all generated code will be nested @@ -168,7 +168,7 @@ to any other work, this custom constructor must invoke its parent's constructor. `override_set`: If `true`, the implementer must provide a `set` member function as: ```cpp -Status {name}::set(const BSONElement& val); +Status {name}::set(const BSONElement& val, const boost::optional<TenantId>& tenantId); ``` Otherwise the base class implementation `ServerParameter::set` is used. It invokes `setFromString` using a string representation of `val`, if the `val` is @@ -176,7 +176,7 @@ holding one of the supported types. `override_validate`: If `true`, the implementer must provide a `validate` member function as: ```cpp -Status {name}::validate(const BSONElement& newValueElement); +Status {name}::validate(const BSONElement& newValueElement, const boost::optional<TenantId>& tenantId); ``` Otherwise, the base class implementation `ServerParameter::validate` is used. This simply returns `Status::OK()` without performing any kind of validation of the new BSON element. @@ -186,12 +186,12 @@ injects a placeholder value. If `param.redact` was not specified as `true`, then must be provided with the following signature: ```cpp -Status {name}::append(OperationContext*, BSONObjBuidler&, const std::string&); +Status {name}::append(OperationContext*, BSONObjBuilder*, StringData, const boost::optional<TenantId>& tenantId); ``` Lastly, a `setFromString` method must always be provided with the following signature: ```cpp -Status {name}::setFromString(const std::string& value); +Status {name}::setFromString(StringData value, const boost::optional<TenantId>& tenantId); ``` Each server parameter encountered will produce a block of code to run at process startup similar to |