feat: New Functionalities by buraktabn · Pull Request #13 · jayy-lmao/sql-gen

buraktabn · 2024-08-13T18:09:56Z

closes #12

I wanted to bypass geo types by making it String on the rust side to store the geom from SQL as a string. I've also added new features to integrate my project more.

Added:

Rust Enum creation based on SQL Enum types
Optional --serde flag if you wanna derive structs/enums with serde
Optional --datetime-lib to select time or chrono crate to use. defaults to chrono

Fixed:

If the column name is type, it's a reserved keyword in Rust. So, I created a helper function rust_type_fix. (naming could be better)

Notes:

I haven't try the migrate command yet, I only needed generate command

buraktabn · 2024-08-13T22:05:22Z

src/query_generate.rs


-    query_code.push_str(&generate_unique_query_code(table_name, schema_name, rows));
-    query_code.push('\n');
+    // query_code.push_str(&generate_unique_query_code(table_name, schema_name, &rows));


This created duplicate function names for some of my tables. I had to comment this out and forget about it. will look into it soon.

Maybe it's because primary keys are unique - the by_{} one is meant to be for the pk, where as this is meant to be for all other unique keys.

PK query is sort of important for cases where the PK is two or more columns, which may or may not each be unique

I guess I fixed it by filtering more based on the given table name and unique columns.

jayy-lmao · 2024-08-14T09:42:29Z

src/utils.rs

+pub(crate) fn rust_type_fix(column_name: &str) -> String {
+    if column_name == "type" {
+        String::from("r#type")
+    } else {
+        column_name.to_string()
+    }
+}


Good catch, thanks for this

src/utils.rs

jayy-lmao · 2024-08-14T09:44:30Z

src/utils.rs

+    let serde_derives = if enable_serde {
+        ", serde::Serialize, serde::Deserialize"
+    } else {
+        ""
+    };


I actually wonder whether instead of hardcoding this for serde, it's worth making more extensible by just allowing people to provide extra headers (sort of like how tonic build works for gRPC)

That's a great idea. We could have new args like --struct-derive and --enum-derive that could take multiple values

jayy-lmao · 2024-08-14T09:45:38Z

src/query_generate.rs

        "    pub async fn all_by_{}_{}<'e, E: PgExecutor<'e>>(executor: E, {}_{}: {}) -> Result<Vec<{}>> {{\n",
        to_snake_case(foreign_row_table_name),
-        foreign_row_column_name,
+        to_snake_case(column_name),


I think this might need to be foreign_row_column_name still

yeah, you're right. I've changed this because I was figuring out what was causing the duplicate functions.

with foreign_row_column_name:

pub async fn all_by_profile_id<'e, E: PgExecutor<'e>>(executor: E, profile_id: i64) -> Result<Vec<Friendship>> { query_as::<_, Friendship>(r#"SELECT * FROM "friendship" WHERE from_user = $1"#) .bind(profile_id) .fetch_all(executor) .await } pub async fn all_by_profile_id<'e, E: PgExecutor<'e>>(executor: E, profile_id: i64) -> Result<Vec<Friendship>> { query_as::<_, Friendship>(r#"SELECT * FROM "friendship" WHERE to_user = $1"#) .bind(profile_id) .fetch_all(executor) .await }

with to_snake_case(column_name):

pub async fn all_by_profile_from_user<'e, E: PgExecutor<'e>>(executor: E, profile_id: i64) -> Result<Vec<Friendship>> { query_as::<_, Friendship>(r#"SELECT * FROM "friendship" WHERE from_user = $1"#) .bind(profile_id) .fetch_all(executor) .await } pub async fn all_by_profile_to_user<'e, E: PgExecutor<'e>>(executor: E, profile_id: i64) -> Result<Vec<Friendship>> { query_as::<_, Friendship>(r#"SELECT * FROM "friendship" WHERE to_user = $1"#) .bind(profile_id) .fetch_all(executor) .await }

yeah I remember why I changed it :)

jayy-lmao · 2024-08-14T09:51:34Z

src/main.rs

+        .arg(
+            Arg::with_name("exclude")
+                .short('e')
+                .long("exclude")
+                .takes_value(true)
+                .value_name("SQLGEN_EXCLUDE")
+                .multiple(true)
+                .use_delimiter(true)
+                .help("Specify the excluded table name(s)"),
+        )


Cargo.toml

jayy-lmao · 2024-08-14T09:54:35Z

Appreciate the work so far!
Thanks for doing this, I know @yellowHatpro will appreciate the enum generation!

buraktabn · 2024-08-15T19:27:28Z

With this library, we could create many more generators for other things as well. For example, I'm working on creating redis json schemas in here: R3-Lab@bdba715. But Since we only focus only on the rust types and helpers for SQL, Redis may not have life in here :) lmk what you think

yellowHatpro · 2024-08-16T04:48:41Z

Appreciate the work so far! Thanks for doing this, I know @yellowHatpro will appreciate the enum generation!

Thanks a lot for this. I even had a column name type in one of the tables, and I had to make it work by renaming it to r#type.
The new features will definitely be helpful 🤩🤩

jayy-lmao · 2024-08-16T22:06:39Z

With this library, we could create many more generators for other things as well. For example, I'm working on creating redis json schemas in here: R3-Lab@bdba715. But Since we only focus only on the rust types and helpers for SQL, Redis may not have life in here :) lmk what you think

Yeah I think my intention is to maybe expand to support other DBs in future but it probably still would be SQL.
If you split out the Redis part v. happy to mention and link to it in README :)

jayy-lmao · 2024-08-16T22:07:41Z

src/generate.rs

+    exclude_tables: Vec<String>,
    schemas: Option<Vec<&str>>,
+    date_time_lib: DateTimeLib,
+    struct_derives: Vec<String>,


Ty for doing this 🙏

jayy-lmao · 2025-03-23T09:58:18Z

This project seemed inflexible for requirements of custom type overrides etc.
I have re-written and added test support #17.

Hopefully that also fixes the requirements of the issue this was closing

buraktabn added 4 commits August 9, 2024 02:28

changes for personalization

74ed42c

option to derive w serde

db093c7

create enums for user defined types

8b4e08b

data types & date time lib

353bdc1

buraktabn marked this pull request as draft August 13, 2024 22:03

buraktabn commented Aug 13, 2024

View reviewed changes

jayy-lmao reviewed Aug 14, 2024

View reviewed changes

src/utils.rs Outdated Show resolved Hide resolved

jayy-lmao reviewed Aug 14, 2024

View reviewed changes

Cargo.toml Outdated Show resolved Hide resolved

jayy-lmao mentioned this pull request Aug 14, 2024

feat: cube support #14

Merged

buraktabn added 4 commits August 15, 2024 14:25

(fix) generated unique queries may have dup functions

0451b8e

(fix) select by fk query code

56cf8c3

(fix) drop once_cell use std OnceLock

e568854

(fix) added args for extra struct and enum derives

34936c3

buraktabn marked this pull request as ready for review August 15, 2024 19:27

(fix) generate_select_by_fk_query_code

6393fe2

jayy-lmao reviewed Aug 16, 2024

View reviewed changes

Conversation

buraktabn commented Aug 13, 2024

Uh oh!

buraktabn Aug 13, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jayy-lmao commented Aug 14, 2024

Uh oh!

buraktabn commented Aug 15, 2024

Uh oh!

yellowHatpro commented Aug 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jayy-lmao commented Aug 16, 2024

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jayy-lmao commented Mar 23, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

buraktabn Aug 13, 2024 •

edited

Loading

yellowHatpro commented Aug 16, 2024 •

edited

Loading