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
pub use crate::config::ConfigError;
use crate::ConnectionInfo;
use super::{CreatePoolError, Pool, PoolBuilder, PoolConfig, Runtime};
/// Configuration object.
///
/// # Example (from environment)
///
/// By enabling the `serde` feature you can read the configuration using the
/// [`config`](https://crates.io/crates/config) crate as following:
/// ```env
/// REDIS_CLUSTER__URLS=redis://127.0.0.1:7000,redis://127.0.0.1:7001
/// REDIS_CLUSTER__READ_FROM_REPLICAS=true
/// REDIS_CLUSTER__POOL__MAX_SIZE=16
/// REDIS_CLUSTER__POOL__TIMEOUTS__WAIT__SECS=2
/// REDIS_CLUSTER__POOL__TIMEOUTS__WAIT__NANOS=0
/// ```
/// ```rust
/// #[derive(serde::Deserialize)]
/// struct Config {
/// redis_cluster: deadpool_redis::cluster::Config,
/// }
///
/// impl Config {
/// pub fn from_env() -> Result<Self, config::ConfigError> {
/// let mut cfg = config::Config::builder()
/// .add_source(
/// config::Environment::default()
/// .separator("__")
/// .try_parsing(true)
/// .list_separator(","),
/// )
/// .build()?;
/// cfg.try_deserialize()
/// }
/// }
/// ```
#[derive(Clone, Debug)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize, serde::Serialize))]
pub struct Config {
/// Redis URLs.
///
/// See [Connection Parameters](redis#connection-parameters).
pub urls: Option<Vec<String>>,
/// [`redis::ConnectionInfo`] structures.
pub connections: Option<Vec<ConnectionInfo>>,
/// Pool configuration.
pub pool: Option<PoolConfig>,
/// Enables or disables reading from replica nodes in a Redis cluster.
///
/// When set to `true`, read operations may be distributed across
/// replica nodes, which can help in load balancing read requests.
/// When set to `false`, all read operations will be directed to the
/// master node(s). This option is particularly useful in a high-availability
/// setup where read scalability is needed.
///
/// Default is `false`.
#[cfg_attr(feature = "serde", serde(default))]
pub read_from_replicas: bool,
}
impl Config {
/// Creates a new [`Pool`] using this [`Config`].
///
/// # Errors
///
/// See [`CreatePoolError`] for details.
pub fn create_pool(&self, runtime: Option<Runtime>) -> Result<Pool, CreatePoolError> {
let mut builder = self.builder().map_err(CreatePoolError::Config)?;
if let Some(runtime) = runtime {
builder = builder.runtime(runtime);
}
builder.build().map_err(CreatePoolError::Build)
}
/// Creates a new [`PoolBuilder`] using this [`Config`].
///
/// # Errors
///
/// See [`ConfigError`] for details.
pub fn builder(&self) -> Result<PoolBuilder, ConfigError> {
let manager = match (&self.urls, &self.connections) {
(Some(urls), None) => super::Manager::new(
urls.iter().map(|url| url.as_str()).collect(),
self.read_from_replicas,
)?,
(None, Some(connections)) => {
super::Manager::new(connections.clone(), self.read_from_replicas)?
}
(None, None) => {
super::Manager::new(vec![ConnectionInfo::default()], self.read_from_replicas)?
}
(Some(_), Some(_)) => return Err(ConfigError::UrlAndConnectionSpecified),
};
let pool_config = self.get_pool_config();
Ok(Pool::builder(manager).config(pool_config))
}
/// Returns [`deadpool::managed::PoolConfig`] which can be used to construct
/// a [`deadpool::managed::Pool`] instance.
#[must_use]
pub fn get_pool_config(&self) -> PoolConfig {
self.pool.unwrap_or_default()
}
/// Creates a new [`Config`] from the given Redis URL (like
/// `redis://127.0.0.1`).
#[must_use]
pub fn from_urls<T: Into<Vec<String>>>(urls: T) -> Config {
Config {
urls: Some(urls.into()),
connections: None,
pool: None,
read_from_replicas: false,
}
}
}
impl Default for Config {
fn default() -> Self {
Self {
urls: None,
connections: Some(vec![ConnectionInfo::default()]),
pool: None,
read_from_replicas: false,
}
}
}