Creating Collections
Learn how to create and configure collections in Hyper Studio.
Create a New Collection
- In the sidebar, click + Add at the bottom
- The "Create a new Collection" dialog appears
Basic Settings
| Field | Description |
|---|---|
| Name | Display name shown in the UI (e.g., "Customer Orders") |
| Table Name | Database table name (e.g., "customer_orders") |
| Collection Icon | Visual icon for the sidebar |
| Is Auth Table | Enable if this collection stores user authentication data |
Advanced Setup
| Field | Description |
|---|---|
| Description | Optional description for documentation |
| Status | Enable/disable the collection in generated code |
- Click Save Changes to create the collection
Auto-Generated Fields
When you create a collection, Hyper automatically sets up essential fields for you:
Normal Collections:
- A UUID field is created as the default primary key
Auth Collections (when "Is Auth Table" is enabled):
- username — Single Line text field for user identification
- password — Password field (encrypted storage)
- isActive — Boolean field to enable/disable user accounts
You can modify or remove these fields later as needed.
After Creation
Once your collection is created, you'll see it in the sidebar. Click on it to:
- Add Fields - Define what data each record stores
- Create Indexes - Optimize database queries
- Configure Options - Adjust settings like label field and icon
Best Practices
- Use singular names for collections (Customer, not Customers)
- Keep table names lowercase with underscores (customer_orders)
- Add a description for complex collections
- Choose meaningful icons for quick identification
Next Steps
- Fields Overview — Start adding fields to your collection
- Auth Collections — Set up user authentication