Xingbo Wang
c9252b9ac0
Summary: We have seen multiple coding error with the usage of WideColumn API. Hence, improving the documentation to reduce the chance of this happening again. Clarify that `WideColumn` and `WideColumns` are non-owning views over caller-managed memory. Update the public `PutEntity()` API documentation to state that column name and value storage must remain valid until the call returns. Add safe and unsafe usage examples in `wide_columns.h` to make lifetime requirements explicit. ## Testing Not run. Documentation-only change. Pull Request resolved: https://github.com/facebook/rocksdb/pull/14626 Reviewed By: archang19 Differential Revision: D101280295 Pulled By: xingbowang fbshipit-source-id: 076103321f1d54103dd1c2772aa9e84affdfd2ad
RocksDB: A Persistent Key-Value Store for Flash and RAM Storage
RocksDB is developed and maintained by Facebook Database Engineering Team. It is built on earlier work on LevelDB by Sanjay Ghemawat (sanjay@google.com) and Jeff Dean (jeff@google.com)
This code is a library that forms the core building block for a fast key-value server, especially suited for storing data on flash drives. It has a Log-Structured-Merge-Database (LSM) design with flexible tradeoffs between Write-Amplification-Factor (WAF), Read-Amplification-Factor (RAF) and Space-Amplification-Factor (SAF). It has multi-threaded compactions, making it especially suitable for storing multiple terabytes of data in a single database.
Start with example usage here: https://github.com/facebook/rocksdb/tree/main/examples
See the github wiki for more explanation.
The public interface is in include/. Callers should not include or
rely on the details of any other header files in this package. Those
internal APIs may be changed without warning.
Questions and discussions are welcome on the RocksDB Developers Public Facebook group and email list on Google Groups.
License
RocksDB is dual-licensed under both the GPLv2 (found in the COPYING file in the root directory) and Apache 2.0 License (found in the LICENSE.Apache file in the root directory). You may select, at your option, one of the above-listed licenses.