opendal_service_rocksdb/config.rs
1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements. See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership. The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License. You may obtain a copy of the License at
8//
9// http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied. See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18use opendal_core::*;
19use serde::Deserialize;
20use serde::Serialize;
21
22use super::backend::RocksdbBuilder;
23
24/// Config for Rocksdb Service.
25#[derive(Default, Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
26#[serde(default)]
27#[non_exhaustive]
28pub struct RocksdbConfig {
29 /// The path to the rocksdb data directory.
30 pub datadir: Option<String>,
31 /// the working directory of the service. Can be "/path/to/dir"
32 ///
33 /// default is "/"
34 pub root: Option<String>,
35}
36
37impl Configurator for RocksdbConfig {
38 type Builder = RocksdbBuilder;
39
40 fn from_uri(uri: &OperatorUri) -> Result<Self> {
41 let mut map = uri.options().clone();
42
43 if let Some(path) = uri.root()
44 && !path.is_empty()
45 {
46 map.entry("datadir".to_string())
47 .or_insert_with(|| format!("/{path}"));
48 }
49
50 Self::from_iter(map)
51 }
52
53 fn into_builder(self) -> Self::Builder {
54 RocksdbBuilder { config: self }
55 }
56}
57
58#[cfg(test)]
59mod tests {
60 use super::*;
61
62 #[test]
63 fn from_uri_sets_datadir_and_root() -> Result<()> {
64 let uri = OperatorUri::new(
65 "rocksdb:///var/db?root=namespace",
66 Vec::<(String, String)>::new(),
67 )?;
68
69 let cfg = RocksdbConfig::from_uri(&uri)?;
70 assert_eq!(cfg.datadir.as_deref(), Some("/var/db"));
71 assert_eq!(cfg.root.as_deref(), Some("namespace"));
72 Ok(())
73 }
74}