Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
jochenchrist committed Feb 22, 2024
1 parent d2661f6 commit 9604e6c
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,36 @@ We run the tests:

```bash
$ datacontract test https://datacontract.com/examples/orders-latest/datacontract.yaml
# returns: ๐ŸŸข data contract is valid. Run 22 checks.

# returns:
Testing https://datacontract.com/examples/orders-latest/datacontract.yaml
โ•ญโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ฌโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฎ
โ”‚ Result โ”‚ Check โ”‚ Field โ”‚ Details โ”‚
โ”œโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ผโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ค
โ”‚ passed โ”‚ Check that JSON has valid schema โ”‚ orders โ”‚ โ”‚
โ”‚ passed โ”‚ Check that JSON has valid schema โ”‚ line_items โ”‚ โ”‚
โ”‚ passed โ”‚ Check that field lines_item_id is present โ”‚ line_items โ”‚ โ”‚
โ”‚ passed โ”‚ Check that field order_id is present โ”‚ line_items โ”‚ โ”‚
โ”‚ passed โ”‚ Check that field sku is present โ”‚ line_items โ”‚ โ”‚
โ”‚ passed โ”‚ values in (order_id) must exist in orders (order_id) โ”‚ line_items.order_id โ”‚ โ”‚
โ”‚ passed โ”‚ row_count >= 5000 โ”‚ line_items โ”‚ โ”‚
โ”‚ passed โ”‚ Check that required field lines_item_id has no null values โ”‚ line_items.lines_item_id โ”‚ โ”‚
โ”‚ passed โ”‚ Check that unique field lines_item_id has no duplicate values โ”‚ line_items.lines_item_id โ”‚ โ”‚
โ”‚ passed โ”‚ Check that field order_id is present โ”‚ orders โ”‚ โ”‚
โ”‚ passed โ”‚ Check that field order_timestamp is present โ”‚ orders โ”‚ โ”‚
โ”‚ passed โ”‚ Check that field order_total is present โ”‚ orders โ”‚ โ”‚
โ”‚ passed โ”‚ Check that field customer_id is present โ”‚ orders โ”‚ โ”‚
โ”‚ passed โ”‚ Check that field customer_email_address is present โ”‚ orders โ”‚ โ”‚
โ”‚ passed โ”‚ row_count >= 5000 โ”‚ orders โ”‚ โ”‚
โ”‚ passed โ”‚ Check that required field order_id has no null values โ”‚ orders.order_id โ”‚ โ”‚
โ”‚ passed โ”‚ Check that unique field order_id has no duplicate values โ”‚ orders.order_id โ”‚ โ”‚
โ”‚ passed โ”‚ duplicate_count(order_id) = 0 โ”‚ orders.order_id โ”‚ โ”‚
โ”‚ passed โ”‚ Check that required field order_timestamp has no null values โ”‚ orders.order_timestamp โ”‚ โ”‚
โ”‚ passed โ”‚ freshness(order_timestamp) < 24h โ”‚ orders.order_timestamp โ”‚ โ”‚
โ”‚ passed โ”‚ Check that required field order_total has no null values โ”‚ orders.order_total โ”‚ โ”‚
โ”‚ passed โ”‚ Check that required field customer_email_address has no null values โ”‚ orders.customer_email_address โ”‚ โ”‚
โ•ฐโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”ดโ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ”€โ•ฏ
๐ŸŸข data contract is valid. Run 22 checks. Took 8.875758 seconds.
```

Voilร , the CLI tested that the _datacontract.yaml_ itself is valid, all records comply with the schema, and all quality attributes are met.
Expand Down

0 comments on commit 9604e6c

Please sign in to comment.