opendal/services/d1/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 [Cloudflare D1](https://developers.cloudflare.com/d1) backend support.
25#[derive(Default, Serialize, Deserialize, Clone, PartialEq, Eq)]
26#[serde(default)]
27#[non_exhaustive]
28pub struct D1Config {
29 /// Set the token of cloudflare api.
30 pub token: Option<String>,
31 /// Set the account id of cloudflare api.
32 pub account_id: Option<String>,
33 /// Set the database id of cloudflare api.
34 pub database_id: Option<String>,
35
36 /// Set the working directory of OpenDAL.
37 pub root: Option<String>,
38 /// Set the table of D1 Database.
39 pub table: Option<String>,
40 /// Set the key field of D1 Database.
41 pub key_field: Option<String>,
42 /// Set the value field of D1 Database.
43 pub value_field: Option<String>,
44}
45
46impl Debug for D1Config {
47 fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
48 let mut ds = f.debug_struct("D1Config");
49 ds.field("root", &self.root);
50 ds.field("table", &self.table);
51 ds.field("key_field", &self.key_field);
52 ds.field("value_field", &self.value_field);
53 ds.finish_non_exhaustive()
54 }
55}