# AML Table Model

> Reference for AML Table Model syntax, covering all parameters (type, label, data source, dimensions, measures) and a code example to map a table to a model.

:::tip Knowledge Checkpoint
A grasp of these concepts will help you understand this documentation better:
- [Table Model](/docs/table-models)
:::

<!-- ## Intro

[Table Model](/docs/table-models) defines a data model that sits on top of a database table.

## Syntax Construct

```aml
Model model_name {
  type: 'table'
  label: "Model Label"
  description: ""
  owner: 'user@your-domain.com'
  data_source_name: 'data_source_name'

  table_name: '"schema"."table_name"'

  dimension dimension_name_1 {
    // dimension 1 definition
    label: 'Dimension Label 1'
    type: 'text | number | date | datetime | truefalse'
    description: 'Field Description'
    hidden: true|false
    definition: @sql {{#SOURCE.column_name}};;
  }

  dimension dimension_name_2 {
    // dimension 2 definition
  }

  measure measure_name_1 {
    // measure 1 definition
    label: 'Measure Name 1'
    type: 'number | date | datetime'
    definition: @sql {{#SOURCE.column_name}};;
    aggregation_type: 'count | count distinct | sum | avg'
  }

}
``` -->

## Introduction

[Table Model](/docs/table-models) defines a data model that sits on top of a SQL table.

## Parameter definition

Parameter name      | Description
--------------      | ------------
type                | Model type: `'table'` for Table Model, `'query'` for Query Model
label               | User-friendly name for the model that appears in the Dataset exploration UI
description         | Description of the model. Support Markdown.
data_source_name    | The database on which Holistics will execute the SQL generated from this model
owner               | Define who should be in charge of managing the current model
table_name          | Path to the table underlying this model, in the form: `'"schema_name"."table_name"'`
dimension           | Define a dimension.
measure             | Define a measure.

## Code Example

```aml
Model users {
  type: 'table'
  label: "Users"
  data_source_name: 'your_datasource_name'
  table_name: 'ecommerce.users' // underlying table of the model

  dimension id {
    label: 'ID'
    type: 'number'
    primary_key: true // recommended for query optimization and AQL features
    hidden: false // optional
    definition: @sql {{#SOURCE.id}};; // optional
  }

  dimension email {
    label: 'Email'
    type: 'text'
    // without "definition", it automatically uses the same column name as the dimension name ('email')
  }

  measure user_count {
    type: 'number'
    label: 'Count Users'
    definition: @aql count(users.id);;
  }
}
```