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
#![doc = include_str!("../README.md")]
#![warn(rust_2018_idioms, unreachable_pub)]
#![cfg_attr(docsrs, feature(doc_cfg))]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]
#[macro_use]
extern crate static_assertions;
use std::{collections::HashMap, sync::Arc, time::Duration};
use hyper::client::connect::HttpConnector;
#[cfg(feature = "tls")]
use hyper_tls::HttpsConnector;
pub use clickhouse_derive::Row;
pub use self::{compression::Compression, row::Row};
use self::{error::Result, http_client::HttpClient};
pub mod error;
pub mod insert;
pub mod inserter;
pub mod query;
pub mod serde;
pub mod sql;
#[cfg(feature = "test-util")]
pub mod test;
#[cfg(feature = "watch")]
pub mod watch;
#[cfg(feature = "uuid")]
#[doc(hidden)]
#[deprecated(since = "0.11.1", note = "use `clickhouse::serde::uuid` instead")]
pub mod uuid {
pub use crate::serde::uuid::*;
}
mod buflist;
mod compression;
mod cursor;
mod http_client;
mod response;
mod row;
mod rowbinary;
mod ticks;
const TCP_KEEPALIVE: Duration = Duration::from_secs(60);
// ClickHouse uses 3s by default.
// See https://github.com/ClickHouse/ClickHouse/blob/368cb74b4d222dc5472a7f2177f6bb154ebae07a/programs/server/config.xml#L201
const POOL_IDLE_TIMEOUT: Duration = Duration::from_secs(2);
/// A client containing HTTP pool.
/// Can be created by using `Client::default()` or [`Client::with_http_client`].
#[derive(Clone)]
pub struct Client {
client: Arc<dyn HttpClient>,
url: String,
database: Option<String>,
user: Option<String>,
password: Option<String>,
compression: Compression,
options: HashMap<String, String>,
}
impl Default for Client {
fn default() -> Self {
#[allow(unused_mut)]
let mut connector = HttpConnector::new();
// TODO: make configurable in `Client::builder()`.
connector.set_keepalive(Some(TCP_KEEPALIVE));
#[cfg(feature = "tls")]
let connector = HttpsConnector::new_with_connector({
connector.enforce_http(false);
connector
});
let client = hyper::Client::builder()
.pool_idle_timeout(POOL_IDLE_TIMEOUT)
.build(connector);
Self::with_http_client(client)
}
}
impl Client {
/// Creates a new client with a specified underlying HTTP client.
/// Now only [`hyper::Client`] is supported.
pub fn with_http_client(client: impl HttpClient) -> Self {
Self {
client: Arc::new(client),
url: String::new(),
database: None,
user: None,
password: None,
compression: Compression::default(),
options: HashMap::new(),
}
}
/// Specifies ClickHouse's url. Should point to HTTP endpoint.
///
/// # Examples
/// ```
/// # use clickhouse::Client;
/// let client = Client::default().with_url("http://localhost:8123");
/// ```
pub fn with_url(mut self, url: impl Into<String>) -> Self {
self.url = url.into();
self
}
/// Specifies a database name.
///
/// # Examples
/// ```
/// # use clickhouse::Client;
/// let client = Client::default().with_database("test");
/// ```
pub fn with_database(mut self, database: impl Into<String>) -> Self {
self.database = Some(database.into());
self
}
/// Specifies a user.
///
/// # Examples
/// ```
/// # use clickhouse::Client;
/// let client = Client::default().with_user("test");
/// ```
pub fn with_user(mut self, user: impl Into<String>) -> Self {
self.user = Some(user.into());
self
}
/// Specifies a password.
///
/// # Examples
/// ```
/// # use clickhouse::Client;
/// let client = Client::default().with_password("secret");
/// ```
pub fn with_password(mut self, password: impl Into<String>) -> Self {
self.password = Some(password.into());
self
}
/// Specifies a compression mode. See [`Compression`] for details.
/// By default, `Lz4` is used.
///
/// # Examples
/// ```
/// # use clickhouse::{Client, Compression};
/// # #[cfg(feature = "lz4")]
/// let client = Client::default().with_compression(Compression::Lz4Hc(4));
/// ```
pub fn with_compression(mut self, compression: Compression) -> Self {
self.compression = compression;
self
}
/// Used to specify options that will be passed to all queries.
///
/// # Example
/// ```
/// # use clickhouse::Client;
/// Client::default().with_option("allow_nondeterministic_mutations", "1");
/// ```
pub fn with_option(mut self, name: impl Into<String>, value: impl Into<String>) -> Self {
self.options.insert(name.into(), value.into());
self
}
/// Starts a new INSERT statement.
///
/// # Panics
/// If `T` has unnamed fields, e.g. tuples.
pub fn insert<T: Row>(&self, table: &str) -> Result<insert::Insert<T>> {
insert::Insert::new(self, table)
}
/// Creates an inserter to perform multiple INSERTs.
pub fn inserter<T: Row>(&self, table: &str) -> Result<inserter::Inserter<T>> {
inserter::Inserter::new(self, table)
}
/// Starts a new SELECT/DDL query.
pub fn query(&self, query: &str) -> query::Query {
query::Query::new(self, query)
}
/// Starts a new WATCH query.
#[cfg(feature = "watch")]
pub fn watch(&self, query: &str) -> watch::Watch {
watch::Watch::new(self, query)
}
}