Skip to main content

Creating Collections

Learn how to create and configure collections in Hyper Studio.

Create a New Collection

  1. In the sidebar, click + Add at the bottom
  2. The "Create a new Collection" dialog appears

Basic Settings

FieldDescription
NameDisplay name shown in the UI (e.g., "Customer Orders")
Table NameDatabase table name (e.g., "customer_orders")
Collection IconVisual icon for the sidebar
Is Auth TableEnable if this collection stores user authentication data

Advanced Setup

FieldDescription
DescriptionOptional description for documentation
StatusEnable/disable the collection in generated code
  1. 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:

  1. Add Fields - Define what data each record stores
  2. Create Indexes - Optimize database queries
  3. 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