go-api: Postgres & sqlc #80
Conversation
darioscrivano
requested review from
ulises-jeremias and
edamico
as code owners
WalkthroughThis update introduces a comprehensive setup for a Golang API with a PostgreSQL database. It includes a multi-stage Dockerfile, Docker Compose configuration, database migrations, SQL queries, and a REST API with user management capabilities. The project is structured to leverage Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 5
Configuration used: CodeRabbit UI
Files ignored due to path filters (4)
examples/golang-api-with-postgres-and-sqlc/compose.ymlis excluded by:!**/*.ymlexamples/golang-api-with-postgres-and-sqlc/go.modis excluded by:!**/*.modexamples/golang-api-with-postgres-and-sqlc/go.sumis excluded by:!**/*.sumexamples/golang-api-with-postgres-and-sqlc/sqlc.yamlis excluded by:!**/*.yaml
Files selected for processing (8)
- examples/golang-api-with-postgres-and-sqlc/.gitignore (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/Dockerfile (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/README.md (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/db/database.go (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/handlers/handlers.go (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/main.go (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/query.sql (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/schema.sql (1 hunks)
Files skipped from review due to trivial changes (2)
- examples/golang-api-with-postgres-and-sqlc/.gitignore
- examples/golang-api-with-postgres-and-sqlc/README.md
Additional comments: 1
examples/golang-api-with-postgres-and-sqlc/query.sql (1)
- 1-14: The SQL queries for user operations are correctly parameterized, which helps prevent SQL injection. Good job following best practices here. Ensure that the
usernamecolumn is indexed to optimize the performance of theListUsersquery, as mentioned in the review ofschema.sql.
examples/golang-api-with-postgres-and-sqlc/handlers/handlers.go
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files ignored due to path filters (2)
examples/golang-api-with-postgres-and-sqlc/compose.ymlis excluded by:!**/*.ymlexamples/golang-api-with-postgres-and-sqlc/sqlc.yamlis excluded by:!**/*.yaml
Files selected for processing (2)
- examples/golang-api-with-postgres-and-sqlc/README.md (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/schema.sql (1 hunks)
Files skipped from review as they are similar to previous changes (2)
- examples/golang-api-with-postgres-and-sqlc/README.md
- examples/golang-api-with-postgres-and-sqlc/schema.sql
There was a problem hiding this comment.
Actionable comments posted: 8
Out of diff range and nitpick comments (1)
examples/golang-api-with-postgres-and-sqlc/README.md (1)
14-19: Correct typographical error in the prerequisites section.There's a repeated word "Docker" in the prerequisites section. Consider correcting this to improve the clarity of the documentation.
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (2)
examples/golang-api-with-postgres-and-sqlc/go.modis excluded by!**/*.modexamples/golang-api-with-postgres-and-sqlc/go.sumis excluded by!**/*.sum
Files selected for processing (17)
- examples/golang-api-with-postgres-and-sqlc/.gitignore (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/Dockerfile (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/README.md (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/compose.yml (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/db/database.go (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/db/migrations/schema.sql (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/db/query/user.sql (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/db/sqlc/db.go (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/db/sqlc/models.go (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/db/sqlc/querier.go (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/db/sqlc/user.sql.go (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/handler/handler.go (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/main.go (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/model/model.go (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/repository/repository.go (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/service/service.go (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/sqlc.yaml (1 hunks)
Files skipped from review due to trivial changes (7)
- examples/golang-api-with-postgres-and-sqlc/.gitignore
- examples/golang-api-with-postgres-and-sqlc/Dockerfile
- examples/golang-api-with-postgres-and-sqlc/compose.yml
- examples/golang-api-with-postgres-and-sqlc/db/migrations/schema.sql
- examples/golang-api-with-postgres-and-sqlc/db/sqlc/querier.go
- examples/golang-api-with-postgres-and-sqlc/model/model.go
- examples/golang-api-with-postgres-and-sqlc/service/service.go
Additional Context Used
LanguageTool (1)
examples/golang-api-with-postgres-and-sqlc/README.md (1)
Near line 16: Possible typo: you repeated a word
Context: ...erall performance. ## Prerequisites - Docker - Docker Compose -sqlc## Setup 1. **Clone ...
Additional comments not posted (5)
examples/golang-api-with-postgres-and-sqlc/sqlc.yaml (1)
1-20: Configuration settings insqlc.yamlare correctly set up.The SQLC configuration is appropriately set for PostgreSQL with
pgx/v5, and the settings likeemit_interfaceandemit_empty_slicesare beneficial for the generated code structure.examples/golang-api-with-postgres-and-sqlc/db/sqlc/db.go (1)
14-32: Database transaction setup indb.gois well-implemented.The
DBTXinterface andQueriesstruct are correctly set up for handling database transactions usingpgx, and the use of context in these operations is a best practice.examples/golang-api-with-postgres-and-sqlc/db/sqlc/user.sql.go (2)
46-74: The implementation ofGetUseris correct and follows best practices.
76-116: The implementation ofListUsersis correct and efficiently handles database rows and errors.examples/golang-api-with-postgres-and-sqlc/handler/handler.go (1)
59-79: The implementation ofGetUsercorrectly handles user ID parsing and error responses.
examples/golang-api-with-postgres-and-sqlc/repository/repository.go
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 0
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- examples/golang-api-with-postgres-and-sqlc/.gitignore (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/Dockerfile (1 hunks)
Files skipped from review as they are similar to previous changes (2)
- examples/golang-api-with-postgres-and-sqlc/.gitignore
- examples/golang-api-with-postgres-and-sqlc/Dockerfile
There was a problem hiding this comment.
Actionable comments posted: 0
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- examples/golang-api-with-postgres-and-sqlc/handler/handler.go (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/repository/repository.go (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/service/service.go (1 hunks)
Files skipped from review as they are similar to previous changes (3)
- examples/golang-api-with-postgres-and-sqlc/handler/handler.go
- examples/golang-api-with-postgres-and-sqlc/repository/repository.go
- examples/golang-api-with-postgres-and-sqlc/service/service.go
There was a problem hiding this comment.
Actionable comments posted: 0
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- examples/golang-api-with-postgres-and-sqlc/.sqlfluff (1 hunks)
Files skipped from review due to trivial changes (1)
- examples/golang-api-with-postgres-and-sqlc/.sqlfluff
There was a problem hiding this comment.
Actionable comments posted: 0
Review Details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- examples/golang-api-with-postgres-and-sqlc/db/database.go (1 hunks)
- examples/golang-api-with-postgres-and-sqlc/main.go (1 hunks)
Files skipped from review as they are similar to previous changes (2)
- examples/golang-api-with-postgres-and-sqlc/db/database.go
- examples/golang-api-with-postgres-and-sqlc/main.go
What's this PR do?
Go API using PostgresQL as DB and sqlc as a query generator.
Summary by CodeRabbit
New Features
Documentation
Chores
.gitignoreto include patterns for ignoring binaries, test outputs, and other development artifacts.sqlfluff.