Skip to content

Complete queries package documentation with comprehensive guides for Relations, Writing Queries, and Virtual Fields #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
+2,027 −12
Draft

Complete queries package documentation with comprehensive guides for Relations, Writing Queries, and Virtual Fields #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
79d8eda
Initial plan
Copilot Jul 18, 2025
0a0da0a
Initial documentation update plan
Copilot Jul 18, 2025
4a00ff5
Complete queries package documentation with comprehensive guides
Copilot Jul 18, 2025
9dd9890
Revert go.mod changes - only documentation files should be modified
Copilot Jul 18, 2025
b9c8b71
Complete rewrite of queries documentation based on feedback - fix all…
Copilot Jul 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions queries/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ Databases must always be opened using `drivers.Open(ctx, driverName, dsn)`.
* [Interfaces](./docs/interfaces.md)
* [Querying Objects](./docs/querying.md)
* [QuerySet](./docs/queryset/queryset.md)
* [Writing Queries](./docs/queryset/writing_queries.md) (WIP)
* [Relations & Joins](./docs/relations/relations.md) (WIP)
* [Writing Queries](./docs/queryset/writing_queries.md)
* [Relations & Joins](./docs/relations/relations.md)
* [Expressions](./docs/expressions/expressions.md)
* [Lookups](./docs/expressions/lookups.md)
* [Case Expressions](./docs/expressions/cases.md)
* [Advanced: Virtual Fields](./docs/virtual_fields.md) (WIP)
* [Advanced: Virtual Fields](./docs/virtual_fields.md)

---

Expand Down Expand Up @@ -55,9 +55,9 @@ Continue with [Getting Started](./docs/getting_started.md)…

We try to support as many features as possible, but some stuff is either not supported, implemented or tested yet.

## TODO:
### TODO:

* Implement eficient prefetching of multiple- relations
* Implement efficient prefetching of multiple- relations

### Tested Databases

Expand Down
13 changes: 6 additions & 7 deletions queries/docs/getting_started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ The following imports will be used throughout the examples:

```go
import (
"github.com/Nigel2392/go-django/queries/queries"
"github.com/Nigel2392/go-django/queries/queries/expr"
"github.com/Nigel2392/go-django/queries/queries/fields"
"github.com/Nigel2392/go-django/queries/queries/models"
"github.com/Nigel2392/go-django/queries/queries/qerr"
"github.com/Nigel2392/go-django/queries/src"
"github.com/Nigel2392/go-django/queries/src/expr"
"github.com/Nigel2392/go-django/queries/src/fields"
"github.com/Nigel2392/go-django/queries/src/models"
"github.com/Nigel2392/go-django/queries/src/drivers/errors"
"github.com/Nigel2392/go-django/src/core/attrs"
)
```
Expand All @@ -46,7 +46,6 @@ For this example, we will use SQLite, but you can use any database that is suppo
To setup the database, we need to create a `sql.DB` object, and register it in Go-Django's settings.

```go

func main() {
var db, err = drivers.Open("sqlite3", "./db.sqlite3")
if err != nil {
Expand All @@ -55,7 +54,7 @@ func main() {

var app = django.App(
django.Configure(map[string]interface{}{
django.APPVAR_DATABASE: db,
django.APPVAR_DATABASE: db,
// ...
}),
// ...
Expand Down
Loading