opendal/services/redb/
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 std::fmt::Debug;
19
20use serde::Deserialize;
21use serde::Serialize;
22
23use super::backend::RedbBuilder;
24
25/// Config for redb service support.
26#[derive(Default, Debug, Serialize, Deserialize, Clone, PartialEq, Eq)]
27#[serde(default)]
28#[non_exhaustive]
29pub struct RedbConfig {
30    /// path to the redb data directory.
31    pub datadir: Option<String>,
32    /// The table name for redb.
33    pub table: Option<String>,
34    /// The root for redb.
35    pub root: Option<String>,
36}
37
38impl crate::Configurator for RedbConfig {
39    type Builder = RedbBuilder;
40
41    fn from_uri(uri: &crate::types::OperatorUri) -> crate::Result<Self> {
42        let mut map = uri.options().clone();
43
44        if let Some(path) = uri.root() {
45            if !path.is_empty() {
46                map.entry("datadir".to_string())
47                    .or_insert_with(|| format!("/{path}"));
48            }
49        }
50
51        Self::from_iter(map)
52    }
53
54    fn into_builder(self) -> Self::Builder {
55        RedbBuilder {
56            config: self,
57            database: None,
58        }
59    }
60}
61
62#[cfg(test)]
63mod tests {
64    use super::*;
65    use crate::Configurator;
66    use crate::types::OperatorUri;
67
68    #[test]
69    fn from_uri_sets_datadir_table_and_root() {
70        let uri = OperatorUri::new(
71            "redb:///tmp/redb?table=op_table&root=cache",
72            Vec::<(String, String)>::new(),
73        )
74        .unwrap();
75
76        let cfg = RedbConfig::from_uri(&uri).unwrap();
77        assert_eq!(cfg.datadir.as_deref(), Some("/tmp/redb"));
78        assert_eq!(cfg.table.as_deref(), Some("op_table"));
79        assert_eq!(cfg.root.as_deref(), Some("cache"));
80    }
81}