opendal/services/postgresql/
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 PostgreSQL services support.
25#[derive(Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
26#[serde(default)]
27#[non_exhaustive]
28pub struct PostgresqlConfig {
29    /// Root of this backend.
30    ///
31    /// All operations will happen under this root.
32    ///
33    /// Default to `/` if not set.
34    pub root: Option<String>,
35    /// The URL should be with a scheme of either `postgres://` or `postgresql://`.
36    ///
37    /// - `postgresql://user@localhost`
38    /// - `postgresql://user:password@%2Fvar%2Flib%2Fpostgresql/mydb?connect_timeout=10`
39    /// - `postgresql://user@host1:1234,host2,host3:5678?target_session_attrs=read-write`
40    /// - `postgresql:///mydb?user=user&host=/var/lib/postgresql`
41    ///
42    /// For more information, please visit <https://docs.rs/sqlx/latest/sqlx/postgres/struct.PgConnectOptions.html>.
43    pub connection_string: Option<String>,
44    /// the table of postgresql
45    pub table: Option<String>,
46    /// the key field of postgresql
47    pub key_field: Option<String>,
48    /// the value field of postgresql
49    pub value_field: Option<String>,
50}
51
52impl Debug for PostgresqlConfig {
53    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
54        let mut d = f.debug_struct("PostgresqlConfig");
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/postgresql/config.rs

opendal/services/postgresql/
config.rs
