chore: flatten

Fyko · Sep 5, 2023 · 7cd5855 · 7cd5855
1 parent 663a043
commit 7cd5855
Show file tree

Hide file tree

Showing 13 changed files with 67 additions and 31 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,18 +1,42 @@
 [workspace]
-members = ["example", "scyllax", "scyllax-macros"]
+members = ["example", "scyllax-macros"]
 resolver = "2"
 
 [workspace.package]
-version = "0.1.0-alpha"
+version = "0.1.1-alpha"
 license = "MIT OR Apache-2.0"
 edition = "2021"
 repository = "https://github.com/trufflehq/scyllax"
 keywords = ["scylla", "cassandra", "orm", "sqlx", "trufflehq", "truffle", "youtube", "twitch"]
+categories = ["database"]
 authors = [
     "Carter Himmel <[email protected]>"
 ]
 homepage = "https://github.com/trufflehq/scyllax#readme"
 
+[package]
+name = "scyllax"
+readme = "README.md"
+description = "A SQLx and Discord inspired query system for Scylla"
+version = { workspace = true }
+license = { workspace = true }
+edition = { workspace = true }
+authors = { workspace = true }
+repository = { workspace = true }
+homepage = { workspace = true }
+
+[dependencies]
+anyhow = { workspace = true }
+async-trait = "0.1"
+getrandom = "0.2"
+mac_address = "1"
+once_cell = "1"
+scylla = { workspace = true }
+scyllax-macros = { version = "0.1.1-alpha", path = "./scyllax-macros" }
+thiserror = "1"
+tracing = { workspace = true }
+uuid = { workspace = true }
+
 [workspace.dependencies]
 scyllax-macros = { verison = "0.1.0-alpha", path = "scyllax-macros" }
 anyhow = "1"

diff --git a/README.md b/README.md
@@ -5,10 +5,44 @@ A SQLx and Discord inspired query system for Scylla.
 [![codecov](https://codecov.io/gh/trufflehq/scyllax/graph/badge.svg?token=OGH77YR0TA)](https://codecov.io/gh/trufflehq/scyllax)
 [![CI](https://github.com/trufflehq/scyllax/actions/workflows/ci.yml/badge.svg)](https://github.com/trufflehq/scyllax/actions/workflows/ci.yml)
 
+## Example
+### 1. Model definition
+Before you can write any queries, you have to define a model.
+```rust,ignore
+#[derive(Clone, Debug, FromRow, PartialEq, ValueList, Entity)]
+pub struct PersonEntity {
+    #[pk]
+    pub id: uuid::Uuid,
+    pub email: String,
+    pub created_at: i64,
+}
+```
+### 2. Select queries
+With the [`select_query`] attribute, it's easy to define select queries.
+```rust,ignore
+#[select_query(
+    query = "select * from person where id = ? limit 1",
+    entity_type = "PersonEntity"
+)]
+pub struct GetPersonById {
+    pub id: Uuid,
+}
+```
+### 3. Upsert queries
+With the [`upsert_query`] attribute, it's easy to define upsert queries.
+```rust,ignore
+#[upsert_query(table = "person", name = UpsertPerson)]
+#[derive(Clone, Debug, FromRow, PartialEq, ValueList, Entity)]
+pub struct PersonEntity {
+    #[pk]
+    pub id: uuid::Uuid,
+    pub email: String,
+    pub created_at: i64,
+}
+```
+
 ## Features
 - [x] Select Queries
-- ~~[ ] Insert Queries~~
-- ~~[ ] Update Queries~~
 - [x] Upsert Queries (https://github.com/trufflehq/scyllax/pull/1)
 - [ ] Delete Queries
 - [ ] Request Coalescing
@@ -19,7 +53,7 @@ A SQLx and Discord inspired query system for Scylla.
 - [ ] Eject `anyhow`, more refined errors
 
 ## Usage
-See [examples](examples) for more details.
+See the [example](example) for more details.
 
 ## References
 1. https://www.reddit.com/r/rust/comments/11ki2n7/a_look_at_how_discord_uses_rust_for_their_data/jb8dmrx/

diff --git a/example/Cargo.toml b/example/Cargo.toml
@@ -12,7 +12,7 @@ publish = false
 [dependencies]
 anyhow = { workspace = true }
 scylla = { workspace = true }
-scyllax = { path = "../scyllax" }
+scyllax = { path = "../" }
 tokio = { workspace = true }
 tracing = { workspace = true }
 tracing-subscriber = { workspace = true }

diff --git a/scyllax/Cargo.toml b/scyllax/Cargo.toml
diff --git a/scyllax/README.md b/scyllax/README.md
diff --git a/scyllax/src/error.rs → src/error.rs b/scyllax/src/error.rs → src/error.rs
diff --git a/scyllax/src/executor.rs → src/executor.rs b/scyllax/src/executor.rs → src/executor.rs
diff --git a/scyllax/src/lib.rs → src/lib.rs b/scyllax/src/lib.rs → src/lib.rs
diff --git a/scyllax/src/maybe_unset.rs → src/maybe_unset.rs b/scyllax/src/maybe_unset.rs → src/maybe_unset.rs
diff --git a/scyllax/src/prelude.rs → src/prelude.rs b/scyllax/src/prelude.rs → src/prelude.rs
diff --git a/scyllax/src/rows.rs → src/rows.rs b/scyllax/src/rows.rs → src/rows.rs
diff --git a/scyllax/src/util.rs → src/util.rs b/scyllax/src/util.rs → src/util.rs