mirrors/forgejo
1
0
Fork 0
mirror of https://codeberg.org/forgejo/forgejo.git synced 2024-05-29 05:38:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix some typos and update db transaction demo in backend guideline (#21322)

Browse source 
Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
This commit is contained in:
rj1 2022-10-07 13:12:19 -05:00 committed by GitHub
parent c08e42c47e
commit 56aabf3e8d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
docs/content/doc/developers/guidelines-backend.md
View file

@ -67,22 +67,18 @@ Some actions should allow for rollback when database record insertion/update/del
So services must be allowed to create a database transaction. Here is some example, So services must be allowed to create a database transaction. Here is some example,
```go ```go
// servcies/repository/repo.go // services/repository/repository.go
func CreateXXXX() error {\ func CreateXXXX() error {
ctx, committer, err := db.TxContext() return db.WithTx(func(ctx context.Context) error {
if err != nil { e := db.GetEngine(ctx)
return err // do something, if err is returned, it will rollback automatically
} if err := issues.UpdateIssue(ctx, repoID); err != nil {
defer committer.Close() // ...
return err
// do something, if return err, it will rollback automatically when `committer.Close()` is invoked. }
if err := issues.UpdateIssue(ctx, repoID); err != nil { // ...
// ... return nil
} })
// ......
return committer.Commit()
} }
``` ```
@ -94,14 +90,14 @@ If the function will be used in the transaction, just let `context.Context` as t
func UpdateIssue(ctx context.Context, repoID int64) error { func UpdateIssue(ctx context.Context, repoID int64) error {
e := db.GetEngine(ctx) e := db.GetEngine(ctx)
// ...... // ...
} }
``` ```
### Package Name ### Package Name
For the top level package, use a plural as package name, i.e. `services`, `models`, for sub packages, use singular, For the top level package, use a plural as package name, i.e. `services`, `models`, for sub packages, use singular,
i.e. `servcies/user`, `models/repository`. i.e. `services/user`, `models/repository`.
### Import Alias ### Import Alias