​
Data Apps

A data app is a configuration-based visualization tool that allows you to create interactive dashboards from SQL queries without writing complex frontend code.

​
What are Data Apps?

Data apps in Oxy are defined using YAML configuration files (.app.yml) that specify both the data processing tasks and how to visualize the results.

​
Data App Components

In a data app YAML file, you need to specify the following components:

ComponentDescriptionRequired
nameUnique identifier for the data appRequired
descriptionBrief explanation of the app’s purposeOptional
tasksSQL queries that prepare data for visualizationRequired
displayVisualization components to render the dataRequired

​
Tasks

The tasks section defines SQL queries that will extract and transform data from your databases. Each task has the following structure:

FieldDescriptionRequired
nameIdentifier for the task (referenced in display)Required
typeThe task type (currently only execute_sql is supported)Required
databaseDatabase connection to use (defined in config.yml)Required
sql_queryInline SQL query to executeRequired if sql_file not provided
sql_filePath to SQL file to executeRequired if sql_query not provided
variablesKey-value pairs for variable substitution in queriesOptional
cacheCache configuration for query resultsOptional
exportConfiguration for exporting query resultsOptional

​
Display

The display section defines how to visualize the data produced by your tasks. Several visualization types are supported:

    Markdown blocks can be used to add formatted text, headers, and documentation:

    - type: markdown
  content: |
    # Dashboard Title
    Additional formatted text here