Skip to content

Commit 7b31e13

Browse files
committed
docs: Add 0.8.9 examples
1 parent e0fa04f commit 7b31e13

File tree

3 files changed

+30
-2
lines changed

3 files changed

+30
-2
lines changed

README.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,10 @@ skytable = "0.8"
2727
You're ready to go!
2828

2929
```rust
30-
use skytable::{Query, Response, Config, query};
30+
use skytable::{
31+
Query, Response, Config, query,
32+
response::Rows,
33+
};
3134

3235
#[derive(Query, Response)]
3336
#[derive(Clone, PartialEq, Debug)] // we just do these for the assert (they are not needed)
@@ -49,6 +52,10 @@ db.query_parse::<()>(&q).unwrap();
4952
// select data
5053
let user: User = db.query_parse(&query!("select * from myspace.mymodel where username = ?", &our_user.userid)).unwrap();
5154
assert_eq!(user, our_user);
55+
56+
// select multiple rows
57+
let users: Rows<User> = db.query_parse(&query!("select all * from myspace.mymodel limit ?", 1000u64)).unwrap();
58+
assert_eq!(users[0].userid, "user");
5259
```
5360

5461
> **Read [docs here to learn BlueQL](https://docs.skytable.io/)**

src/lib.rs

+7-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,10 @@
2424
//! ## Definitive example
2525
//!
2626
//! ```no_run
27-
//! use skytable::{Query, Response, Config, query};
27+
//! use skytable::{
28+
//! Query, Response, Config, query,
29+
//! response::Rows,
30+
//! };
2831
//!
2932
//! #[derive(Query, Response)]
3033
//! #[derive(Clone, PartialEq, Debug)] // we just do these for the assert (they are not needed)
@@ -47,6 +50,9 @@
4750
//! let user: User = db.query_parse(&query!("select * from myspace.mymodel where username = ?", &our_user.userid)).unwrap();
4851
//! assert_eq!(user, our_user);
4952
//!
53+
//! // select multiple rows
54+
//! let users: Rows<User> = db.query_parse(&query!("select all * from myspace.mymodel limit ?", 1000u64)).unwrap();
55+
//! assert_eq!(users[0].userid, "user");
5056
//! ```
5157
//!
5258
//! ## Getting started

src/response.rs

+15
Original file line numberDiff line numberDiff line change
@@ -359,6 +359,21 @@ impl FromRow for Row {
359359

360360
#[derive(Debug, PartialEq)]
361361
/// A collection of rows
362+
///
363+
/// ## Example
364+
/// ```no_run
365+
/// use skytable::{response::Rows, Config, Response, query};
366+
///
367+
/// #[derive(Response)]
368+
/// struct User {
369+
/// username: String,
370+
/// password: String,
371+
/// }
372+
///
373+
/// let mut db = Config::new_default("user", "pass").connect().unwrap();
374+
/// let users: Rows<User> = db.query_parse(&query!("select all * from myapp.users limit ?", 1000u64)).unwrap();
375+
/// assert_eq!(users[0].username, "sayan");
376+
/// ```
362377
pub struct Rows<T: FromRow = Row>(Vec<T>);
363378

364379
impl<T: FromRow> Rows<T> {

0 commit comments

Comments
 (0)