Metadata Specifications

This section contains the complete metadata specifications for the ObjectQL platform. ObjectQL is a metadata-driven standard for enterprise applications - every aspect of your application is defined through structured metadata.

📖 Read the Complete Metadata Standard Guide - A comprehensive overview of the entire metadata system and how all pieces fit together.

Core Data Layer

• Objects & Fields - Data model definitions, field types, relationships, and validation rules
• Query Language (JSON-DSL) - Unified query protocol for database-agnostic data access
• Validation Rules - Data quality and business rule enforcement

Business Logic Layer

• Hooks (Triggers) - Event-driven logic attached to data operations
• Actions (RPC) - Custom server-side functions and APIs
• Workflows & Processes - Automated business processes and approval chains

Presentation Layer

• Views & Layouts - Data presentation configurations (list, grid, kanban, calendar)
• Forms - Data entry and editing interfaces
• Reports & Dashboards - Analytics, visualizations, and business intelligence
• Menus & Navigation - Application structure and navigation hierarchy

Security & Access Control

• Permissions - Role-based access control, field-level security, and record-level rules

Design Philosophy

ObjectQL treats metadata as the source of truth for your entire application:

1. Define Once, Run Anywhere: Metadata is interpreted by ObjectOS to generate enterprise applications
2. AI-Native: Structured metadata is optimized for LLM understanding and generation
3. Version Controlled: Metadata lives in YAML/JSON files, tracked in Git
4. Type-Safe: Generate TypeScript types from metadata for full IDE support
5. Composable: Mix and match metadata to build complex applications

Metadata File Organization

src/
  objects/              # Core data models
    *.object.yml       # Object definitions
    *.validation.yml   # Validation rules
    *.permission.yml   # Permission rules
    *.hook.ts          # Hook implementations
    *.action.ts        # Action implementations
  
  workflows/           # Business processes
    *.workflow.yml     # Workflow definitions
  
  views/              # UI presentation
    *.view.yml         # View configurations
    *.form.yml         # Form layouts
  
  reports/            # Analytics
    *.report.yml       # Report definitions
    *.dashboard.yml    # Dashboard configurations
  
  navigation/         # App structure
    *.menu.yml         # Menu definitions

Getting Started

1. Start with Objects: Define your data model using Objects & Fields
2. Add Business Logic: Implement validation, hooks, and actions
3. Design UI: Create views, forms, and navigation
4. Secure Your App: Configure permissions and access rules
5. Build Workflows: Automate processes and approvals
6. Create Reports: Add analytics and dashboards