1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
use std::collections::HashMap;
use std::fmt::Debug;
use std::fmt::Formatter;
use std::str::FromStr;
use std::sync::Arc;
use bb8::Pool;
use bb8_postgres::PostgresConnectionManager;
use serde::Deserialize;
use tokio::sync::OnceCell;
use tokio_postgres::Config;
use crate::raw::adapters::kv;
use crate::raw::*;
use crate::*;
/// Config for PostgreSQL services support.
#[derive(Default, Deserialize)]
#[serde(default)]
#[non_exhaustive]
pub struct PostgresqlConfig {
/// Root of this backend.
///
/// All operations will happen under this root.
///
/// Default to `/` if not set.
pub root: Option<String>,
/// the connection string of postgres server
connection_string: Option<String>,
/// the table of postgresql
table: Option<String>,
/// the key field of postgresql
key_field: Option<String>,
/// the value field of postgresql
value_field: Option<String>,
}
impl Debug for PostgresqlConfig {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
let mut d = f.debug_struct("PostgresqlConfig");
if self.connection_string.is_some() {
d.field("connection_string", &"<redacted>");
}
d.field("root", &self.root)
.field("table", &self.table)
.field("key_field", &self.key_field)
.field("value_field", &self.value_field)
.finish()
}
}
/// [PostgreSQL](https://www.postgresql.org/) services support.
#[doc = include_str!("docs.md")]
#[derive(Default)]
pub struct PostgresqlBuilder {
config: PostgresqlConfig,
}
impl Debug for PostgresqlBuilder {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
let mut d = f.debug_struct("PostgresqlBuilder");
d.field("config", &self.config);
d.finish()
}
}
impl PostgresqlBuilder {
/// Set the connection_string of the postgresql service.
///
/// This connection string is `libpq-style connection strings`. There are two formats:
///
/// ## Key Value
///
/// This format consists of space-separated key-value pairs. Values which are either the empty
/// string or contain whitespace should be wrapped in '. ' and \ characters should be
/// backslash-escaped.
///
/// - `host=localhost user=postgres connect_timeout=10 keepalives=0`
/// - `host=/var/lib/postgresql,localhost port=1234 user=postgres password='password with spaces'`
/// - `host=host1,host2,host3 port=1234,,5678 user=postgres target_session_attrs=read-write`
///
/// Available keys could found at: <https://docs.rs/postgres/latest/postgres/config/struct.Config.html>
///
/// ## Url
///
/// This format resembles a URL with a scheme of either `postgres://` or `postgresql://`.
///
/// - `postgresql://user@localhost`
/// - `postgresql://user:password@%2Fvar%2Flib%2Fpostgresql/mydb?connect_timeout=10`
/// - `postgresql://user@host1:1234,host2,host3:5678?target_session_attrs=read-write`
/// - `postgresql:///mydb?user=user&host=/var/lib/postgresql`
///
/// # Notes
///
/// If connection_string has been specified, other parameters will be ignored.
///
/// For more information, please visit <https://docs.rs/postgres/latest/postgres/config/struct.Config.html>
pub fn connection_string(&mut self, v: &str) -> &mut Self {
if !v.is_empty() {
self.config.connection_string = Some(v.to_string());
}
self
}
/// set the working directory, all operations will be performed under it.
///
/// default: "/"
pub fn root(&mut self, root: &str) -> &mut Self {
if !root.is_empty() {
self.config.root = Some(root.to_owned());
}
self
}
/// Set the table name of the postgresql service to read/write.
pub fn table(&mut self, table: &str) -> &mut Self {
if !table.is_empty() {
self.config.table = Some(table.to_string());
}
self
}
/// Set the key field name of the postgresql service to read/write.
///
/// Default to `key` if not specified.
pub fn key_field(&mut self, key_field: &str) -> &mut Self {
if !key_field.is_empty() {
self.config.key_field = Some(key_field.to_string());
}
self
}
/// Set the value field name of the postgresql service to read/write.
///
/// Default to `value` if not specified.
pub fn value_field(&mut self, value_field: &str) -> &mut Self {
if !value_field.is_empty() {
self.config.value_field = Some(value_field.to_string());
}
self
}
}
impl Builder for PostgresqlBuilder {
const SCHEME: Scheme = Scheme::Postgresql;
type Accessor = PostgresqlBackend;
fn from_map(map: HashMap<String, String>) -> Self {
let config = PostgresqlConfig::deserialize(ConfigDeserializer::new(map))
.expect("config deserialize must succeed");
PostgresqlBuilder { config }
}
fn build(&mut self) -> Result<Self::Accessor> {
let conn = match self.config.connection_string.clone() {
Some(v) => v,
None => {
return Err(
Error::new(ErrorKind::ConfigInvalid, "connection_string is empty")
.with_context("service", Scheme::Postgresql),
)
}
};
let config = Config::from_str(&conn).map_err(|err| {
Error::new(ErrorKind::ConfigInvalid, "connection_string is invalid")
.with_context("service", Scheme::Postgresql)
.set_source(err)
})?;
let table = match self.config.table.clone() {
Some(v) => v,
None => {
return Err(Error::new(ErrorKind::ConfigInvalid, "table is empty")
.with_context("service", Scheme::Postgresql))
}
};
let key_field = match self.config.key_field.clone() {
Some(v) => v,
None => "key".to_string(),
};
let value_field = match self.config.value_field.clone() {
Some(v) => v,
None => "value".to_string(),
};
let root = normalize_root(
self.config
.root
.clone()
.unwrap_or_else(|| "/".to_string())
.as_str(),
);
Ok(PostgresqlBackend::new(Adapter {
pool: OnceCell::new(),
config,
table,
key_field,
value_field,
})
.with_root(&root))
}
}
/// Backend for Postgresql service
pub type PostgresqlBackend = kv::Backend<Adapter>;
#[derive(Clone)]
pub struct Adapter {
pool: OnceCell<Arc<Pool<PostgresConnectionManager<tokio_postgres::NoTls>>>>,
config: Config,
table: String,
key_field: String,
value_field: String,
}
impl Debug for Adapter {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
let mut ds = f.debug_struct("Adapter");
ds.finish_non_exhaustive()
}
}
impl Adapter {
async fn get_client(&self) -> Result<&Pool<PostgresConnectionManager<tokio_postgres::NoTls>>> {
self.pool
.get_or_try_init(|| async {
// TODO: add tls support.
let manager =
PostgresConnectionManager::new(self.config.clone(), tokio_postgres::NoTls);
let pool = Pool::builder()
.build(manager)
.await
.map_err(parse_postgre_error)?;
Ok(Arc::new(pool))
})
.await
.map(|v| v.as_ref())
}
}
impl kv::Adapter for Adapter {
fn metadata(&self) -> kv::Metadata {
kv::Metadata::new(
Scheme::Postgresql,
&self.table,
Capability {
read: true,
write: true,
..Default::default()
},
)
}
async fn get(&self, path: &str) -> Result<Option<Buffer>> {
let query = format!(
"SELECT {} FROM {} WHERE {} = $1 LIMIT 1",
self.value_field, self.table, self.key_field
);
let connection = self
.get_client()
.await?
.get()
.await
.map_err(parse_bb8_error)?;
let statement = connection
.prepare(&query)
.await
.map_err(parse_postgre_error)?;
let rows = connection
.query(&statement, &[&path])
.await
.map_err(parse_postgre_error)?;
if rows.is_empty() {
return Ok(None);
}
let value: Vec<u8> = rows[0].get(0);
Ok(Some(Buffer::from(value)))
}
async fn set(&self, path: &str, value: Buffer) -> Result<()> {
let table = &self.table;
let key_field = &self.key_field;
let value_field = &self.value_field;
let query = format!(
"INSERT INTO {table} ({key_field}, {value_field}) \
VALUES ($1, $2) \
ON CONFLICT ({key_field}) \
DO UPDATE SET {value_field} = EXCLUDED.{value_field}",
);
let connection = self
.get_client()
.await?
.get()
.await
.map_err(parse_bb8_error)?;
let statement = connection
.prepare(&query)
.await
.map_err(parse_postgre_error)?;
let _ = connection
.query(&statement, &[&path, &value.to_vec()])
.await
.map_err(parse_postgre_error)?;
Ok(())
}
async fn delete(&self, path: &str) -> Result<()> {
let query = format!("DELETE FROM {} WHERE {} = $1", self.table, self.key_field);
let connection = self
.get_client()
.await?
.get()
.await
.map_err(parse_bb8_error)?;
let statement = connection
.prepare(&query)
.await
.map_err(parse_postgre_error)?;
let _ = connection
.query(&statement, &[&path])
.await
.map_err(parse_postgre_error)?;
Ok(())
}
}
fn parse_bb8_error(err: bb8::RunError<tokio_postgres::Error>) -> Error {
Error::new(ErrorKind::Unexpected, "unhandled error from postgresql").set_source(err)
}
fn parse_postgre_error(err: tokio_postgres::Error) -> Error {
Error::new(ErrorKind::Unexpected, "unhandled error from postgresql").set_source(err)
}