opendal/services/mysql/
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 Mysql services support.
25#[derive(Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
26#[serde(default)]
27#[non_exhaustive]
28pub struct MysqlConfig {
29    /// This connection string is used to connect to the mysql service. There are url based formats.
30    ///
31    /// The format of connect string resembles the url format of the mysql client.
32    /// The format is: `[scheme://][user[:[password]]@]host[:port][/schema][?attribute1=value1&attribute2=value2...`
33    ///
34    /// - `mysql://user@localhost`
35    /// - `mysql://user:password@localhost`
36    /// - `mysql://user:password@localhost:3306`
37    /// - `mysql://user:password@localhost:3306/db`
38    ///
39    /// For more information, please refer to <https://docs.rs/sqlx/latest/sqlx/mysql/struct.MySqlConnectOptions.html>.
40    pub connection_string: Option<String>,
41
42    /// The table name for mysql.
43    pub table: Option<String>,
44    /// The key field name for mysql.
45    pub key_field: Option<String>,
46    /// The value field name for mysql.
47    pub value_field: Option<String>,
48    /// The root for mysql.
49    pub root: Option<String>,
50}
51
52impl Debug for MysqlConfig {
53    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
54        let mut d = f.debug_struct("MysqlConfig");
55
56        if self.connection_string.is_some() {
57            d.field("connection_string", &"<redacted>");
58        }
59
60        d.field("root", &self.root)
61            .field("table", &self.table)
62            .field("key_field", &self.key_field)
63            .field("value_field", &self.value_field)
64            .finish()
65    }
66}
opendal/services/mysql/config.rs

opendal/services/mysql/
config.rs
