Add derive support

Author: ohsayan

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All changes in this project will be noted in this file.
 
+### 0.8.2
+
+Support deriving queries and responses.
+
 ### 0.8.1
 
 Fixed issues with documentation

Cargo.toml

@@ -9,10 +9,13 @@ license = "Apache-2.0"
 name = "skytable"
 readme = "README.md"
 repository = "https://github.com/skytable/client-rust"
-version = "0.8.1"
+version = "0.8.2"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 [dependencies]
+# internal deps
+sky-derive = "0.2.0"
+# external deps
 tokio = { version = "1.34.0", features = ["full"] }
 native-tls = "0.2.11"
 tokio-native-tls = "0.3.1"

README.md

@@ -2,23 +2,9 @@
 
 ## Introduction
 
-This library is the official client for the free and open-source NoSQL database
-[Skytable](https://github.com/skytable/skytable). First, go ahead and install Skytable by
-following the instructions [here](https://docs.skytable.io/getting-started). This library supports
-all Skytable versions that work with the [Skyhash 2 Protocol](https://docs.skytable.io/protocol/overview).
-This version of the library was tested with the latest Skytable release
-(release [0.8.0-beta](https://github.com/skytable/skytable/releases/v0.8.0-beta)).
+This library is the official client for the free and open-source NoSQL database [Skytable](https://github.com/skytable/skytable). First, go ahead and install Skytable by following the instructions [here](https://docs.skytable.io/getting-started). This library supports all Skytable versions that work with the [Skyhash 2 Protocol](https://docs.skytable.io/protocol/overview). This version of the library was tested with the latest Skytable release (release [0.8.0-beta](https://github.com/skytable/skytable/releases/v0.8.0-beta)).
 
-## 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
+## Definitive example
 
 This library only ships with the bare minimum that is required for interacting with Skytable. Once you have
 Skytable installed and running, you're ready to follow this guide!
@@ -41,22 +27,45 @@ skytable = "0.8"
 You're ready to go!
 
 ```rust
-use skytable::{Config, query};
+use skytable::{Query, Response, Config, query};
+
+#[derive(Query, Response)]
+#[derive(Clone, PartialEq, Debug)] // we just do these for the assert (they are not needed)
+struct User {
+    userid: String,
+    pass: String,
+    followers: u64,
+    email: Option<String>
+}
+
+let our_user = User { userid: "user".into(), pass: "pass".into(), followers: 120, email: None };
 
 let mut db = Config::new_default("username", "password").connect().unwrap();
-let query = query!("select username, password from myspace.mytbl WHERE username = ?", your_fn_to_get_user());
-let (username, password) = db.query_parse::<(String, String)>(&query).unwrap();
+
+// insert data
+let q = query!("insert into myspace.mymodel(?, ?, ?, ?)", our_user.clone());
+db.query_parse::<()>(&q).unwrap();
+
+// select data
+let user: User = db.query_parse(&query!("select * from myspace.mymodel where username = ?", &our_user.userid)).unwrap();
+assert_eq!(user, our_user);
 ```
 
 > **Read [docs here to learn BlueQL](https://docs.skytable.io/)**
 
+## 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
+
 ## Contributing
 
-Open-source, and contributions ... &mdash; they're always welcome! For ideas and suggestions,
-[create an issue on GitHub](https://github.com/skytable/client-rust/issues/new) and for patches,
-fork and open those pull requests [here](https://github.com/skytable/client-rust)!
+Open-source, and contributions ... &mdash; they're always welcome! For ideas and suggestions, [create an issue on GitHub](https://github.com/skytable/client-rust/issues/new) and for patches, fork and open those pull requests [here](https://github.com/skytable/client-rust)!
 
 ## License
 
-This client library is distributed under the permissive
-[Apache-2.0 License](https://github.com/skytable/client-rust/blob/next/LICENSE). Now go build great apps!
+This client library is distributed under the permissive [Apache-2.0 License](https://github.com/skytable/client-rust/blob/next/LICENSE). Now go build great apps!

src/lib.rs

@@ -21,6 +21,34 @@
 //! The client-driver is distributed under the liberal [Apache-2.0 License](https://www.apache.org/licenses/LICENSE-2.0) and hence
 //! you can use it in your applications without any licensing issues.
 //!
+//! ## Definitive example
+//!
+//! ```no_run
+//! use skytable::{Query, Response, Config, query};
+//!
+//! #[derive(Query, Response)]
+//! #[derive(Clone, PartialEq, Debug)] // we just do these for the assert (they are not needed)
+//! struct User {
+//!     userid: String,
+//!     pass: String,
+//!     followers: u64,
+//!     email: Option<String>
+//! }
+//!
+//! let our_user = User { userid: "user".into(), pass: "pass".into(), followers: 120, email: None };
+//!
+//! let mut db = Config::new_default("username", "password").connect().unwrap();
+//!
+//! // insert data
+//! let q = query!("insert into myspace.mymodel(?, ?, ?, ?)", our_user.clone());
+//! db.query_parse::<()>(&q).unwrap();
+//!
+//! // select data
+//! let user: User = db.query_parse(&query!("select * from myspace.mymodel where username = ?", &our_user.userid)).unwrap();
+//! assert_eq!(user, our_user);
+//!
+//! ```
+//!
 //! ## Getting started
 //!
 //! Make sure you have Skytable set up. If not, follow the [official installation guide here](https://docs.skytable.io/installation)
@@ -65,6 +93,9 @@
 //!
 //! ## Going advanced
 //!
+//! You can use the [`macro@Query`] and [`macro@Response`] derive macros to directly pass complex types as parameters
+//! and read as responses. This should cover most of the general use-cases (otherwise you can manually implement them).
+//!
 //! - Custom [`mod@query`] generation
 //! - Custom [`response`] parsing
 //! - [`Connection pooling`](pool)
@@ -88,6 +119,10 @@ pub mod query;
 pub mod response;
 pub mod syncio;
 // re-exports
+/// The `Query` derive macro enables you to directly pass complex types as parameters into queries
+pub use sky_derive::Query;
+/// The `Response` derive macro enables you to directly pass complex types as parameters into queries
+pub use sky_derive::Response;
 pub use {
     aio::{ConnectionAsync, ConnectionTlsAsync},
     config::Config,

src/macros.rs

@@ -15,7 +15,7 @@
 */
 
 #[macro_export]
-/// This macro can be used to create a [`Query`](crate::Query), almost like a variadic function
+/// This macro can be used to create a [`Query`](struct@crate::Query), almost like a variadic function
 /// 
 /// ## Examples
 /// ```

tests/derive.rs

@@ -0,0 +1,27 @@
+use skytable::{query, Query, Response};
+
+#[derive(Query, Response)]
+struct User {
+    username: String,
+    password: String,
+    email: Option<String>,
+}
+
+impl User {
+    fn new(username: String, password: String, email: Option<String>) -> Self {
+        Self {
+            username,
+            password,
+            email,
+        }
+    }
+}
+
+#[test]
+fn test_params() {
+    let q = query!(
+        "insert into myspace.mymodel(?, ?, ?)",
+        User::new("sayan".into(), "pass".into(), None)
+    );
+    assert_eq!(q.param_cnt(), 3);
+}