diff options
| author | Hui Xiao <huixiao@fb.com> | 2024-07-02 13:15:00 -0700 |
|---|---|---|
| committer | Facebook GitHub Bot <facebook-github-bot@users.noreply.github.com> | 2024-07-02 13:15:00 -0700 |
| commit | 1f589a3f730c3013b6b80373471b0cd2ae8fde1a (patch) | |
| tree | 340563f6f844b28f3346b7d5a03e6386af216e36 /include | |
| parent | de16611a50508b6f43a14f788b044f23121363e2 (diff) | |
Clarify GetProperty API doc (#12829)
Summary:
**Context/Summary:** as titled since https://github.com/facebook/rocksdb/blob/9eebaf11cbd875435b572f05f0378ecdb761cc74/db/internal_stats.cc#L1162.
Pull Request resolved: https://github.com/facebook/rocksdb/pull/12829
Test Plan: no code change
Reviewed By: pdillinger
Differential Revision: D59243565
Pulled By: hx235
fbshipit-source-id: 074137b29bb12d9d965d154626a3289f85a39c52
Diffstat (limited to 'include')
| -rw-r--r-- | include/rocksdb/db.h | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/include/rocksdb/db.h b/include/rocksdb/db.h index b2648ecc7..f6af49b56 100644 --- a/include/rocksdb/db.h +++ b/include/rocksdb/db.h @@ -1334,9 +1334,10 @@ class DB { // DB implementations export properties about their state via this method. // If "property" is a valid "string" property understood by this DB - // implementation (see Properties struct above for valid options), fills - // "*value" with its current value and returns true. Otherwise, returns - // false. + // implementation (see Properties struct above for valid options) and the DB + // is able to get and fill "*value" with its current value, then return true. + // In all the other cases (e.g, "property" is an invalid "string" property, IO + // errors ..), it returns false. virtual bool GetProperty(ColumnFamilyHandle* column_family, const Slice& property, std::string* value) = 0; virtual bool GetProperty(const Slice& property, std::string* value) { |