Export

Squizy provides built-in CSV export for all managed entities. Users can export data directly from the UI, selecting which fields to include.

How It Works

Export is available automatically for every @SquizyEntity:

1. The client sends an ExportRequest containing the query filters and export options
2. The server streams the query results and converts them to CSV using the selected fields
3. The CSV file is returned with the entity name as the filename

REST API

POST /api/{entity}/export
Content-Type: application/json

{
  "queryCriteriaList": [],
  "exportOptions": {
    "fields": ["reference", "name", "price", "category.name", "status"]
  }
}

Response: CSV file with text/csv content type.

Field Resolution

• Simple fields are exported directly as their value
• Nested fields use dot notation to traverse relationships (e.g., category.name)
• Column headers use the last segment of the field path (e.g., category.name → name)

Performance

Export uses streaming queries to handle large datasets efficiently without loading all records into memory.

Access Control

Export operations require the export authority for the entity. See RBAC.