Skip to content

Commit 5bf217d

Browse files
committed
Add comprehensive documentation for querying and writing data with PormG
- Created `read.md` to provide detailed examples of query operations, including filtering, aggregations, joins, and subqueries. - Introduced `write.md` to cover data manipulation operations such as creating, updating, and deleting records, along with bulk operations and F expressions.
1 parent e5f4ea1 commit 5bf217d

21 files changed

Lines changed: 2031 additions & 152 deletions

README.MD

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44

55
> **Note:** This project is in a very early stage of development and is a personal hobby — I am not a professional programmer. The package is not yet available for general use. I am looking for people interested in contributing and helping to improve the system!
66
7+
## 📚 Documentation
8+
9+
For comprehensive documentation, tutorials, and API reference, visit:
10+
**[https://pingolee.github.io/PormG.jl/build/index.html](https://pingolee.github.io/PormG.jl/build/index.html)**
11+
712

813
---
914

@@ -52,25 +57,10 @@ query = M.User |> object;
5257
query.filter("name"=>"Alice")
5358
query.order_by("-age")
5459
query.values("name", "age")
55-
result = list(query)
60+
result = query |> list
5661
println(query)
5762
```
5863

59-
---
60-
61-
## For more examples
62-
63-
For hands-on examples of PormG in action, navigate to the `test\pg` directory and execute the following scripts in this order:
64-
65-
1. **connecting.jl** - Set up database connections
66-
2. **makemigrations.jl** - Create and apply database migrations
67-
3. **insertions.jl** - Add records to your database
68-
4. **selection.jl** - Query and retrieve data
69-
5. **deletion.jl** - Remove records from your database
70-
71-
This tutorial sequence demonstrates a complete workflow from database setup to data manipulation, allowing you to explore PormG's features step by step.
72-
73-
7464
## Contributing
7565

7666
Contributions and feedback are welcome! Please open issues or pull requests on GitHub.

db_2/connection.yml

Lines changed: 0 additions & 37 deletions
This file was deleted.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"documenter":{"julia_version":"1.11.5","generation_timestamp":"2025-07-29T09:35:33","documenter_version":"1.10.1"}}
1+
{"documenter":{"julia_version":"1.11.5","generation_timestamp":"2025-08-04T08:08:40","documenter_version":"1.10.1"}}

docs/build/api/index.html

Lines changed: 23 additions & 23 deletions
Large diffs are not rendered by default.

docs/build/configuration/index.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

docs/build/fields/index.html

Lines changed: 446 additions & 0 deletions
Large diffs are not rendered by default.

docs/build/index.html

Lines changed: 42 additions & 2 deletions
Large diffs are not rendered by default.

docs/build/migrations/index.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

docs/build/models/index.html

Lines changed: 7 additions & 17 deletions
Large diffs are not rendered by default.

docs/build/objects.inv

866 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)