Documented swimos_rocks_store.

Author: horned-sphere

runtime/swimos_rocks_store/src/lib.rs

@@ -12,13 +12,18 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+//! RocksDB Persistence
+//!
+//! An implementation of the [server persistence interface](swimos_api::persistence::ServerPersistence)
+//! using RocksDB as the persistence store.
+
 mod agent;
 mod engine;
 mod plane;
 mod server;
 
 pub use engine::RocksOpts;
-pub use server::{create_rocks_store, default_db_opts};
+pub use server::{default_db_opts, open_rocks_store};
 
 /// An enumeration over the keyspaces that exist in a store.
 #[derive(Debug, Copy, Clone, PartialEq, Eq)]

runtime/swimos_rocks_store/src/server/mod.rs

@@ -277,7 +277,13 @@ impl ServerPersistence for RocksServerPersistence {
     }
 }
 
-pub fn create_rocks_store(
+/// Open a RocksDB persistence store from a path in the local filesystem. If the specified database does
+/// not exist it will be crated.
+///
+/// # Arguments
+/// * `path` - The filesystem path to the database. If none is specified, a new database will be created in a temporary directory.
+/// * `options` - Configuration options for the database.
+pub fn open_rocks_store(
     path: Option<PathBuf>,
     options: RocksOpts,
 ) -> Result<impl ServerPersistence + Send + Sync + 'static, StoreError> {

runtime/swimos_rocks_store/src/server/rocks.rs

@@ -38,6 +38,7 @@ pub fn default_keyspaces() -> Keyspaces<RocksOpts> {
     Keyspaces::new(vec![lane_def, value_def, map_def])
 }
 
+/// Default RocksDB parameters.
 pub fn default_db_opts() -> RocksOpts {
     let mut rock_opts = Options::default();
     rock_opts.create_if_missing(true);