{ "openapi": "3.1.0", "x-stoplight": { "id": "eotwvzwtcxjpv" }, "info": { "title": "Hydrated Metadata", "version": "1.0", "summary": "Hydrated Metadata" }, "servers": [], "paths": {}, "components": { "schemas": { "Hydrated_Metadata": { "type": "object", "x-examples": { "Example 1": { "columns": [ { "id": "4c1e4719-b72b-41fe-82f6-7b6311475fdd", "name": "system_column_name1", "dataType": "STRING", "description": "Some description", "nullable": true, "defaultValue": "hello", "tests": [], "isSystemColumnName": true }, { "id": "8791b268-3a95-4ac0-9929-1a2b328c60bd", "name": "L_ORDERKEY", "dataType": "NUMBER(38,0)", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "6f73c0e2-fe2b-45bc-b181-dcaa02256b38", "name": "L_PARTKEY", "dataType": "NUMBER(38,0)", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "72636ad8-6c64-4983-a222-f9ac533c4eed", "name": "L_SUPPKEY", "dataType": "NUMBER(38,0)", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "99710860-2240-42ac-bcad-d5011ce50909", "name": "L_LINENUMBER", "dataType": "NUMBER(38,0)", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "6dc793eb-8f7d-4f13-a315-8a1cacdf541a", "name": "L_QUANTITY", "dataType": "NUMBER(12,2)", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "a96cd9cb-8201-4c54-8f04-c41e46c41115", "name": "L_EXTENDEDPRICE", "dataType": "NUMBER(12,2)", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "7ba1fe2a-6ff6-44ce-a76c-831dc01d0b59", "name": "L_DISCOUNT", "dataType": "NUMBER(12,2)", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "2dc17e49-4013-445b-81e1-9ec64a25f472", "name": "L_TAX", "dataType": "NUMBER(12,2)", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "c2823c69-a131-4c5c-93b5-1630b1385595", "name": "L_RETURNFLAG", "dataType": "VARCHAR(1)", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "fe7dc273-d716-45a6-92d6-d311a5355440", "name": "L_LINESTATUS", "dataType": "VARCHAR(1)", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "54e1b35c-4676-46da-a371-7c7da356f2bb", "name": "L_SHIPDATE", "dataType": "DATE", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "8959011e-a95b-4673-860c-a8f48e1d6b48", "name": "L_COMMITDATE", "dataType": "DATE", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "591df848-a979-4cd8-8bb2-4c88204aba2d", "name": "L_RECEIPTDATE", "dataType": "DATE", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "f2fd738f-ca2b-4845-bb7f-4d18703ecb23", "name": "L_SHIPINSTRUCT", "dataType": "VARCHAR(25)", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "602fa59d-4697-4e27-b9a1-bbb2d6400e67", "name": "L_SHIPMODE", "dataType": "VARCHAR(10)", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "ee257834-ee7f-4da5-8689-4e1b22500fad", "name": "L_COMMENT", "dataType": "VARCHAR(44)", "description": "", "nullable": false, "defaultValue": "", "tests": [] } ], "storageLocations": [ { "database": "SNOWFLAKE_SAMPLE_DATA", "schema": "TPCH_SF100", "name": "SAMPLE" }, { "database": "TATIANA_DOCS_DYNAMIC_TABLES", "schema": "HYDRATED", "name": "WORK" }, { "database": "TATIANA_DOCS_DYNAMIC_TABLES", "schema": "QA", "name": "DEV" } ], "config": { "truncateBefore": true, "testsEnabled": true, "myButton": false, "preSQL": "", "myTabularConfig": { "items": [ {} ] }, "postSQL": "", "myDropdown": "option1", "insertStrategy": "INSERT", "myTextbox": "", "dropdownSelectorExample": "option1" }, "sources": [ { "name": "DOCS_DIM_LINE_ITEM", "columns": [ { "id": "4c1e4719-b72b-41fe-82f6-7b6311475fdd", "name": "system_column_name1", "dataType": "STRING", "description": "Some description", "nullable": true, "defaultValue": "hello", "tests": [], "isSystemColumnName": true, "transform": "CAST(CURRENT_TIMESTAMP AS TIMESTAMP)", "sourceColumns": [ {} ] }, { "id": "8791b268-3a95-4ac0-9929-1a2b328c60bd", "name": "L_ORDERKEY", "dataType": "NUMBER(38,0)", "description": "", "nullable": false, "defaultValue": "", "tests": [], "transform": "", "sourceColumns": [ { "node": { "id": "9fcf37c9-c8b2-4b86-9009-5cda886df1ba", "name": "STG_LINEITEM", "nodeType": "Stage", "location": { "name": "WORK" }, "description": "Lineitem data as defined by TPC-H", "materializationType": "table", "isMultisource": false, "override": { "create": { "enabled": false, "script": "" } }, "tests": [] }, "column": { "id": "6bf537d0-c46a-4179-8a7d-0e1b0a1d1108", "name": "L_ORDERKEY", "dataType": "NUMBER(38,0)", "description": "", "nullable": false, "defaultValue": "", "tests": [] } } ] }, { "id": "6f73c0e2-fe2b-45bc-b181-dcaa02256b38", "name": "L_PARTKEY", "dataType": "NUMBER(38,0)", "description": "", "nullable": false, "defaultValue": "", "tests": [], "transform": "", "sourceColumns": [ { "node": { "id": "9fcf37c9-c8b2-4b86-9009-5cda886df1ba", "name": "STG_LINEITEM", "nodeType": "Stage", "location": { "name": "WORK" }, "description": "Lineitem data as defined by TPC-H", "materializationType": "table", "isMultisource": false, "override": { "create": { "enabled": false, "script": "" } }, "tests": [] }, "column": { "id": "4108767a-2457-4ee5-8eac-7681326d1a88", "name": "L_PARTKEY", "dataType": "NUMBER(38,0)", "description": "", "nullable": false, "defaultValue": "", "tests": [] } } ] }, { "id": "72636ad8-6c64-4983-a222-f9ac533c4eed", "name": "L_SUPPKEY", "dataType": "NUMBER(38,0)", "description": "", "nullable": false, "defaultValue": "", "tests": [], "transform": "", "sourceColumns": [ { "node": { "id": "9fcf37c9-c8b2-4b86-9009-5cda886df1ba", "name": "STG_LINEITEM", "nodeType": "Stage", "location": { "name": "WORK" }, "description": "Lineitem data as defined by TPC-H", "materializationType": "table", "isMultisource": false, "override": { "create": { "enabled": false, "script": "" } }, "tests": [] }, "column": { "id": "2c9b638c-360f-4b86-8752-52d1120d445e", "name": "L_SUPPKEY", "dataType": "NUMBER(38,0)", "description": "", "nullable": false, "defaultValue": "", "tests": [] } } ] }, { "id": "99710860-2240-42ac-bcad-d5011ce50909", "name": "L_LINENUMBER", "dataType": "NUMBER(38,0)", "description": "", "nullable": false, "defaultValue": "", "tests": [], "transform": "", "sourceColumns": [ { "node": { "id": "9fcf37c9-c8b2-4b86-9009-5cda886df1ba", "name": "STG_LINEITEM", "nodeType": "Stage", "location": { "name": "WORK" }, "description": "Lineitem data as defined by TPC-H", "materializationType": "table", "isMultisource": false, "override": { "create": { "enabled": false, "script": "" } }, "tests": [] }, "column": { "id": "edf4d472-6aad-4a41-8f5a-1da1dfe6bfc8", "name": "L_LINENUMBER", "dataType": "NUMBER(38,0)", "description": "", "nullable": false, "defaultValue": "", "tests": [] } } ] }, { "id": "6dc793eb-8f7d-4f13-a315-8a1cacdf541a", "name": "L_QUANTITY", "dataType": "NUMBER(12,2)", "description": "", "nullable": false, "defaultValue": "", "tests": [], "transform": "", "sourceColumns": [ { "node": { "id": "9fcf37c9-c8b2-4b86-9009-5cda886df1ba", "name": "STG_LINEITEM", "nodeType": "Stage", "location": { "name": "WORK" }, "description": "Lineitem data as defined by TPC-H", "materializationType": "table", "isMultisource": false, "override": { "create": { "enabled": false, "script": "" } }, "tests": [] }, "column": { "id": "1a2db895-c5d1-49c3-9677-09b6d1f6f742", "name": "L_QUANTITY", "dataType": "NUMBER(12,2)", "description": "", "nullable": false, "defaultValue": "", "tests": [] } } ] }, { "id": "a96cd9cb-8201-4c54-8f04-c41e46c41115", "name": "L_EXTENDEDPRICE", "dataType": "NUMBER(12,2)", "description": "", "nullable": false, "defaultValue": "", "tests": [], "transform": "", "sourceColumns": [ { "node": { "id": "9fcf37c9-c8b2-4b86-9009-5cda886df1ba", "name": "STG_LINEITEM", "nodeType": "Stage", "location": { "name": "WORK" }, "description": "Lineitem data as defined by TPC-H", "materializationType": "table", "isMultisource": false, "override": { "create": { "enabled": false, "script": "" } }, "tests": [] }, "column": { "id": "31b65bef-42f8-4f73-bd93-5cdcf785f490", "name": "L_EXTENDEDPRICE", "dataType": "NUMBER(12,2)", "description": "", "nullable": false, "defaultValue": "", "tests": [] } } ] }, { "id": "7ba1fe2a-6ff6-44ce-a76c-831dc01d0b59", "name": "L_DISCOUNT", "dataType": "NUMBER(12,2)", "description": "", "nullable": false, "defaultValue": "", "tests": [], "transform": "", "sourceColumns": [ { "node": { "id": "9fcf37c9-c8b2-4b86-9009-5cda886df1ba", "name": "STG_LINEITEM", "nodeType": "Stage", "location": { "name": "WORK" }, "description": "Lineitem data as defined by TPC-H", "materializationType": "table", "isMultisource": false, "override": { "create": { "enabled": false, "script": "" } }, "tests": [] }, "column": { "id": "332bfaf3-7b6b-440d-a4e9-d8c5cd2c64db", "name": "L_DISCOUNT", "dataType": "NUMBER(12,2)", "description": "", "nullable": false, "defaultValue": "", "tests": [] } } ] }, { "id": "2dc17e49-4013-445b-81e1-9ec64a25f472", "name": "L_TAX", "dataType": "NUMBER(12,2)", "description": "", "nullable": false, "defaultValue": "", "tests": [], "transform": "", "sourceColumns": [ { "node": { "id": "9fcf37c9-c8b2-4b86-9009-5cda886df1ba", "name": "STG_LINEITEM", "nodeType": "Stage", "location": { "name": "WORK" }, "description": "Lineitem data as defined by TPC-H", "materializationType": "table", "isMultisource": false, "override": { "create": { "enabled": false, "script": "" } }, "tests": [] }, "column": { "id": "1838f7d7-f0b7-4359-b69a-d4b80bd9370c", "name": "L_TAX", "dataType": "NUMBER(12,2)", "description": "", "nullable": false, "defaultValue": "", "tests": [] } } ] }, { "id": "c2823c69-a131-4c5c-93b5-1630b1385595", "name": "L_RETURNFLAG", "dataType": "VARCHAR(1)", "description": "", "nullable": false, "defaultValue": "", "tests": [], "transform": "", "sourceColumns": [ { "node": { "id": "9fcf37c9-c8b2-4b86-9009-5cda886df1ba", "name": "STG_LINEITEM", "nodeType": "Stage", "location": { "name": "WORK" }, "description": "Lineitem data as defined by TPC-H", "materializationType": "table", "isMultisource": false, "override": { "create": { "enabled": false, "script": "" } }, "tests": [] }, "column": { "id": "c2f5a9e8-dda3-467c-ae2b-f48335e87a73", "name": "L_RETURNFLAG", "dataType": "VARCHAR(1)", "description": "", "nullable": false, "defaultValue": "", "tests": [] } } ] }, { "id": "fe7dc273-d716-45a6-92d6-d311a5355440", "name": "L_LINESTATUS", "dataType": "VARCHAR(1)", "description": "", "nullable": false, "defaultValue": "", "tests": [], "transform": "", "sourceColumns": [ { "node": { "id": "9fcf37c9-c8b2-4b86-9009-5cda886df1ba", "name": "STG_LINEITEM", "nodeType": "Stage", "location": { "name": "WORK" }, "description": "Lineitem data as defined by TPC-H", "materializationType": "table", "isMultisource": false, "override": { "create": { "enabled": false, "script": "" } }, "tests": [] }, "column": { "id": "aaaa9052-9c2e-4212-a79e-eb302677e3d0", "name": "L_LINESTATUS", "dataType": "VARCHAR(1)", "description": "", "nullable": false, "defaultValue": "", "tests": [] } } ] }, { "id": "54e1b35c-4676-46da-a371-7c7da356f2bb", "name": "L_SHIPDATE", "dataType": "DATE", "description": "", "nullable": false, "defaultValue": "", "tests": [], "transform": "", "sourceColumns": [ { "node": { "id": "9fcf37c9-c8b2-4b86-9009-5cda886df1ba", "name": "STG_LINEITEM", "nodeType": "Stage", "location": { "name": "WORK" }, "description": "Lineitem data as defined by TPC-H", "materializationType": "table", "isMultisource": false, "override": { "create": { "enabled": false, "script": "" } }, "tests": [] }, "column": { "id": "9cad565a-7c63-42cd-a3c1-0f79fee13102", "name": "L_SHIPDATE", "dataType": "DATE", "description": "", "nullable": false, "defaultValue": "", "tests": [] } } ] }, { "id": "8959011e-a95b-4673-860c-a8f48e1d6b48", "name": "L_COMMITDATE", "dataType": "DATE", "description": "", "nullable": false, "defaultValue": "", "tests": [], "transform": "", "sourceColumns": [ { "node": { "id": "9fcf37c9-c8b2-4b86-9009-5cda886df1ba", "name": "STG_LINEITEM", "nodeType": "Stage", "location": { "name": "WORK" }, "description": "Lineitem data as defined by TPC-H", "materializationType": "table", "isMultisource": false, "override": { "create": { "enabled": false, "script": "" } }, "tests": [] }, "column": { "id": "7b339c3a-fe69-42cc-99ec-b59a4a648b33", "name": "L_COMMITDATE", "dataType": "DATE", "description": "", "nullable": false, "defaultValue": "", "tests": [] } } ] }, { "id": "591df848-a979-4cd8-8bb2-4c88204aba2d", "name": "L_RECEIPTDATE", "dataType": "DATE", "description": "", "nullable": false, "defaultValue": "", "tests": [], "transform": "", "sourceColumns": [ { "node": { "id": "9fcf37c9-c8b2-4b86-9009-5cda886df1ba", "name": "STG_LINEITEM", "nodeType": "Stage", "location": { "name": "WORK" }, "description": "Lineitem data as defined by TPC-H", "materializationType": "table", "isMultisource": false, "override": { "create": { "enabled": false, "script": "" } }, "tests": [] }, "column": { "id": "3813fedb-aa3c-4d28-a2aa-3915556def9d", "name": "L_RECEIPTDATE", "dataType": "DATE", "description": "", "nullable": false, "defaultValue": "", "tests": [] } } ] }, { "id": "f2fd738f-ca2b-4845-bb7f-4d18703ecb23", "name": "L_SHIPINSTRUCT", "dataType": "VARCHAR(25)", "description": "", "nullable": false, "defaultValue": "", "tests": [], "transform": "", "sourceColumns": [ { "node": { "id": "9fcf37c9-c8b2-4b86-9009-5cda886df1ba", "name": "STG_LINEITEM", "nodeType": "Stage", "location": { "name": "WORK" }, "description": "Lineitem data as defined by TPC-H", "materializationType": "table", "isMultisource": false, "override": { "create": { "enabled": false, "script": "" } }, "tests": [] }, "column": { "id": "59b4d78a-5719-4c4e-b564-c02057badb5f", "name": "L_SHIPINSTRUCT", "dataType": "VARCHAR(25)", "description": "", "nullable": false, "defaultValue": "", "tests": [] } } ] }, { "id": "602fa59d-4697-4e27-b9a1-bbb2d6400e67", "name": "L_SHIPMODE", "dataType": "VARCHAR(10)", "description": "", "nullable": false, "defaultValue": "", "tests": [], "transform": "", "sourceColumns": [ { "node": { "id": "9fcf37c9-c8b2-4b86-9009-5cda886df1ba", "name": "STG_LINEITEM", "nodeType": "Stage", "location": { "name": "WORK" }, "description": "Lineitem data as defined by TPC-H", "materializationType": "table", "isMultisource": false, "override": { "create": { "enabled": false, "script": "" } }, "tests": [] }, "column": { "id": "1c0e32ea-70b3-446c-8c0b-77c7fab2c701", "name": "L_SHIPMODE", "dataType": "VARCHAR(10)", "description": "", "nullable": false, "defaultValue": "", "tests": [] } } ] }, { "id": "ee257834-ee7f-4da5-8689-4e1b22500fad", "name": "L_COMMENT", "dataType": "VARCHAR(44)", "description": "", "nullable": false, "defaultValue": "", "tests": [], "transform": "", "sourceColumns": [ { "node": { "id": "9fcf37c9-c8b2-4b86-9009-5cda886df1ba", "name": "STG_LINEITEM", "nodeType": "Stage", "location": { "name": "WORK" }, "description": "Lineitem data as defined by TPC-H", "materializationType": "table", "isMultisource": false, "override": { "create": { "enabled": false, "script": "" } }, "tests": [] }, "column": { "id": "031c8ddc-9fe6-4754-bc54-eba44190d9a7", "name": "L_COMMENT", "dataType": "VARCHAR(44)", "description": "", "nullable": false, "defaultValue": "", "tests": [] } } ] } ], "join": "FROM {{ ref('WORK', 'STG_LINEITEM') }} \"STG_LINEITEM\"", "dependencies": [ { "node": { "id": "9fcf37c9-c8b2-4b86-9009-5cda886df1ba", "name": "STG_LINEITEM", "nodeType": "Stage", "location": { "name": "WORK" }, "description": "Lineitem data as defined by TPC-H", "materializationType": "table", "isMultisource": false, "override": { "create": { "enabled": false, "script": "" } }, "tests": [] }, "columns": [ { "id": "6bf537d0-c46a-4179-8a7d-0e1b0a1d1108", "name": "L_ORDERKEY", "dataType": "NUMBER(38,0)", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "4108767a-2457-4ee5-8eac-7681326d1a88", "name": "L_PARTKEY", "dataType": "NUMBER(38,0)", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "2c9b638c-360f-4b86-8752-52d1120d445e", "name": "L_SUPPKEY", "dataType": "NUMBER(38,0)", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "edf4d472-6aad-4a41-8f5a-1da1dfe6bfc8", "name": "L_LINENUMBER", "dataType": "NUMBER(38,0)", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "1a2db895-c5d1-49c3-9677-09b6d1f6f742", "name": "L_QUANTITY", "dataType": "NUMBER(12,2)", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "31b65bef-42f8-4f73-bd93-5cdcf785f490", "name": "L_EXTENDEDPRICE", "dataType": "NUMBER(12,2)", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "332bfaf3-7b6b-440d-a4e9-d8c5cd2c64db", "name": "L_DISCOUNT", "dataType": "NUMBER(12,2)", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "1838f7d7-f0b7-4359-b69a-d4b80bd9370c", "name": "L_TAX", "dataType": "NUMBER(12,2)", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "c2f5a9e8-dda3-467c-ae2b-f48335e87a73", "name": "L_RETURNFLAG", "dataType": "VARCHAR(1)", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "aaaa9052-9c2e-4212-a79e-eb302677e3d0", "name": "L_LINESTATUS", "dataType": "VARCHAR(1)", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "9cad565a-7c63-42cd-a3c1-0f79fee13102", "name": "L_SHIPDATE", "dataType": "DATE", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "7b339c3a-fe69-42cc-99ec-b59a4a648b33", "name": "L_COMMITDATE", "dataType": "DATE", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "3813fedb-aa3c-4d28-a2aa-3915556def9d", "name": "L_RECEIPTDATE", "dataType": "DATE", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "59b4d78a-5719-4c4e-b564-c02057badb5f", "name": "L_SHIPINSTRUCT", "dataType": "VARCHAR(25)", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "1c0e32ea-70b3-446c-8c0b-77c7fab2c701", "name": "L_SHIPMODE", "dataType": "VARCHAR(10)", "description": "", "nullable": false, "defaultValue": "", "tests": [] }, { "id": "031c8ddc-9fe6-4754-bc54-eba44190d9a7", "name": "L_COMMENT", "dataType": "VARCHAR(44)", "description": "", "nullable": false, "defaultValue": "", "tests": [] } ] } ], "customSQL": "" } ], "node": { "id": "scratch", "name": "DOCS_DIM_LINE_ITEM", "nodeType": "16", "location": { "name": "WORK" }, "description": "Lineitem data as defined by TPC-H", "materializationType": "table", "isMultisource": false, "override": { "create": { "enabled": false, "script": "" } }, "tests": [] }, "this": "{{ ref_no_link(node.location.name, node.name) }}", "parameters": { "hello": "goodbye", "goodMorning": "goodnight" } } }, "properties": { "columns": { "type": "array", "description": "Columns map to the columns displayed in the Mapping Grid. Add a source or a Node to populate the columns. There can be multiple columns. A column array can contain multiple column objects.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "An auto-generated Coalesce ID.", "example": "4c1e4719-b72b-41fe-82f6-7b6311475fdd" }, "name": { "type": "string", "description": "The name of the column.", "example": "L_PARTKEY" }, "dataType": { "type": "string", "description": "This is the data type for the column and by default maps to the source of the Node.", "example": "NUMBER(38,0)" }, "description": { "type": "string", "description": "If there is a comment or description or it can be added here.", "example": "Column description" }, "nullable": { "type": "boolean", "description": "If a column can have null values" }, "defaultValue": { "type": "string", "description": "Default value of a column.", "example": "Coalesce" }, "tests": { "type": "array", "description": "Column level tests for null and unique values. Each test is in it's own object.\nIf there are no tests, shows as an empty array. \n`tests: []`", "items": { "type": "object", "properties": { "name": { "x-stoplight": { "id": "t9aledwyp2ulz" }, "default": "Null", "example": "\"Null\"", "enum": [ "Unique", "\"Null\"" ], "description": "Name of the test. Indicates if the test is Unique or \"Null\"" }, "description": { "type": "string", "x-stoplight": { "id": "0qt402zphg2bp" }, "example": "checks for any null values", "description": "Description of the test. \n* Null testing - `checks for any null values` \n* Unique value `check if value is unique`" }, "continueOnFailure": { "type": "boolean", "x-stoplight": { "id": "nhn7l1c868f1m" }, "description": "Specifies if to continue running the pipeline after the related test fails." }, "runOrder": { "x-stoplight": { "id": "y9ara32tkqjwq" }, "example": "After", "default": "After", "type": "string", "description": "Column level tests run After." }, "templateString": { "type": "string", "x-stoplight": { "id": "ps1n748gyvrbh" }, "example": "\\n SELECT * FROM {{ ref(node.location.name, node.name)}} \\n WHERE \\\"L_ORDERKEY\\\" IS NULL", "description": "The SQL template for the test that will be executed. These are examples.\n\n**Unique** \n```sql\n templateString: |2-\n\n SELECT * FROM {{ ref(node.location.name, node.name)}} \n WHERE \"L_ORDERKEY\" IS NULL\n\n```\n\n**Null**\n\n```sql\n templateString: |2-\n\n SELECT \"L_ORDERKEY\", COUNT(*)\n FROM {{ ref(node.location.name, node.name)}} \n GROUP BY \"L_ORDERKEY\"\n HAVING COUNT(*) > 1\n```\n" } } } }, "": { "type": "boolean", "x-stoplight": { "id": "zvon55xirk1o4" }, "description": "[System Columns](/docs/build-your-pipeline/user-defined-nodes/node-config-options#system-columns) only appear as a column on Node initalization. These are considered [Dynamic Column Fields](/docs/build-your-pipeline/user-defined-nodes/node-metadata#dynamic-column-fields). They are given custom attributes which show in the metadata and are set to true to indicate it's a system column. \n", "default": true }, "isChangeTracking": { "type": "boolean", "x-stoplight": { "id": "tgh0wvcuj3rdh" }, "description": "If the column is change tracking. `isChangeTracking` will only appear in the metadata if the value is true.\nThese are considered [Dynamic Column Fields](/docs/build-your-pipeline/user-defined-nodes/node-metadata#dynamic-column-fields)." }, "isBusinessKey": { "type": "boolean", "x-stoplight": { "id": "6kzaczkwnjshm" }, "description": "If the column is a business key. `isBusinessKey` will only appear in the metadata if the value is true.\nThese are considered [Dynamic Column Fields](/docs/build-your-pipeline/user-defined-nodes/node-metadata#dynamic-column-fields)" }, "isSurrogateKey": { "type": "boolean", "x-stoplight": { "id": "ipy8augpze3ic" }, "description": "This is a [system column](/docs/build-your-pipeline/user-defined-nodes/node-config-options#system-columns). If you copy a Node, this will be in the Hydrated Metadata." }, "isSystemCreateDate": { "type": "boolean", "x-stoplight": { "id": "904lxeyneyz2i" }, "description": "This is a [system column](/docs/build-your-pipeline/user-defined-nodes/node-config-options#system-columns). If you copy a Node, this will be in the Hydrated Metadata." }, "isSystemUpdateDate": { "type": "boolean", "x-stoplight": { "id": "i60sck1jd0nlb" }, "description": "This is a [system column](/docs/build-your-pipeline/user-defined-nodes/node-config-options#system-columns). If you copy a Node, this will be in the Hydrated Metadata." }, "isSystemRecordSource": { "type": "boolean", "x-stoplight": { "id": "64zk1liatvc3u" }, "description": "This is a [system column](/docs/build-your-pipeline/user-defined-nodes/node-config-options#system-columns). If you copy a Node, this will be in the Hydrated Metadata." } } } }, "storageLocations": { "type": "array", "description": "All Workspace Storage Locations. There can be multiple locations. Review the Node metadata to get the location.", "items": { "type": "object", "properties": { "database": { "type": "string", "description": "Name of database storage location is mapped to.", "example": "DOCS_HYDRATED_METADATA" }, "schema": { "type": "string", "description": "Name of schema the Storage Location is mapped to.", "example": "DEV" }, "name": { "type": "string", "description": "Name of the Storage Location.", "example": "DEV" } } } }, "config": { "type": "object", "description": "Any of the [Generic UI](/docs/build-your-pipeline/user-defined-nodes/node-config-options#generic-ui-elements) elements and [Customizable Core UI Element](/docs/build-your-pipeline/user-defined-nodes/node-config-options#customizable-core-ui-elements) created will appear here.\nReview the example Node to understand how the generic elements can appear.", "properties": { "truncateBefore": { "type": "boolean", "description": "This is a toggle button that determines if the data will be truncated before running this Node's INSERT script." }, "testsEnabled": { "type": "boolean", "description": "This toggle determines if user created tests will be run as part of the Node's script. Users can run column and Node level tests." }, "postSQL": { "type": "string", "description": "The SQL executed after DML stages executed by the Run command.", "example": "SELECT * FROM COALESCE" }, "preSQL": { "type": "string", "description": "The SQL executed before DML stages executed by the Run command.", "example": "SELECT * FROM COALESCE" }, "insertStrategy": { "description": "This is a dropdown selector that provides a choice of 3 strategies for combining multiple data sources. This is used when `multisourceToggle` is enabled.", "enum": [ "INSERT", "UNIQUE", "UNIQUE ALL" ] }, "": { "type": "string", "x-stoplight": { "id": "70djqp92at4z7" }, "description": "A generic [dropdown(/docs/build-your-pipeline/user-defined-nodes/node-config-options#dropdown-selector)] selector.\nGive it a custom attribute name to appear in the metadata." }, "": { "type": "boolean", "x-stoplight": { "id": "97k5l7m1pryau" }, "description": "Toggle between true and false.\nA generic [toggle](/docs/build-your-pipeline/user-defined-nodes/node-config-options#toggle-button) button.\nGive it a custom attribute name to appear in the metadata." }, "": { "type": "object", "x-stoplight": { "id": "4kdk5ikxlux8r" }, "description": "A tabular structure for collecting metadata. Each column in the component can be one of several types including:\n\n- `dropdownSelector`\n- `toggleButton`\n- `columnDropdownSelector`\n- `textBox`\n- `columnSelector`\nReview the metadata example and [Node Definition Reference](/docs/build-your-pipeline/user-defined-nodes/node-config-options#tabular-configuration-component).\nGive it a custom attribute name to appear in the metadata.", "properties": { "items": { "type": "array", "description": "Array of generic items added to the tabular object.\n\nFor example:\n\n```\n myTabularConfig:\n items:\n - myToggleButton2: false\n```", "items": { "type": "object" } } } }, "": { "type": "string", "x-stoplight": { "id": "ytriiynhpis6v" }, "description": "Allows users to enter any combination of characters including SQL statements that can include keyword highlighting.\nGive it a custom attribute name to appear in the metadata.\n\n[Textbox](/docs/build-your-pipeline/user-defined-nodes/node-config-options#text-box)" }, "": { "type": "string", "x-stoplight": { "id": "7idhx46kzmrz6" }, "description": "Let uses select from a list of objects.\nGive it a custom attribute name to appear in the metadata.\n[Drop down](/docs/build-your-pipeline/user-defined-nodes/node-config-options#dropdown-selector) selector" }, "": { "type": "object", "x-stoplight": { "id": "y0yhv7vcebm8g" }, "description": "[Column dropdown](/docs/build-your-pipeline/user-defined-nodes/node-config-options#column-dropdown-selector) selector.\nThis populates the column information based on the user selection and any custom logic. Review the column object for a full list of available values." } } }, "sources": { "type": "array", "description": "[Sources](/docs/build-your-pipeline/user-defined-nodes/node-metadata#sources) map your columns to their immediate parent nodes. Each source shows:\n\n* Which Node the data comes from.\n* Which column in that Node maps to your column.\n* Sources only tracks the direct predecessor and not the full Node lineage.\n", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the source. If there are multiple sources, each name will represent a different source object.\n\n```\n- name: SRC1\n- name: SRC2\n- name: SRC3\n```" }, "columns": { "type": "array", "description": "Node columns", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "An auto-generated Coalesce ID.", "example": "4c1e4719-b72b-41fe-82f6-7b6311475fdd" }, "name": { "type": "string", "description": "The name of the column.", "example": "L_PARTKEY" }, "dataType": { "type": "string", "description": "This is the data type for the column and by default maps to the source of the Node.", "example": "STRING" }, "description": { "type": "string", "description": "If there is a comment or description or it can be added here.", "example": "Column description" }, "nullable": { "type": "boolean", "description": "If a column can have null values" }, "defaultValue": { "type": "string", "description": "Default value of a column.", "example": "Coalesce" }, "tests": { "type": "array", "description": "Column level tests for null and unique values. Each test is in it's own object.\nIf there are no tests, shows as an empty array. \n`tests: []`", "items": { "type": "object", "properties": { "name": { "x-stoplight": { "id": "t9aledwyp2ulz" }, "default": "Null", "example": "\"Null\"", "enum": [ "Unique", "\"Null\"" ], "description": "Name of the test. Indicates if the test is Unique or \"Null\"" }, "description": { "type": "string", "x-stoplight": { "id": "0qt402zphg2bp" }, "example": "checks for any null values", "description": "Description of the test. \n* Null testing - `checks for any null values` \n* Unique value `check if value is unique`" }, "continueOnFailure": { "type": "boolean", "x-stoplight": { "id": "nhn7l1c868f1m" }, "description": "Specifies if to continue running the pipeline after the related test fails." }, "runOrder": { "x-stoplight": { "id": "y9ara32tkqjwq" }, "example": "After", "default": "After", "type": "string", "description": "Column level tests run After." }, "templateString": { "type": "string", "x-stoplight": { "id": "ps1n748gyvrbh" }, "example": "\\n SELECT * FROM {{ ref(node.location.name, node.name)}} \\n WHERE \\\"L_ORDERKEY\\\" IS NULL", "description": "The SQL template for the test that will be executed. These are examples.\n\n**Unique** \n```sql\n templateString: |2-\n\n SELECT * FROM {{ ref(node.location.name, node.name)}} \n WHERE \"L_ORDERKEY\" IS NULL\n\n```\n\n**Null**\n\n```sql\n templateString: |2-\n\n SELECT \"L_ORDERKEY\", COUNT(*)\n FROM {{ ref(node.location.name, node.name)}} \n GROUP BY \"L_ORDERKEY\"\n HAVING COUNT(*) > 1\n```\n" } } } }, "": { "type": "boolean", "x-stoplight": { "id": "zvon55xirk1o4" }, "description": "[System Columns](/docs/build-your-pipeline/user-defined-nodes/node-config-options#system-columns) only appear as a column on Node initalization. These are considered [Dynamic Column Fields](/docs/build-your-pipeline/user-defined-nodes/node-metadata#dynamic-column-fields). They are given custom attributes which show in the metadata and are set to true to indicate it's a system column. \n", "default": true }, "transform": { "type": "string", "example": "CAST(CURRENT_TIMESTAMP AS TIMESTAMP)", "description": "Any column transformations ad [column transformations](/docs/build-your-pipeline/transforms/)." }, "sourceColumns": { "type": "array", "description": "The node and column information for the source.", "items": { "$ref": "#/components/schemas/node" } }, "hashDetails": { "$ref": "#/components/schemas/hash_details", "x-stoplight": { "id": "8put5zjkkdsxs" }, "description": "Hash details only appear on columns that are hashed columns." } } } }, "join": { "type": "string", "description": "The Join statement for the source.", "example": "FROM {{ ref('WORK', 'STG_LINEITEM') }} \"STG_LINEITEM\"" }, "dependencies": { "type": "array", "description": "The Nodes here are from the JOIN condition and sources for the columns.\n", "items": { "$ref": "#/components/schemas/node" } }, "customSQL": { "type": "string", "description": "When a Node is created as a view, Override Create SQL lets a user enter custom SQL. The SQL entered will appear here.\n", "example": "{{ stage('Override Create SQL') }} \tCREATE OR REPLACE VIEW {{ ref('WORK', 'STG_SUPPLIER')}} AS ( \t\tSELECT \"S_SUPPKEY\" AS \"S_SUPPKEY\", \"S_NAME\" AS \"S_NAME\", \"S_ADDRESS\" AS \"S_ADDRESS\", \"S_NATIONKEY\" AS \"S_NATIONKEY\", \"S_PHONE\" AS \"S_PHONE\", \"S_ACCTBAL\" AS \"S_ACCTBAL\", \"S_COMMENT\" AS \"S_COMMENT\" FROM {{ ref('SAMPLE', 'SUPPLIER') }} \t)" } } } }, "node": { "$ref": "#/components/schemas/Node_Only", "description": "Contains information about the Node" }, "this": { "type": "string", "example": "\"{{ ref_no_link(node.location.name, node.name) }}\"", "description": "[This](/docs/build-your-pipeline/user-defined-nodes/node-metadata#this) refers to the Node. this refers to a templating reference that provides a shorthand way to reference the fully qualified name of the Node being worked on. " }, "parameters": { "type": "object", "description": "[Parameters](/docs/build-your-pipeline/user-defined-nodes/node-metadata#parameters) in the metadata represent runtime parameters that can be passed to templates. ", "properties": { "": { "type": "string", "x-stoplight": { "id": "ybkc5iqbtbcej" } }, "": { "type": "string", "x-stoplight": { "id": "zewneunkyoekm" } } } } } }, "node": { "type": "object", "x-examples": { "Example 1": { "node": { "id": "9ee5c8a0-b962-48ef-96c5-2e5e3e2516bc", "name": "NOSTROMO_SRC2", "nodeType": "Source", "location": { "name": "SAMPLE" }, "description": "", "materializationType": "table", "isMultisource": false, "override": { "create": { "enabled": false, "script": "" } }, "tests": [] }, "columns": [ { "id": "d0d3a1be-4068-4f5d-b61f-c74bf4952025", "name": "N_CREWKEY", "dataType": "NUMBER(38,0)", "description": "", "nullable": true, "defaultValue": "", "tests": [] }, { "id": "11611358-8d45-4284-ad77-d377ceb117dc", "name": "N_FIRSTNAME", "dataType": "VARCHAR(50)", "description": "", "nullable": true, "defaultValue": "", "tests": [] }, { "id": "8c45b2ed-1e76-4c1f-802c-8f39dd75de0c", "name": "N_MIDDLEINITIAL", "dataType": "VARCHAR(1)", "description": "", "nullable": true, "defaultValue": "", "tests": [] }, { "id": "30774bd2-455e-4211-95f0-2b9e45363dde", "name": "N_LASTNAME", "dataType": "VARCHAR(50)", "description": "", "nullable": true, "defaultValue": "", "tests": [] }, { "id": "01d323c6-5958-4e47-a521-219bad4ac172", "name": "N_COMMENT", "dataType": "VARCHAR(152)", "description": "", "nullable": true, "defaultValue": "", "tests": [] } ] } }, "title": "Node_Columns", "properties": { "node": { "type": "object", "description": "The Node source of the column. It only shows direct lineage.", "properties": { "id": { "type": "string", "description": "An autogenerated Node ID." }, "name": { "type": "string", "description": "The Node name." }, "nodeType": { "type": "string" }, "location": { "type": "object", "description": "Where the Node is located.", "properties": { "name": { "type": "string", "description": "The name of the Node Storage Location", "example": "WORK" } } }, "description": { "type": "string", "description": "The Node description." }, "materializationType": { "description": "The materialization of the Node. Table or View.\n", "enum": [ "table", "view" ] }, "isMultisource": { "type": "boolean", "description": "If the Node is Multi Source\n" }, "override": { "type": "object", "description": "If the `materializationType` is set to view, users can override Create SQL allows a user to override the DDL of a view, enabling greater flexibility in view creation. [Override Create SQL Toggle](/docs/build-your-pipeline/user-defined-nodes/node-config-options#view-ddl-override-or-override-create-sql-toggle).", "properties": { "create": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "If the user has toggled override to true or false." }, "script": { "type": "string", "description": "The custom script written in the Create SQL box." } } } } }, "tests": { "type": "array", "description": "Any Node level tests.", "items": { "type": "object", "properties": { "name": { "type": "string", "x-stoplight": { "id": "t76wvf2whc02k" }, "description": "Name of the test.", "example": "Test" }, "description": { "type": "string", "x-stoplight": { "id": "phj74ojrw4l4b" }, "description": "Description of the test." }, "continueOnFailure": { "type": "string", "x-stoplight": { "id": "58umzfj418h4m" }, "description": "If the pipeline should keep running, even if the Node test fails." }, "runOrder": { "x-stoplight": { "id": "8rmnoieeo4xfs" }, "enum": [ "Before", "After" ], "description": "If the test should run before or after the DML operation." }, "templateString": { "type": "string", "x-stoplight": { "id": "0hd2w6l2dyy5r" }, "description": "Any custom SQL that was added here.", "example": "SELECT * FROM COALESCE" } } } } } }, "columns": { "type": "array", "description": "The columns in the source node that it maps to.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "An auto-generated Coalesce ID.", "example": "4c1e4719-b72b-41fe-82f6-7b6311475fdd" }, "name": { "type": "string", "description": "The name of the column.", "example": "L_PARTKEY" }, "dataType": { "type": "string", "description": "This is the data type for the column and by default maps to the source of the Node.", "example": "NUMBER(38,0)" }, "description": { "type": "string", "description": "If there is a comment or description or it can be added here.", "example": "Column description" }, "nullable": { "type": "boolean", "description": "If a column can have null values" }, "defaultValue": { "type": "string", "description": "Default value of a column.", "example": "Coalesce" }, "tests": { "type": "array", "description": "Column level tests for null and unique values. Each test is in it's own object.\nIf there are no tests, shows as an empty array. \n`tests: []`", "items": { "type": "object", "properties": { "name": { "x-stoplight": { "id": "t9aledwyp2ulz" }, "default": "Null", "example": "\"Null\"", "enum": [ "Unique", "\"Null\"" ], "description": "Name of the test. Indicates if the test is Unique or \"Null\"" }, "description": { "type": "string", "x-stoplight": { "id": "0qt402zphg2bp" }, "example": "checks for any null values", "description": "Description of the test. \n* Null testing - `checks for any null values` \n* Unique value `check if value is unique`" }, "continueOnFailure": { "type": "boolean", "x-stoplight": { "id": "nhn7l1c868f1m" }, "description": "Specifies if to continue running the pipeline after the related test fails." }, "runOrder": { "x-stoplight": { "id": "y9ara32tkqjwq" }, "example": "After", "default": "After", "type": "string", "description": "Column level tests run After." }, "templateString": { "type": "string", "x-stoplight": { "id": "ps1n748gyvrbh" }, "example": "\\n SELECT * FROM {{ ref(node.location.name, node.name)}} \\n WHERE \\\"L_ORDERKEY\\\" IS NULL", "description": "The SQL template for the test that will be executed. These are examples.\n\n**Unique** \n```sql\n templateString: |2-\n\n SELECT * FROM {{ ref(node.location.name, node.name)}} \n WHERE \"L_ORDERKEY\" IS NULL\n\n```\n\n**Null**\n\n```sql\n templateString: |2-\n\n SELECT \"L_ORDERKEY\", COUNT(*)\n FROM {{ ref(node.location.name, node.name)}} \n GROUP BY \"L_ORDERKEY\"\n HAVING COUNT(*) > 1\n```\n" } } } } } } } } }, "Node_Only": { "title": "Node_Only", "x-stoplight": { "id": "b73t8n5drlxcb" }, "type": "object", "properties": { "id": { "type": "string", "description": "An autogenerated Node ID." }, "name": { "type": "string", "description": "The Node name." }, "nodeType": { "type": "string" }, "location": { "type": "object", "description": "Where the Node is located.", "properties": { "name": { "type": "string", "description": "The name of the Node Storage Location", "example": "WORK" } } }, "description": { "type": "string", "description": "The Node description." }, "materializationType": { "description": "The materialization of the Node. Table or View.\n", "enum": [ "table", "view" ] }, "isMultisource": { "type": "boolean", "description": "If the Node is Multi Source\n" }, "override": { "type": "object", "description": "If the `materializationType` is set to view, users can override Create SQL allows a user to override the DDL of a view, enabling greater flexibility in view creation. [Override Create SQL Toggle](/docs/build-your-pipeline/user-defined-nodes/node-config-options#view-ddl-override-or-override-create-sql-toggle).", "properties": { "create": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "If the user has toggled override to true or false." }, "script": { "type": "string", "description": "The custom script written in the Create SQL box." } } } } }, "tests": { "type": "array", "description": "Any Node level tests.", "items": { "type": "object", "properties": { "name": { "type": "string", "x-stoplight": { "id": "t76wvf2whc02k" }, "description": "Name of the test.", "example": "Test" }, "description": { "type": "string", "x-stoplight": { "id": "phj74ojrw4l4b" }, "description": "Description of the test." }, "continueOnFailure": { "type": "string", "x-stoplight": { "id": "58umzfj418h4m" }, "description": "If the pipeline should keep running, even if the Node test fails." }, "runOrder": { "x-stoplight": { "id": "8rmnoieeo4xfs" }, "enum": [ "Before", "After" ], "description": "If the test should run before or after the DML operation." }, "templateString": { "type": "string", "x-stoplight": { "id": "0hd2w6l2dyy5r" }, "description": "Any custom SQL that was added here.", "example": "SELECT * FROM COALESCE" } } } } } }, "hash_details": { "type": "object", "x-examples": { "Example 1": { "columns": [ { "id": "d2c711a3-8c20-4453-a152-9d71a0031f45", "name": "C_CUSTKEY", "dataType": "NUMBER(38,0)", "description": "", "nullable": false, "defaultValue": "", "tests": [], "transform": "", "sourceColumns": [ { "node": { "id": "d9d2dca5-7ec1-4401-b893-443a19419c36", "name": "STG_CUSTOMER", "nodeType": "Stage", "location": { "name": "SAMPLE" }, "description": "Hello", "materializationType": "table", "isMultisource": false, "override": { "create": { "enabled": false, "script": "" } }, "tests": [] }, "column": { "id": "e9cfcbf7-766b-4acc-90c5-c5f4801a64e1", "name": "C_CUSTKEY", "dataType": "NUMBER(38,0)", "description": "", "nullable": false, "defaultValue": "", "tests": [] } } ] } ], "algorithm": "SHA1" } }, "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "dataType": { "type": "string" }, "description": { "type": "string" }, "nullable": { "type": "boolean" }, "defaultValue": { "type": "string" }, "tests": { "type": "array", "items": { "type": "object" } }, "transform": { "type": "string" }, "sourceColumns": { "type": "array", "items": { "type": "object", "properties": { "node": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "nodeType": { "type": "string" }, "location": { "type": "object", "properties": { "name": { "type": "string" } } }, "description": { "type": "string" }, "materializationType": { "type": "string" }, "isMultisource": { "type": "boolean" }, "override": { "type": "object", "properties": { "create": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "script": { "type": "string" } } } } }, "tests": { "type": "array", "items": { "type": "object" } } } }, "column": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "dataType": { "type": "string" }, "description": { "type": "string" }, "nullable": { "type": "boolean" }, "defaultValue": { "type": "string" }, "tests": { "type": "array", "items": { "type": "object" } } } } } } } } } }, "algorithm": { "enum": [ "SHA1", "SHA256", "MD5" ], "description": "The type of alogorithm used." } } } } } }