opendal/services/surrealdb/
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 Surrealdb services support.
25#[derive(Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
26#[serde(default)]
27#[non_exhaustive]
28pub struct SurrealdbConfig {
29    /// The connection string for surrealdb.
30    pub connection_string: Option<String>,
31    /// The username for surrealdb.
32    pub username: Option<String>,
33    /// The password for surrealdb.
34    pub password: Option<String>,
35    /// The namespace for surrealdb.
36    pub namespace: Option<String>,
37    /// The database for surrealdb.
38    pub database: Option<String>,
39    /// The table for surrealdb.
40    pub table: Option<String>,
41    /// The key field for surrealdb.
42    pub key_field: Option<String>,
43    /// The value field for surrealdb.
44    pub value_field: Option<String>,
45    /// The root for surrealdb.
46    pub root: Option<String>,
47}
48
49impl Debug for SurrealdbConfig {
50    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
51        let mut d = f.debug_struct("SurrealdbConfig");
52
53        d.field("connection_string", &self.connection_string)
54            .field("username", &self.username)
55            .field("password", &"<redacted>")
56            .field("namespace", &self.namespace)
57            .field("database", &self.database)
58            .field("table", &self.table)
59            .field("key_field", &self.key_field)
60            .field("value_field", &self.value_field)
61            .field("root", &self.root)
62            .finish()
63    }
64}
opendal/services/surrealdb/config.rs

opendal/services/surrealdb/
config.rs
