Merge pull request #11 from skytable/pool

Implement connection pooling

Author: ohsayan

.github/workflows/release.yml

@@ -0,0 +1,12 @@
+name: Publish crate
+on: [release]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Publish
+        run: |
+          cargo login ${{ secrets.CARGO_TOKEN }}
+          cargo publish

.github/workflows/test.yml

@@ -16,9 +16,9 @@ jobs:
           cargo build --verbose --no-default-features --features sync
           cargo build --verbose --no-default-features --features sync,ssl
           cargo build --verbose --no-default-features --features sync,sslv
-          cargo build --verbose --no-default-features --features async
-          cargo build --verbose --no-default-features --features async,aio-ssl
-          cargo build --verbose --no-default-features --features async,aio-sslv
+          cargo build --verbose --no-default-features --features aio
+          cargo build --verbose --no-default-features --features aio,aio-ssl
+          cargo build --verbose --no-default-features --features aio,aio-sslv
           cargo build --verbose --no-default-features --features dbg
           cargo build --verbose --no-default-features --features const-gen
       - name: Run tests

.gitignore

@@ -3,3 +3,4 @@ Cargo.lock
 .vscode
 .DS_Store
 examples/target
+scripts

CHANGELOG.md

@@ -2,12 +2,18 @@
 
 All changes in this project will be noted in this file.
 
-## Unreleased
+## 0.7.0
+
+### New features
+
+- Sync connection pooling
+- Async connection pooling
 
 ### Breaking changes
 
 - `SkyRawResult` is now `SkyResult`
 - `SkyResult` is now `SkyQueryResult`
+- The feature `async` is now `aio`
 
 ## Version 0.6.2
 

Cargo.toml

@@ -9,20 +9,27 @@ license = "Apache-2.0"
 name = "skytable"
 readme = "README.md"
 repository = "https://github.com/skytable/client-rust"
-version = "0.6.2"
+version = "0.6.3"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [features]
+default = ["sync"]
+# sync
+sync = ["pool"]
+pool = ["r2d2"]
+# sync TLS
+ssl = ["openssl"]
+sslv = ["openssl/vendored"]
+# async
+aio = ["bytes", "tokio", "aio-pool"]
+aio-pool = ["bb8", "async-trait"]
+# async TLS
 aio-ssl = ["tokio-openssl", "openssl"]
 aio-sslv = ["tokio-openssl", "openssl/vendored"]
-async = ["bytes", "tokio"]
+# utilities
 const-gen = []
 dbg = []
-default = ["sync"]
-ssl = ["openssl"]
-sslv = ["openssl/vendored"]
-sync = []
 
 [dependencies]
 bytes = { version = "1.1.0", optional = true }
@@ -33,6 +40,13 @@ tokio = { version = "1.15.0", features = [
     "io-std",
 ], optional = true }
 tokio-openssl = { version = "0.6.3", optional = true }
+r2d2 = { version = "0.8.9", optional = true }
+bb8 = { version = "0.7.1", optional = true }
+async-trait = { version = "0.1.52", optional = true }
+
+[dev-dependencies]
+tokio = { version = "1.16.1", features = ["test-util", "macros"] }
+
 [package.metadata.docs.rs]
 all-features = true
 rustdoc-args = ["--cfg", "docsrs"]

README.md

@@ -7,7 +7,16 @@ This library is the official client for the free and open-source NoSQL database
 following the instructions [here](https://docs.skytable.io/getting-started). This library supports
 all Skytable versions that work with the [Skyhash 1.1 Protocol](https://docs.skytable.io/protocol/skyhash).
 This version of the library was tested with the latest Skytable release
-(release [0.7.2-alpha.1](https://github.com/skytable/skytable/releases/v0.7.2-alpha.1)).
+(release [0.7.2](https://github.com/skytable/skytable/releases/v0.7.2)).
+
+## Features
+
+- Sync API
+- Async API
+- TLS in both sync/async APIs
+- Connection pooling for sync/async
+- Use both sync/async APIs at the same time
+- Always up-to-date
 
 ## Using this library
 
@@ -26,7 +35,7 @@ cargo new skyapp
 First add this to your `Cargo.toml` file:
 
 ```toml
-skytable = "0.6.2"
+skytable = "0.6.3"
 ```
 
 Now open up your `src/main.rs` file and establish a connection to the server while also adding some
@@ -88,7 +97,7 @@ Way to go — you're all set! Now go ahead and run more advanced queries!
 
 The `default:default` keyspace has the following declaration:
 
-```
+```text
 Keymap { data:(binstr,binstr), volatile:false }
 ```
 
@@ -108,17 +117,22 @@ assert!(con.set("bindata", mybinarydata).unwrap());
 
 ## Going advanced
 
-Now that you know how you can run basic queries, check out the `actions` module documentation for learning
-to use actions and the `types` module documentation for implementing your own Skyhash serializable
-types. Need to meddle with DDL queries like creating and dropping tables? Check out the `ddl` module.
-You can also find the [latest examples here](https://github.com/skytable/client-rust/tree/next/examples)
+Now that you know how you can run basic queries, check out the [`actions`] module documentation for learning
+to use actions and the [`types`] module documentation for implementing your own Skyhash serializable
+types. Need to meddle with DDL queries like creating and dropping tables? Check out the [`ddl`] module.
+You can also find some [examples here](https://github.com/skytable/client-rust/tree/v0.7.0-alpha.1/examples)
+
+## Connection pooling
+
+This library supports using sync/async connection pools. See the [`pool`] module-level documentation for examples
+and information.
 
 ## Async API
 
 If you need to use an `async` API, just change your import to:
 
 ```toml
-skytable = { version = "0.6.2", features=["async"], default-features = false }
+skytable = { version = "0.6.3", features=["aio"], default-features = false }
 ```
 
 You can now establish a connection by using `skytable::AsyncConnection::new()`, adding `.await`s wherever
@@ -130,7 +144,7 @@ With this client driver, it is possible to use both sync and `async` APIs **at t
 this, simply change your import to:
 
 ```toml
-skytable = { version="0.6.2", features=["sync", "async"] }
+skytable = { version="0.6.3", features=["sync", "aio"] }
 ```
 
 ## TLS
@@ -140,15 +154,15 @@ If you need to use TLS features, this crate will let you do so with OpenSSL.
 ### Using TLS with sync interfaces
 
 ```toml
-skytable = { version="0.6.2", features=["sync","ssl"] }
+skytable = { version="0.6.3", features=["sync","ssl"] }
 ```
 
 You can now use the async `sync::TlsConnection` object.
 
 ### Using TLS with async interfaces
 
 ```toml
-skytable = { version="0.6.2", features=["async","aio-ssl"], default-features=false }
+skytable = { version="0.6.3", features=["aio","aio-ssl"], default-features=false }
 ```
 
 You can now use the async `aio::TlsConnection` object.

examples/aio/Cargo.toml

@@ -8,6 +8,6 @@ edition = "2018"
 [dependencies]
 skytable = { git="https://github.com/skytable/client-rust.git", features = [
     "const-gen",
-    "async",
+    "aio",
 ], default-features = false }
 tokio = { version = "1.10.0", features = ["full"] }

src/actions.rs

@@ -52,12 +52,10 @@ use crate::SkyQueryResult;
 use crate::SkyResult;
 
 cfg_async!(
-    use core::{future::Future, pin::Pin};
+    use crate::AsyncResult;
 );
 
 cfg_async!(
-    /// A special result that is returned when running actions (async)
-    pub type AsyncResult<'s, T> = Pin<Box<dyn Future<Output = T> + Send + Sync + 's>>;
     #[doc(hidden)]
     /// A raw async connection to the database server
     pub trait AsyncSocket: Send + Sync {
@@ -111,8 +109,8 @@ macro_rules! implement_actions {
                 }
             )*
         }
-        #[cfg(feature = "async")]
-        #[cfg_attr(docsrs, doc(cfg(feature = "async")))]
+        #[cfg(feature = "aio")]
+        #[cfg_attr(docsrs, doc(cfg(feature = "aio")))]
         /// Actions that can be run on an [`AsyncSocket`] connection
         pub trait AsyncActions: AsyncSocket {
             $(

src/aio.rs

@@ -25,7 +25,6 @@
 //!
 
 use crate::deserializer::{ParseError, Parser, RawResponse};
-use crate::error::Error;
 use crate::error::SkyhashError;
 use crate::Element;
 use crate::IoResult;
@@ -110,7 +109,7 @@ macro_rules! impl_async_methods {
             }
         }
         impl crate::actions::AsyncSocket for $ty {
-            fn run(&mut self, q: Query) -> crate::actions::AsyncResult<SkyQueryResult> {
+            fn run(&mut self, q: Query) -> crate::AsyncResult<SkyQueryResult> {
                 Box::pin(async move { self.run_simple_query(&q).await })
             }
         }
@@ -141,6 +140,7 @@ cfg_async_ssl_any!(
     use tokio_openssl::SslStream;
     use openssl::ssl::{SslContext, SslMethod, Ssl};
     use core::pin::Pin;
+    use crate::error::Error;
 
     /// An asynchronous database connection over Skyhash/TLS
     pub struct TlsConnection {

src/ddl.rs

@@ -43,7 +43,7 @@ use crate::RespCode;
 use crate::SkyResult;
 
 cfg_async! {
-    use crate::actions::AsyncResult;
+    use crate::AsyncResult;
     use crate::actions::AsyncSocket;
 }
 
@@ -187,8 +187,8 @@ macro_rules! implement_ddl {
                 }
             )*
         }
-        #[cfg(feature = "async")]
-        #[cfg_attr(docsrs, doc(cfg(feature = "async")))]
+        #[cfg(feature = "aio")]
+        #[cfg_attr(docsrs, doc(cfg(feature = "aio")))]
         /// [DDL queries](https://docs.skytable.io/ddl) that can be run on async socket
         /// connections
         pub trait AsyncDdl: AsyncSocket {