Collection Options
Set how your collection appears and behaves in the Studio and the generated application.
Go to Studio → Collections → select a collection → Options.
Basic Information
- Name: User-facing name of the collection shown across the Studio.
- DB Table Name: Database table where this collection's records are stored.
- Label Field: Field used to identify records in confirmation dialogs and other UI contexts (for example, delete confirmations).
- Collection Icon: Icon representing this collection throughout the app.
Description & Layout
- Description: Short description that clarifies the purpose of this collection.
- Column Length: Controls how many columns are shown in list and layout views.
Advanced Settings
- Authentication Collection: Marks the collection as the source for user identity. When turned on, additional auth-specific fields appear:
- Username Field: Field used as the username identifier for authentication.
- Password Field: Field used to store hashed passwords for authentication.
- Access Blocker Field: Field used to block or disable a user's access when needed.
- Status: Turns the collection on or off in the generated application.
- Configure Default User (Auth collections only): When turned on, creates an initial user record the first time the seeder runs. Set the email (or whichever field is your username field), password, and role for this first user.
note
The default user is only added when you run the seeder. This feature appears as Faker in the Studio.
View all settings
| Setting | Type | Description |
|---|---|---|
| Name | Text | Primary display name for the collection. |
| DB Table Name | Text | The SQL table identifier in your database. |
| Label Field | Dropdown | The field used for record identification in relations. |
| Collection Icon | Picker | Visual representation in navigation. |
| Description | Textarea | Internal purpose and context for the collection. |
| Column Length | Dropdown | Number of columns shown in list and layout views. |
| Authentication Collection | Toggle | Marks collection as a source for user identity. |
| Reset Password | Toggle | Allow users to reset their password from the profile view. |
| Status | Toggle | Controls presence in the generated codebase. |
| Configure Default User | Toggle | (Auth only) Seeds an initial user with a set email/username, password, and role when the seeder runs. |
Related
- Creating Collections — Step-by-step creation guide
- Fields — Manage collection fields
- Indexer — Optimize query performance
- ERD View — Visualize your schema