Merge branch 'master' into fix/keylocation-contains

Author: Hoverbear

Cargo.toml

@@ -24,15 +24,13 @@ fxhash = "0.2"
 grpcio = { version = "0.5.0-alpha", features = [ "secure", "prost-codec" ], default-features = false }
 lazy_static = "0.2.1"
 log = "0.3.9"
-protobuf = "2"
 serde = "1.0"
 serde_derive = "1.0"
 tokio-core = "0.1"
 tokio-timer = "0.2"
 
 [dependencies.kvproto]
 git = "https://github.com/pingcap/kvproto.git"
-branch  = "raft-0.5.0"
 
 [dependencies.prometheus]
 version = "0.4.2"

examples/common/mod.rs

@@ -1,3 +1,5 @@
+// Copyright 2019 TiKV Project Authors. Licensed under Apache-2.0.
+
 use clap::{crate_version, App, Arg};
 use std::path::PathBuf;
 

examples/raw.rs

@@ -1,15 +1,4 @@
-// Copyright 2018 The TiKV Project Authors
-//
-// Licensed 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,
-// See the License for the specific language governing permissions and
-// limitations under the License.
+// Copyright 2018 TiKV Project Authors. Licensed under Apache-2.0.
 
 mod common;
 

examples/transaction.rs

@@ -1,15 +1,4 @@
-// Copyright 2018 The TiKV Project Authors
-//
-// Licensed 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,
-// See the License for the specific language governing permissions and
-// limitations under the License.
+// Copyright 2018 TiKV Project Authors. Licensed under Apache-2.0.
 
 mod common;
 

src/config.rs

@@ -0,0 +1,83 @@
+// Copyright 2019 TiKV Project Authors. Licensed under Apache-2.0.
+
+use serde_derive::{Deserialize, Serialize};
+use std::{path::PathBuf, time::Duration};
+
+/// The configuration for either a [`raw::Client`](raw/struct.Client.html) or a
+/// [`transaction::Client`](transaction/struct.Client.html).
+///
+/// Because TiKV is managed by a [PD](https://github.com/pingcap/pd/) cluster, the endpoints for PD
+/// must be provided, **not** the TiKV nodes.
+///
+/// It's important to **include more than one PD endpoint** (include all, if possible!)
+/// This helps avoid having a *single point of failure*.
+///
+/// By default, this client will use an insecure connection over instead of one protected by
+/// Transport Layer Security (TLS). Your deployment may have chosen to rely on security measures
+/// such as a private network, or a VPN layer to provid secure transmission.
+///
+/// To use a TLS secured connection, use the `with_security` function to set the required
+/// parameters.
+///
+/// TiKV does not currently offer encrypted storage (or encryption-at-rest).
+#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq)]
+#[serde(default)]
+#[serde(rename_all = "kebab-case")]
+pub struct Config {
+    pub(crate) pd_endpoints: Vec<String>,
+    pub(crate) ca_path: Option<PathBuf>,
+    pub(crate) cert_path: Option<PathBuf>,
+    pub(crate) key_path: Option<PathBuf>,
+    pub(crate) timeout: Duration,
+}
+
+const DEFAULT_REQUEST_TIMEOUT: Duration = Duration::from_secs(2);
+
+impl Config {
+    /// Create a new [`Config`](struct.Config.html) which coordinates with the given PD endpoints.
+    ///
+    /// It's important to **include more than one PD endpoint** (include all, if possible!)
+    /// This helps avoid having a *single point of failure*.
+    ///
+    /// ```rust
+    /// # use tikv_client::Config;
+    /// let config = Config::new(vec!["192.168.0.100:2379", "192.168.0.101:2379"]);
+    /// ```
+    pub fn new(pd_endpoints: impl IntoIterator<Item = impl Into<String>>) -> Self {
+        Config {
+            pd_endpoints: pd_endpoints.into_iter().map(Into::into).collect(),
+            ca_path: None,
+            cert_path: None,
+            key_path: None,
+            timeout: DEFAULT_REQUEST_TIMEOUT,
+        }
+    }
+
+    /// Set the certificate authority, certificate, and key locations for the
+    /// [`Config`](struct.Config.html).
+    ///
+    /// By default, TiKV connections do not utilize transport layer security. Enable it by setting
+    /// these values.
+    ///
+    /// ```rust
+    /// # use tikv_client::Config;
+    /// let config = Config::new(vec!["192.168.0.100:2379", "192.168.0.101:2379"])
+    ///     .with_security("root.ca", "internal.cert", "internal.key");
+    /// ```
+    pub fn with_security(
+        mut self,
+        ca_path: impl Into<PathBuf>,
+        cert_path: impl Into<PathBuf>,
+        key_path: impl Into<PathBuf>,
+    ) -> Self {
+        self.ca_path = Some(ca_path.into());
+        self.cert_path = Some(cert_path.into());
+        self.key_path = Some(key_path.into());
+        self
+    }
+
+    pub fn timeout(mut self, timeout: Duration) -> Self {
+        self.timeout = timeout;
+        self
+    }
+}

src/errors.rs

@@ -1,15 +1,5 @@
-// Copyright 2018 The TiKV Project Authors
-//
-// Licensed 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,
-// See the License for the specific language governing permissions and
-// limitations under the License.
+// Copyright 2018 TiKV Project Authors. Licensed under Apache-2.0.
+
 use failure::{Backtrace, Context, Fail};
 use grpcio;
 use std::fmt::{self, Display};