{"id":22197012,"url":"https://github.com/tada-team/lorm","last_synced_at":"2025-07-27T01:30:57.485Z","repository":{"id":52713253,"uuid":"280531396","full_name":"tada-team/lorm","owner":"tada-team","description":"Django inspired ORM for Golang","archived":false,"fork":false,"pushed_at":"2022-02-20T22:14:45.000Z","size":205,"stargazers_count":11,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-06-19T18:08:32.037Z","etag":null,"topics":["django","django-models","golang","golang-orm","orm"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tada-team.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.txt","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-07-17T21:50:07.000Z","updated_at":"2023-05-07T17:09:38.000Z","dependencies_parsed_at":"2022-09-26T18:21:06.221Z","dependency_job_id":null,"html_url":"https://github.com/tada-team/lorm","commit_stats":null,"previous_names":[],"tags_count":68,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tada-team%2Florm","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tada-team%2Florm/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tada-team%2Florm/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tada-team%2Florm/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tada-team","download_url":"https://codeload.github.com/tada-team/lorm/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227740662,"owners_count":17812687,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["django","django-models","golang","golang-orm","orm"],"created_at":"2024-12-02T14:18:05.521Z","updated_at":"2024-12-02T14:18:06.096Z","avatar_url":"https://github.com/tada-team.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# lorm\nDjango ispired ORM.\n\n## Install\n\n```bash\ngo get -u github.com/tada-team/lorm\n```\n\n## Setup database\n\n```go\npackage main\n\nimport (\n    \"database/sql\"\n    \"github.com/tada-team/lorm\"\n)\n\nfunc init() {\n    connStr := \"dbname=... user=... password=... host=... port=... sslmode=...\"\n    conn, err := sql.Open(\"postgres\", connStr)\n    if err != nil {\n        panic(err)\n    }\n    lorm.SetConn(conn)\n}\n```\n\n## Django models\n\n1. install django app: https://github.com/tada-team/lorm_exporter\n2. generate `models.go` from your django models\n\n## Examples\n\n### Single object\n\nDjango:\n```python\ntry:\n    user = User.objects.get(id=42)\nexcept User.DoesNotExist:\n    raise Exception(\"user not found\")\n\nuser.is_archive = False\nuser.save()\n\nuser.delete()\n```\n\nlorm:\n```go\nuser := UserTable.MustGet(42) // same as UserTable.Filter().Id(42).MustGet() \nif user == nil {\n    panic(\"user not found\")\n}\n\nuser.IsArchive = false\nif err := user.Save(); err != nil {\n    panic(err)\n}\n\nif err := user.Delete(); err != nil {\n    panic(err)\n}\n\n```\n\n### Filter\n\nDjango:\n```python\nfor user in User.objects.filter(is_admin=False, created__gt=dt):\n    print(user.login)\n```\n\nlorm:\n```go\nfor _, user := range UserTable.Filter().IsAdmin(false).CreatedGt(dt).MustList() {\n    fmt.Println(user.login)\n}\n```\n\n## Low-level queries\n\n```go\npackage main\n\nimport (\n    \"github.com/tada-team/lorm\"\n    \"github.com/tada-team/lorm/op\"\n)\n\nfunc ExampleQuery(i, j int) (int, error) {\n    args := op.NewArgs()\n    query := op.RawQuery(\"SELECT\", args.Next(i), \"*\", args.Next(j))\n    \n    var res int    \n    err := lorm.TxScan(nil, query, args, \u0026res)\n\n    return res, err\n}\n```\n\n`args` and `query` in example above equals to:\n```go\nargs := op.Args{i, j}\nquery := \"SELECT $1 * $2\"\n```\n\n`RawQuery()` works like `fmt.Splintln()`.\n\n### API\nSupported 3 base functions for database access:\n* `lorm.TxExec(tx *lorm.Tx, q op.Query, args op.Args) (sql.Result, error)`\n* `lorm.TxQuery(tx *lorm.Tx, q op.Query, args op.Args, each func(*sql.Rows) error) error`\n* `lorm.TxScan(tx *lorm.Tx, q op.Query, args op.Args, dest ...interface{}) error`\n\n### Query constructor\n\n`github.com/tada-team/lorm/op` has many helpers. For example:\n * `op.Select()`\n * `op.Delete()`\n * `op.Insert()`\n * `op.Or()`\n * `op.And()`\n * `op.Not()`\n * etc. Try autocomplete.\n\n```go\nargs := op.NewArgs()\nquery := op.Select(\n    UserTable.Id(),\n    UserTable.Created(),\n).From(\n    UserTable,\n).OrderBy(\n    UserTable.Created(),\n).Where( // .Where() arguments concatenated with \"AND\" statement\n    UserTable.Created().Gt(args.Next(time.Now().Add(-time.Hour))),\n    op.Or(\n        UserTable.IsArchive(),        \n        op.Not(UserTable.IsAdmin()),\n        UserTable.GroupId().InSubquery( // wow, subqueries!\n            op.Select(\n                GroupTable.Id(),\n            ).From(\n                GroupTable,\n            ).Where(\n                // HasPrefix is shortcut for \"...%\"\n                GroupTable.Title().ILike(args.Next(op.HasPrefix(\"aaaaa\"))),\n            ),\n        ),\n    ),\n).Limit(\n    args.Next(10),\n)\n```\n\n```go\nargs := op.NewArgs()\nquery := op.Insert(t, op.Set{\n    op.Column(\"date\"): op.Raw(\"CURRENT_DATE\"),\n    op.Column(\"value\"): args.Next(1),\n}, op.Set{\n    op.Column(\"date\"): op.Raw(\"CURRENT_DATE\"),\n    op.Column(\"value\"): args.Next(2),\n})\n```\n\n### Transactions\n\n```go\npackage main\n\nimport (\n    \"github.com/tada-team/lorm\"\n    \"github.com/tada-team/lorm/op\"\n)\n\nfunc ExampleTransaction(i, j int) (int, error) {\n    args := op.NewArgs()\n    query := op.RawQuery(\"SELECT\", args.Next(i), \"*\", args.Next(j))\n    \n    var res int    \n    if err := lorm.Atomic(func(tx *lorm.Tx) error {\n        return lorm.TxScan(tx, query, args, \u0026res)    \t\n    }); err != nil {\n        return res, err\n    }\n\n    return res, nil\n} \n```\n\n### Internal naming\n* `r` — record (row in database)\n* `l` – list of records\n* `t` — table\n* `f` – filter\n* `q` — query\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftada-team%2Florm","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftada-team%2Florm","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftada-team%2Florm/lists"}