Document datasets

Introduction

Dataform allows you to add documentation to the datasets defined in your project.

Adding table and field descriptions

Table and field descriptions are added using the config block.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
config {
  type: "table",
  description: "This table defines something",
  columns: {
    column1: "A test column",
    column2: "A test column",
    record1: {
      description: "A struct",
      columns: {
        column3: "A nested column"
      }
    }
  }
}

Alternatively you can use the JavaScript API:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
publish("table1", {
  type: "table",
  description: "This table defines something",
  columns: {
    column1: "A test column",
    column2: "A test column",
    record1: {
      description: "A struct",
      columns: {
        column3: "A nested column",
      },
    },
  },
});

Sitemap