Skip to content

feat: Document the new unique keyword on fields #528

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

Open
marcelomendoncasoares wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −0
Open

feat: Document the new unique keyword on fields #528

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 docs/06-concepts/06-database/04-indexing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,15 @@ indexes:

The `unique` keyword is a bool that can toggle the index to be unique, the default is set to false. If the `unique` keyword is applied to a multi-column index, the index will be unique for the combination of the fields.

Alternatively, for single-column indexes, marking a column as unique can be simplified by using the `unique` keyword directly on the field definition:

```yaml
class: Company
table: company
fields:
name: String, unique
```

## Specifying index type

It is possible to add a type key to specify the index type.
Expand Down
Loading