Documentation and data catalogue

[awoehrl]

Dataform allows setting table and column descriptions, which are then synced to BigQuery and the Google Data Catalog. This would be a great addition to the models:

  type: "table",
    description: "This table joins orders information from Shopify & payment information from Stripe",
  columns: {
    order_date: "The date when a customer placed their order",
    id: "Order ID as defined by Shopify",
    order_status: "The status of an order e.g. sent, delivered",
    customer_id: "Unique customer ID",
    payment_status: "The status of a payment e.g. pending, paid",
    payment_method: "How the customer chose to pay",
    item_count: "The number of items the customer ordered",
    amount: "The amount the customer paid"
  },
    assertions: {
    uniqueKey: ["id"]
  }
}

https://docs.dataform.co/getting-started-tutorial/testing-and-documentation#documenting-your-dataset