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;
19use std::fmt::Formatter;
20
21use serde::Deserialize;
22use serde::Serialize;
23
24/// Config for Sqlite support.
25#[derive(Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
26#[serde(default)]
27#[non_exhaustive]
28pub struct SqliteConfig {
29    /// Set the connection_string of the sqlite service.
30    ///
31    /// This connection string is used to connect to the sqlite service.
32    ///
33    /// The format of connect string resembles the url format of the sqlite client:
34    ///
35    /// - `sqlite::memory:`
36    /// - `sqlite:data.db`
37    /// - `sqlite://data.db`
38    ///
39    /// For more information, please visit <https://docs.rs/sqlx/latest/sqlx/sqlite/struct.SqliteConnectOptions.html>.
40    pub connection_string: Option<String>,
41
42    /// Set the table name of the sqlite service to read/write.
43    pub table: Option<String>,
44    /// Set the key field name of the sqlite service to read/write.
45    ///
46    /// Default to `key` if not specified.
47    pub key_field: Option<String>,
48    /// Set the value field name of the sqlite service to read/write.
49    ///
50    /// Default to `value` if not specified.
51    pub value_field: Option<String>,
52    /// set the working directory, all operations will be performed under it.
53    ///
54    /// default: "/"
55    pub root: Option<String>,
56}
57
58impl Debug for SqliteConfig {
59    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
60        let mut d = f.debug_struct("SqliteConfig");
61
62        d.field("connection_string", &self.connection_string)
63            .field("table", &self.table)
64            .field("key_field", &self.key_field)
65            .field("value_field", &self.value_field)
66            .field("root", &self.root);
67
68        d.finish_non_exhaustive()
69    }
70}
opendal/services/sqlite/config.rs

opendal/services/sqlite/
config.rs
