AML Reference

Syntax, types, and object-by-object details for the Analytics Modeling Language.

This is the reference for AML: the syntax, the types, the object-by-object details. Use it to look something up.

For concepts (what AML is for, design principles, reusability patterns, and how it fits with AQL), head to AML Overview in the Documentation section.

How this section is organized

AML is a declarative language for defining semantic models. The reference is grouped by object type and by language feature, mirroring the sidebar.

Core objects

The building blocks you'll define most often: models and their fields, datasets, and dashboards.

Models and fields

Model

Define table models and query models, the foundation of every semantic model.

Reference →

Table model

Models backed by database tables or views.

Reference →

Query model

Models defined by a SQL query rather than a single table.

Reference →

Persistence

Materialize model queries as tables for faster reads.

Reference →

Fields

Dimensions and measures defined inside models.

Reference →

Datasets

Dataset

Collections of models wired together with relationships.

Reference →

Dataset fields

Cross-model dimensions and metrics that live on the dataset.

Reference →

PreAggregate

Map model fields to pre-aggregated tables for faster queries.

Reference →

Relationship

How models join together inside a dataset.

Reference →

Dashboards

Dashboard

Dashboard definitions as code.

Reference →

Dashboard blocks

TextBlock, VizBlock, FilterBlock, PopBlock, and DateDrillBlock.

Reference →

Dashboard interactions

DateDrillInteraction, PopInteraction, and CustomMapping for cross-block behavior.

Reference →

Canvas layout

A single free-form canvas page with pixel-based positioning.

Reference →

Tab layout

Tabbed canvas dashboard.

Reference →

HTML layout

Free-form HTML and CSS layout for complex or paginated compositions.

Reference →

Theme and Colors

PageTheme, BlockTheme, and VizTheme for styling dashboards.

Reference →

Language features

The constructs that make AML composable and reusable: types, functions, modules, and the tools for sharing logic across objects.

Types

The AML type system.

Reference →

Constant

Reusable constant values.

Reference →

Function

User-defined functions.

Reference →

Module

Organize and import definitions across files.

Reference →

Extend

Inherit and override object properties.

Reference →

Partial

Composable object fragments you can mix in.

Reference →

If-else

Conditional logic in definitions.

Reference →

String interpolation

Build dynamic string values.

Reference →

User attributes and variables

Runtime context from users and Git environments.

Reference →

Quick start

If you're new to AML:

• Examples: side-by-side code examples for common objects
• Model → Fields → Dataset: the core modeling path

See also

• AML Overview: conceptual introduction and design principles
• AQL Reference: the query language that runs on top of AML models
• Reusability Guide: patterns for composing and reusing AML code