Skip to content

Add note to draft docs about conformances #201

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

Merged
merged 1 commit into from
Oct 6, 2025
Merged

Add note to draft docs about conformances #201

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 9 additions & 0 deletions Sources/StructuredQueriesCore/Documentation.docc/Articles/PrimaryKeyedTables.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,15 @@ key field is made optional:
let draft = Reminder.Draft(title: "Get groceries")
```

> Note: While the draft type is generated with all of the same fields as your type, it is _not_
> generated with all the same conformances. If your `@Table` type conforms to `Equatable`,
> `Hashable`, `Codable`, `Sendable`, or any other protocol that you wish for the `Draft` type to
> conform to, you must specify this conformance manually _via_ extension. For example:
>
> ```swift
> extension Reminder.Draft: Equatable {}
> ```

The `id` is not necessary to provide because it is optional. This allows you to insert rows into
your database without specifying the id. The library comes with a special
``PrimaryKeyedTable/insert(_:onConflict:)`` method that allows you to insert a row into the database
Expand Down