opendal/services/sqlite/
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::SqliteBuilder;
24
25/// Config for Sqlite support.
26#[derive(Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
27#[serde(default)]
28#[non_exhaustive]
29pub struct SqliteConfig {
30    /// Set the connection_string of the sqlite service.
31    ///
32    /// This connection string is used to connect to the sqlite service.
33    ///
34    /// The format of connect string resembles the url format of the sqlite client:
35    ///
36    /// - `sqlite::memory:`
37    /// - `sqlite:data.db`
38    /// - `sqlite://data.db`
39    ///
40    /// For more information, please visit <https://docs.rs/sqlx/latest/sqlx/sqlite/struct.SqliteConnectOptions.html>.
41    pub connection_string: Option<String>,
42
43    /// Set the table name of the sqlite service to read/write.
44    pub table: Option<String>,
45    /// Set the key field name of the sqlite service to read/write.
46    ///
47    /// Default to `key` if not specified.
48    pub key_field: Option<String>,
49    /// Set the value field name of the sqlite service to read/write.
50    ///
51    /// Default to `value` if not specified.
52    pub value_field: Option<String>,
53    /// set the working directory, all operations will be performed under it.
54    ///
55    /// default: "/"
56    pub root: Option<String>,
57}
58
59impl Debug for SqliteConfig {
60    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
61        f.debug_struct("SqliteConfig")
62            .field("table", &self.table)
63            .field("key_field", &self.key_field)
64            .field("value_field", &self.value_field)
65            .field("root", &self.root)
66            .finish_non_exhaustive()
67    }
68}
69
70impl crate::Configurator for SqliteConfig {
71    type Builder = SqliteBuilder;
72
73    fn from_uri(uri: &crate::types::OperatorUri) -> crate::Result<Self> {
74        let mut map = uri.options().clone();
75
76        if let Some(authority) = uri.authority() {
77            map.entry("connection_string".to_string())
78                .or_insert_with(|| format!("sqlite://{authority}"));
79        }
80
81        if let Some(path) = uri.root() {
82            if !path.is_empty() {
83                let (table, rest) = match path.split_once('/') {
84                    Some((table, remainder)) => (table, Some(remainder)),
85                    None => (path, None),
86                };
87
88                if !table.is_empty() {
89                    map.entry("table".to_string())
90                        .or_insert_with(|| table.to_string());
91                }
92
93                if let Some(root) = rest {
94                    if !root.is_empty() {
95                        map.insert("root".to_string(), root.to_string());
96                    }
97                }
98            }
99        }
100
101        Self::from_iter(map)
102    }
103
104    fn into_builder(self) -> Self::Builder {
105        SqliteBuilder { config: self }
106    }
107}
108
109#[cfg(test)]
110mod tests {
111    use super::*;
112    use crate::Configurator;
113    use crate::types::OperatorUri;
114
115    #[test]
116    fn from_uri_sets_connection_string_table_and_root() {
117        let uri =
118            OperatorUri::new("sqlite://data.db/kv/cache", Vec::<(String, String)>::new()).unwrap();
119
120        let cfg = SqliteConfig::from_uri(&uri).unwrap();
121        assert_eq!(cfg.connection_string.as_deref(), Some("sqlite://data.db"));
122        assert_eq!(cfg.table.as_deref(), Some("kv"));
123        assert_eq!(cfg.root.as_deref(), Some("cache"));
124    }
125}
opendal/services/sqlite/config.rs

opendal/services/sqlite/
config.rs
