retoor/sorm
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Upgraded english quality

Browse Source
This commit is contained in:
Gerben Aaltink 2024-11-22 14:07:41 +01:00
parent 5791a38c33
commit 29e625ff0c
1 changed files with 3 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -1,9 +1,9 @@
# SORM
## Description
SORM stands for SQL ORM. I made this because i have a hate/love relationship with both. I combined it together to have the best of both worlds!
SORM stands for SQL ORM. I made this because I have a love/hate relationship with both. I combined them together to have the best of both worlds!
The naming of my functions and variables are something to get used to. They're all abbreviations, kinda like C stdlib style. It looks weird, but you get used to it quickly and in reality, you just use a few of them.
The naming of my functions and variables are something to get used to. They are all abbreviations, kinda like C stdlib style. It looks weird, but you get used to it quickly and in reality, you just use a few of them.
Examples of common used functions are:
- `sormc(char *path)` connect to database. Returns `int`.
@ -14,7 +14,7 @@ Examples of common used functions are:
I wonder if I have configured sqlite3 the right way for thread safety. It maybe requires a manual compilation of the shared object file. Will look into that. SORM is written with thread safety in mind.
## Design choices
I use mainly native types and not custom structs. For example, the db parameter is an int. This is so it can easily conmmunicate with other languages using a shared object file.
I use mainly native types and not custom structs. For example, the db parameter is an int. This is so it can easily communicate with other languages using a shared object file.
Same argument is for the result set of `sormq` (the query function) resulting in a `char *` containing CSV data.
While the performance is nice, it's not written with performance in mind at all.
@ -63,4 +63,3 @@ Yes, you did see that right, you can use the default native free!
sormd(db);
```