Dataset

Knowledge Checkpoint

We think it would be best if you have a clear understanding of these concepts before reading this documentation:

• Dataset
• Create an AML Dataset

info

Please note that the dataset file has the extension .dataset.aml. Its full name is dataset_name.dataset.aml.

(This feature is currently in active development. Please reach out if you want to become beta tester)

Dataset syntax definition

Dataset syntax defines the Dataset inside a project which will be then deployed to production as Ready-to-explore Dataset for end users to explore and get insights.

The syntax of Dataset includes 4 main components

• Dataset metadata: dataset labels, descriptions, owners
• Data Source reference: users' exploration activities will use this source
• Data models included
• Relationship

Parameter definition

Parameter name	Description
import	Add other files to the current dataset file
dataset	Create Dataset
label	Specifies how the dataset will appear in the Ready-to-explore Dataset
description	Add dataset description
owner	Define who should be in charge of managing the current dataset
data_source_name	Specify the database that Holistics will execute the generated query against (in dataset)
relationships	Specify relationship and their configuration among added models
models	Specify which models will be used in the dataset

Dataset syntax example

AML 1.0

import '../models/base-model/users.model.aml' { users }
import '../models/base-model/orders.model.aml' { orders } 

Dataset raw_ecommerce {
  label: 'Raw Ecommerce'
  description: "This Dataset is about Ecommerce data"
    owner: '[email protected]'
  
  data_source_name: 'demodb'

  models: [
    users,
    orders
  ]

relationships: [
  // define relationship between orders and users is many to one
  rel(rel_expr: orders.user_id > users.id, active: true)
  ]
}

AML 2.0

// You don't need import statements in AML 2.0

Dataset raw_ecommerce {
  label: 'Raw Ecommerce'
  description: "This Dataset is about Ecommerce data"
    owner: '[email protected]'
  
  data_source_name: 'demodb'

  models: [
    users,
    orders
  ]

relationships: [
  // define relationship between orders and users is many to one
  rel(rel_expr: orders.user_id > users.id, active: true)
  ]
}

The output

FAQs

Why is my AML Datasets only available in Preview, but not in Reporting Tab?

caution

This page is applicable to AML 1.0 only. AML 2.0 deprecates the use of index.aml. For more information, refer to index.aml file.

See Your Dataset is able to be explored in Preview mode, but it is not available in Production for mor information.