Skip to content

RETURNING docs #448

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.

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

Open
wants to merge 1 commit into
base: series/0.0.x
Choose a base branch
from
Open
Changes from all commits
Commits
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
27 changes: 27 additions & 0 deletions modules/docs/src/main/paradox/reference/Identifiers.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,29 @@
# Identifiers

Please visit PostgreSQL documentation to familiarize with `RETURNING` syntax: [Returning Data From Modified Rows](https://www.postgresql.org/docs/9.5/dml-returning.html)

## Returning identifiers

```
val savePet: Query[Pet, Int] =
sql"""
INSERT INTO pets (
VALUES ${petCodec.values}
RETURNING id;
""".query(int4)
```

## Returning entities

It's reasonable to return just an identifier in case there are no other database-managed columns.
Let's assume we have five columns: `id`, `name`, `colour`, `created_at`, `created_by` where `id`, `created_at`, `created_by` are not part of initial `NewPet` entity.
That means you need to query whole entity with RETURNING expression.
```
val savePet: Query[NewPet, PersistedPet] =
sql"""
INSERT INTO #$PETS_TABLE_NAME (name, colour)
VALUES ${newPetCodec.values}
RETURNING id, name, colour, created_at, created_by;
""".query(persistedPetCodec)
```
Please note that you might want to write down all column names (not just `*`) to decouple entity and database representation.