datacontract-cli 0.10.9__tar.gz → 0.10.10__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of datacontract-cli might be problematic. Click here for more details.
- {datacontract_cli-0.10.9/datacontract_cli.egg-info → datacontract_cli-0.10.10}/PKG-INFO +114 -101
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/README.md +109 -96
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/cli.py +7 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/data_contract.py +4 -2
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/engines/soda/check_soda_execute.py +5 -2
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/engines/soda/connections/duckdb.py +4 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/export/avro_converter.py +1 -1
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/export/sodacl_converter.py +1 -1
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/imports/avro_importer.py +142 -8
- datacontract_cli-0.10.10/datacontract/imports/dbt_importer.py +117 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/imports/glue_importer.py +2 -2
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/imports/importer.py +6 -1
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/imports/importer_factory.py +24 -6
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/imports/jsonschema_importer.py +6 -3
- datacontract_cli-0.10.10/datacontract/imports/spark_importer.py +134 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/integration/publish_datamesh_manager.py +10 -5
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/lint/resolve.py +72 -27
- datacontract_cli-0.10.10/datacontract/lint/schema.py +47 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/model/data_contract_specification.py +3 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/templates/datacontract.html +1 -1
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/templates/index.html +1 -1
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10/datacontract_cli.egg-info}/PKG-INFO +114 -101
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract_cli.egg-info/SOURCES.txt +6 -1
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract_cli.egg-info/requires.txt +4 -4
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/pyproject.toml +5 -5
- datacontract_cli-0.10.9/tests/test_schema.py → datacontract_cli-0.10.10/tests/test_export_complex_data_contract.py +41 -3
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_import_avro.py +41 -4
- datacontract_cli-0.10.10/tests/test_import_dbt.py +255 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_import_glue.py +1 -1
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_import_jsonschema.py +1 -1
- datacontract_cli-0.10.10/tests/test_import_spark.py +162 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_integration_datameshmanager.py +1 -1
- datacontract_cli-0.10.10/tests/test_resolve.py +114 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_test_dataframe.py +30 -21
- datacontract_cli-0.10.9/datacontract/lint/schema.py +0 -27
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/LICENSE +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/MANIFEST.in +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/__init__.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/breaking/breaking.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/breaking/breaking_rules.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/catalog/catalog.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/engines/__init__.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/engines/datacontract/check_that_datacontract_contains_valid_servers_configuration.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/engines/datacontract/check_that_datacontract_file_exists.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/engines/datacontract/check_that_datacontract_str_is_valid.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/engines/fastjsonschema/check_jsonschema.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/engines/fastjsonschema/s3/s3_read_files.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/engines/soda/__init__.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/engines/soda/connections/bigquery.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/engines/soda/connections/dask.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/engines/soda/connections/databricks.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/engines/soda/connections/kafka.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/engines/soda/connections/postgres.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/engines/soda/connections/snowflake.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/engines/soda/connections/sqlserver.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/engines/soda/connections/trino.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/export/__init__.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/export/avro_idl_converter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/export/bigquery_converter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/export/csv_type_converter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/export/dbml_converter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/export/dbt_converter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/export/exporter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/export/exporter_factory.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/export/go_converter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/export/great_expectations_converter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/export/html_export.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/export/jsonschema_converter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/export/odcs_converter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/export/protobuf_converter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/export/pydantic_converter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/export/rdf_converter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/export/spark_converter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/export/sql_converter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/export/sql_type_converter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/export/terraform_converter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/imports/bigquery_importer.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/imports/odcs_importer.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/imports/sql_importer.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/imports/unity_importer.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/init/download_datacontract_file.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/integration/publish_opentelemetry.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/lint/files.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/lint/lint.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/lint/linters/__init__.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/lint/linters/description_linter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/lint/linters/example_model_linter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/lint/linters/field_pattern_linter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/lint/linters/field_reference_linter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/lint/linters/notice_period_linter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/lint/linters/quality_schema_linter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/lint/linters/valid_constraints_linter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/lint/urls.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/model/breaking_change.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/model/exceptions.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/model/run.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/publish/publish.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/py.typed +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/templates/partials/datacontract_information.html +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/templates/partials/datacontract_servicelevels.html +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/templates/partials/datacontract_terms.html +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/templates/partials/definition.html +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/templates/partials/example.html +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/templates/partials/model_field.html +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/templates/partials/server.html +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/templates/style/output.css +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract/web.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract_cli.egg-info/dependency_links.txt +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract_cli.egg-info/entry_points.txt +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/datacontract_cli.egg-info/top_level.txt +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/setup.cfg +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_breaking.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_catalog.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_changelog.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_cli.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_description_linter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_documentation_linter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_download_datacontract_file.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_example_model_linter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_export_avro.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_export_avro_idl.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_export_bigquery.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_export_custom_exporter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_export_dbml.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_export_dbt_models.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_export_dbt_sources.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_export_dbt_staging_sql.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_export_go.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_export_great_expectations.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_export_html.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_export_jsonschema.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_export_odcs.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_export_protobuf.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_export_pydantic.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_export_rdf.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_export_sodacl.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_export_spark.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_export_sql.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_export_sql_query.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_export_terraform.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_field_constraint_linter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_field_pattern_linter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_field_reference_linter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_import_bigquery.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_import_odcs.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_import_sql.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_import_unity_file.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_integration_opentelemetry.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_lint.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_notice_period_linter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_quality_schema_linter.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_roundtrip_jsonschema.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_test_azure_parquet_remote.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_test_bigquery.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_test_databricks.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_test_examples_csv.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_test_examples_formats_valid.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_test_examples_inline.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_test_examples_json.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_test_examples_missing.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_test_kafka.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_test_kafka_remote.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_test_local_json.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_test_parquet.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_test_postgres.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_test_s3_csv.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_test_s3_delta.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_test_s3_json.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_test_s3_json_complex.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_test_s3_json_multiple_models.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_test_s3_json_remote.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_test_snowflake.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_test_sqlserver.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_test_trino.py +0 -0
- {datacontract_cli-0.10.9 → datacontract_cli-0.10.10}/tests/test_web.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: datacontract-cli
|
|
3
|
-
Version: 0.10.
|
|
3
|
+
Version: 0.10.10
|
|
4
4
|
Summary: The datacontract CLI is an open source command-line tool for working with Data Contracts. It uses data contract YAML files to lint the data contract, connect to data sources and execute schema and quality tests, detect breaking changes, and export to different formats. The tool is written in Python. It can be used as a standalone CLI tool, in a CI/CD pipeline, or directly as a Python library.
|
|
5
5
|
Author-email: Jochen Christ <jochen.christ@innoq.com>, Stefan Negele <stefan.negele@innoq.com>, Simon Harrer <simon.harrer@innoq.com>
|
|
6
6
|
Project-URL: Homepage, https://cli.datacontract.com
|
|
@@ -12,10 +12,10 @@ Requires-Python: >=3.10
|
|
|
12
12
|
Description-Content-Type: text/markdown
|
|
13
13
|
License-File: LICENSE
|
|
14
14
|
Requires-Dist: typer[all]<0.13,>=0.9
|
|
15
|
-
Requires-Dist: pydantic<2.
|
|
15
|
+
Requires-Dist: pydantic<2.9.0,>=2.8.2
|
|
16
16
|
Requires-Dist: pyyaml~=6.0.1
|
|
17
17
|
Requires-Dist: requests<2.33,>=2.31
|
|
18
|
-
Requires-Dist: fastapi==0.111.
|
|
18
|
+
Requires-Dist: fastapi==0.111.1
|
|
19
19
|
Requires-Dist: fastparquet==2024.5.0
|
|
20
20
|
Requires-Dist: python-multipart==0.0.9
|
|
21
21
|
Requires-Dist: rich~=13.7.0
|
|
@@ -64,10 +64,10 @@ Requires-Dist: ruff; extra == "dev"
|
|
|
64
64
|
Requires-Dist: pre-commit~=3.7.1; extra == "dev"
|
|
65
65
|
Requires-Dist: pytest; extra == "dev"
|
|
66
66
|
Requires-Dist: pytest-xdist; extra == "dev"
|
|
67
|
-
Requires-Dist: moto; extra == "dev"
|
|
67
|
+
Requires-Dist: moto==5.0.11; extra == "dev"
|
|
68
68
|
Requires-Dist: pymssql==2.3.0; extra == "dev"
|
|
69
69
|
Requires-Dist: kafka-python; extra == "dev"
|
|
70
|
-
Requires-Dist: trino==0.
|
|
70
|
+
Requires-Dist: trino==0.329.0; extra == "dev"
|
|
71
71
|
Requires-Dist: testcontainers<4.8,>=4.5; extra == "dev"
|
|
72
72
|
Requires-Dist: testcontainers[core]; extra == "dev"
|
|
73
73
|
Requires-Dist: testcontainers[minio]; extra == "dev"
|
|
@@ -300,16 +300,16 @@ Commands
|
|
|
300
300
|
Download a datacontract.yaml template and write it to file.
|
|
301
301
|
|
|
302
302
|
╭─ Arguments ──────────────────────────────────────────────────────────────────────────────────╮
|
|
303
|
-
│ location [LOCATION] The location (url or path) of the data contract yaml to create.
|
|
304
|
-
│ [default: datacontract.yaml]
|
|
303
|
+
│ location [LOCATION] The location (url or path) of the data contract yaml to create. │
|
|
304
|
+
│ [default: datacontract.yaml] │
|
|
305
305
|
╰──────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
306
306
|
╭─ Options ────────────────────────────────────────────────────────────────────────────────────╮
|
|
307
|
-
│ --template TEXT URL of a template or data contract
|
|
308
|
-
│ [default:
|
|
309
|
-
│ https://datacontract.com/datacontract.init.yaml]
|
|
310
|
-
│ --overwrite --no-overwrite Replace the existing datacontract.yaml
|
|
311
|
-
│ [default: no-overwrite]
|
|
312
|
-
│ --help Show this message and exit.
|
|
307
|
+
│ --template TEXT URL of a template or data contract │
|
|
308
|
+
│ [default: │
|
|
309
|
+
│ https://datacontract.com/datacontract.init.yaml] │
|
|
310
|
+
│ --overwrite --no-overwrite Replace the existing datacontract.yaml │
|
|
311
|
+
│ [default: no-overwrite] │
|
|
312
|
+
│ --help Show this message and exit. │
|
|
313
313
|
╰──────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
314
314
|
```
|
|
315
315
|
|
|
@@ -321,12 +321,12 @@ Commands
|
|
|
321
321
|
Validate that the datacontract.yaml is correctly formatted.
|
|
322
322
|
|
|
323
323
|
╭─ Arguments ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
|
324
|
-
│ location [LOCATION] The location (url or path) of the data contract yaml. [default: datacontract.yaml]
|
|
324
|
+
│ location [LOCATION] The location (url or path) of the data contract yaml. [default: datacontract.yaml] │
|
|
325
325
|
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
326
326
|
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
|
327
|
-
│ --schema TEXT The location (url or path) of the Data Contract Specification JSON Schema
|
|
328
|
-
│ [default: https://datacontract.com/datacontract.schema.json]
|
|
329
|
-
│ --help Show this message and exit.
|
|
327
|
+
│ --schema TEXT The location (url or path) of the Data Contract Specification JSON Schema │
|
|
328
|
+
│ [default: https://datacontract.com/datacontract.schema.json] │
|
|
329
|
+
│ --help Show this message and exit. │
|
|
330
330
|
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
331
331
|
```
|
|
332
332
|
|
|
@@ -338,28 +338,28 @@ Commands
|
|
|
338
338
|
Run schema and quality tests on configured servers.
|
|
339
339
|
|
|
340
340
|
╭─ Arguments ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
|
341
|
-
│ location [LOCATION] The location (url or path) of the data contract yaml. [default: datacontract.yaml]
|
|
341
|
+
│ location [LOCATION] The location (url or path) of the data contract yaml. [default: datacontract.yaml] │
|
|
342
342
|
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
343
343
|
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
|
344
|
-
│ --schema TEXT The location (url or path) of the Data Contract
|
|
345
|
-
│ Specification JSON Schema
|
|
346
|
-
│ [default:
|
|
347
|
-
│ https://datacontract.com/datacontract.schema.json]
|
|
348
|
-
│ --server TEXT The server configuration to run the schema and quality
|
|
349
|
-
│ tests. Use the key of the server object in the data
|
|
350
|
-
│ contract yaml file to refer to a server, e.g.,
|
|
351
|
-
│ `production`, or `all` for all servers (default).
|
|
352
|
-
│ [default: all]
|
|
353
|
-
│ --examples --no-examples Run the schema and quality tests on the example data
|
|
354
|
-
│ within the data contract.
|
|
355
|
-
│ [default: no-examples]
|
|
356
|
-
│ --publish TEXT The url to publish the results after the test
|
|
357
|
-
│ [default: None]
|
|
358
|
-
│ --publish-to-opentelemetry --no-publish-to-opentelemetry Publish the results to opentelemetry. Use environment
|
|
359
|
-
│ variables to configure the OTLP endpoint, headers, etc.
|
|
360
|
-
│ [default: no-publish-to-opentelemetry]
|
|
361
|
-
│ --logs --no-logs Print logs [default: no-logs]
|
|
362
|
-
│ --help Show this message and exit.
|
|
344
|
+
│ --schema TEXT The location (url or path) of the Data Contract │
|
|
345
|
+
│ Specification JSON Schema │
|
|
346
|
+
│ [default: │
|
|
347
|
+
│ https://datacontract.com/datacontract.schema.json] │
|
|
348
|
+
│ --server TEXT The server configuration to run the schema and quality │
|
|
349
|
+
│ tests. Use the key of the server object in the data │
|
|
350
|
+
│ contract yaml file to refer to a server, e.g., │
|
|
351
|
+
│ `production`, or `all` for all servers (default). │
|
|
352
|
+
│ [default: all] │
|
|
353
|
+
│ --examples --no-examples Run the schema and quality tests on the example data │
|
|
354
|
+
│ within the data contract. │
|
|
355
|
+
│ [default: no-examples] │
|
|
356
|
+
│ --publish TEXT The url to publish the results after the test │
|
|
357
|
+
│ [default: None] │
|
|
358
|
+
│ --publish-to-opentelemetry --no-publish-to-opentelemetry Publish the results to opentelemetry. Use environment │
|
|
359
|
+
│ variables to configure the OTLP endpoint, headers, etc. │
|
|
360
|
+
│ [default: no-publish-to-opentelemetry] │
|
|
361
|
+
│ --logs --no-logs Print logs [default: no-logs] │
|
|
362
|
+
│ --help Show this message and exit. │
|
|
363
363
|
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
364
364
|
```
|
|
365
365
|
|
|
@@ -473,7 +473,6 @@ models:
|
|
|
473
473
|
| `DATACONTRACT_BIGQUERY_ACCOUNT_INFO_JSON_PATH` | `~/service-access-key.json` | Service Access key as saved on key creation by BigQuery. If this environment variable isn't set, the cli tries to use `GOOGLE_APPLICATION_CREDENTIALS` as a fallback, so if you have that set for using their Python library anyway, it should work seamlessly. |
|
|
474
474
|
|
|
475
475
|
|
|
476
|
-
|
|
477
476
|
### Azure
|
|
478
477
|
|
|
479
478
|
Data Contract CLI can test data that is stored in Azure Blob storage or Azure Data Lake Storage (Gen2) (ADLS) in various formats.
|
|
@@ -493,11 +492,11 @@ servers:
|
|
|
493
492
|
|
|
494
493
|
Authentication works with an Azure Service Principal (SPN) aka App Registration with a secret.
|
|
495
494
|
|
|
496
|
-
| Environment Variable
|
|
497
|
-
|
|
498
|
-
| `DATACONTRACT_AZURE_TENANT_ID`
|
|
499
|
-
| `DATACONTRACT_AZURE_CLIENT_ID` | `3cf7ce49-e2e9-4cbc-a922-4328d4a58622`
|
|
500
|
-
| `DATACONTRACT_AZURE_CLIENT_SECRET` | `yZK8Q~GWO1MMXXXXXXXXXXXXX`
|
|
495
|
+
| Environment Variable | Example | Description |
|
|
496
|
+
|------------------------------------|----------------------------------------|------------------------------------------------------|
|
|
497
|
+
| `DATACONTRACT_AZURE_TENANT_ID` | `79f5b80f-10ff-40b9-9d1f-774b42d605fc` | The Azure Tenant ID |
|
|
498
|
+
| `DATACONTRACT_AZURE_CLIENT_ID` | `3cf7ce49-e2e9-4cbc-a922-4328d4a58622` | The ApplicationID / ClientID of the app registration |
|
|
499
|
+
| `DATACONTRACT_AZURE_CLIENT_SECRET` | `yZK8Q~GWO1MMXXXXXXXXXXXXX` | The Client Secret value |
|
|
501
500
|
|
|
502
501
|
|
|
503
502
|
|
|
@@ -527,13 +526,13 @@ models:
|
|
|
527
526
|
|
|
528
527
|
#### Environment Variables
|
|
529
528
|
|
|
530
|
-
| Environment Variable
|
|
531
|
-
|
|
532
|
-
| `DATACONTRACT_SQLSERVER_USERNAME`
|
|
533
|
-
| `DATACONTRACT_SQLSERVER_PASSWORD`
|
|
534
|
-
| `DATACONTRACT_SQLSERVER_TRUSTED_CONNECTION`
|
|
535
|
-
| `DATACONTRACT_SQLSERVER_TRUST_SERVER_CERTIFICATE` | `True` | Trust self-signed certificate
|
|
536
|
-
| `DATACONTRACT_SQLSERVER_ENCRYPTED_CONNECTION`
|
|
529
|
+
| Environment Variable | Example| Description |
|
|
530
|
+
|---------------------------------------------------|--------|----------------------------------------------|
|
|
531
|
+
| `DATACONTRACT_SQLSERVER_USERNAME` | `root` | Username |
|
|
532
|
+
| `DATACONTRACT_SQLSERVER_PASSWORD` | `toor` | Password |
|
|
533
|
+
| `DATACONTRACT_SQLSERVER_TRUSTED_CONNECTION` | `True` | Use windows authentication, instead of login |
|
|
534
|
+
| `DATACONTRACT_SQLSERVER_TRUST_SERVER_CERTIFICATE` | `True` | Trust self-signed certificate |
|
|
535
|
+
| `DATACONTRACT_SQLSERVER_ENCRYPTED_CONNECTION` | `True` | Use SSL |
|
|
537
536
|
|
|
538
537
|
|
|
539
538
|
|
|
@@ -564,8 +563,8 @@ models:
|
|
|
564
563
|
|
|
565
564
|
| Environment Variable | Example | Description |
|
|
566
565
|
|----------------------------------------------|--------------------------------------|-------------------------------------------------------|
|
|
567
|
-
| `DATACONTRACT_DATABRICKS_TOKEN`
|
|
568
|
-
| `DATACONTRACT_DATABRICKS_HTTP_PATH`
|
|
566
|
+
| `DATACONTRACT_DATABRICKS_TOKEN` | `dapia00000000000000000000000000000` | The personal access token to authenticate |
|
|
567
|
+
| `DATACONTRACT_DATABRICKS_HTTP_PATH` | `/sql/1.0/warehouses/b053a3ffffffff` | The HTTP path to the SQL warehouse or compute cluster |
|
|
569
568
|
|
|
570
569
|
|
|
571
570
|
### Databricks (programmatic)
|
|
@@ -610,7 +609,7 @@ run.result
|
|
|
610
609
|
|
|
611
610
|
Works with Spark DataFrames.
|
|
612
611
|
DataFrames need to be created as named temporary views.
|
|
613
|
-
Multiple temporary views are
|
|
612
|
+
Multiple temporary views are supported if your data contract contains multiple models.
|
|
614
613
|
|
|
615
614
|
Testing DataFrames is useful to test your datasets in a pipeline before writing them to a data source.
|
|
616
615
|
|
|
@@ -778,7 +777,7 @@ models:
|
|
|
778
777
|
│ * --format [jsonschema|pydantic-model|sodacl|dbt|dbt-sources|db The export format. [default: None] [required] │
|
|
779
778
|
│ t-staging-sql|odcs|rdf|avro|protobuf|great-expectati │
|
|
780
779
|
│ ons|terraform|avro-idl|sql|sql-query|html|go|bigquer │
|
|
781
|
-
│ y|dbml|spark]
|
|
780
|
+
│ y|dbml|spark] │
|
|
782
781
|
│ --output PATH Specify the file path where the exported data will be │
|
|
783
782
|
│ saved. If no path is provided, the output will be │
|
|
784
783
|
│ printed to stdout. │
|
|
@@ -929,18 +928,19 @@ models:
|
|
|
929
928
|
Create a data contract from the given source location. Prints to stdout.
|
|
930
929
|
|
|
931
930
|
╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
|
932
|
-
│ * --format [sql|avro|glue|bigquery|jsonschema|
|
|
933
|
-
│
|
|
934
|
-
│
|
|
935
|
-
│
|
|
936
|
-
│
|
|
937
|
-
│
|
|
938
|
-
│
|
|
939
|
-
│ --bigquery-
|
|
940
|
-
│ --bigquery-
|
|
941
|
-
│
|
|
942
|
-
│
|
|
943
|
-
│
|
|
931
|
+
│ * --format [sql|avro|glue|bigquery|jsonschema| The format of the source file. [default: None] [required] |
|
|
932
|
+
│ unity|spark] |
|
|
933
|
+
│ --source TEXT The path to the file or Glue Database that should be imported. │
|
|
934
|
+
│ [default: None] │
|
|
935
|
+
│ --glue-table TEXT List of table ids to import from the Glue Database (repeat for │
|
|
936
|
+
│ multiple table ids, leave empty for all tables in the dataset). │
|
|
937
|
+
│ [default: None] │
|
|
938
|
+
│ --bigquery-project TEXT The bigquery project id. [default: None] │
|
|
939
|
+
│ --bigquery-dataset TEXT The bigquery dataset id. [default: None] │
|
|
940
|
+
│ --bigquery-table TEXT List of table ids to import from the bigquery API (repeat for │
|
|
941
|
+
│ multiple table ids, leave empty for all tables in the dataset). │
|
|
942
|
+
│ [default: None] │
|
|
943
|
+
│ --help Show this message and exit. │
|
|
944
944
|
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
945
945
|
```
|
|
946
946
|
|
|
@@ -958,11 +958,11 @@ Available import options:
|
|
|
958
958
|
| `avro` | Import from AVRO schemas | ✅ |
|
|
959
959
|
| `glue` | Import from AWS Glue DataCatalog | ✅ |
|
|
960
960
|
| `protobuf` | Import from Protobuf schemas | TBD |
|
|
961
|
-
| `jsonschema` | Import from JSON Schemas | ✅
|
|
962
|
-
| `bigquery` | Import from BigQuery Schemas | ✅
|
|
961
|
+
| `jsonschema` | Import from JSON Schemas | ✅ |
|
|
962
|
+
| `bigquery` | Import from BigQuery Schemas | ✅ |
|
|
963
963
|
| `unity` | Import from Databricks Unity Catalog | partial |
|
|
964
964
|
| `dbt` | Import from dbt models | TBD |
|
|
965
|
-
| `odcs` | Import from Open Data Contract Standard (ODCS) | ✅
|
|
965
|
+
| `odcs` | Import from Open Data Contract Standard (ODCS) | ✅ |
|
|
966
966
|
| Missing something? | Please create an issue on GitHub | TBD |
|
|
967
967
|
|
|
968
968
|
|
|
@@ -1005,7 +1005,7 @@ export DATABRICKS_IMPORT_ACCESS_TOKEN=<token>
|
|
|
1005
1005
|
datacontract import --format unity --unity-table-full-name <table_full_name>
|
|
1006
1006
|
```
|
|
1007
1007
|
|
|
1008
|
-
|
|
1008
|
+
#### Glue
|
|
1009
1009
|
|
|
1010
1010
|
Importing from Glue reads the necessary Data directly off of the AWS API.
|
|
1011
1011
|
You may give the `glue-table` parameter to enumerate the tables that should be imported. If no tables are given, _all_ available tables of the database will be imported.
|
|
@@ -1022,6 +1022,15 @@ datacontract import --format glue --source <database_name> --glue-table <table_n
|
|
|
1022
1022
|
datacontract import --format glue --source <database_name>
|
|
1023
1023
|
```
|
|
1024
1024
|
|
|
1025
|
+
#### Spark
|
|
1026
|
+
|
|
1027
|
+
Importing from Spark table or view these must be created or accessible in the Spark context. Specify tables list in `source` parameter.
|
|
1028
|
+
|
|
1029
|
+
Example:
|
|
1030
|
+
|
|
1031
|
+
```bash
|
|
1032
|
+
datacontract import --format spark --source "users,orders"
|
|
1033
|
+
```
|
|
1025
1034
|
|
|
1026
1035
|
### breaking
|
|
1027
1036
|
|
|
@@ -1031,11 +1040,11 @@ datacontract import --format glue --source <database_name>
|
|
|
1031
1040
|
Identifies breaking changes between data contracts. Prints to stdout.
|
|
1032
1041
|
|
|
1033
1042
|
╭─ Arguments ───────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
|
1034
|
-
│ * location_old TEXT The location (url or path) of the old data contract yaml. [default: None] [required]
|
|
1035
|
-
│ * location_new TEXT The location (url or path) of the new data contract yaml. [default: None] [required]
|
|
1043
|
+
│ * location_old TEXT The location (url or path) of the old data contract yaml. [default: None] [required] │
|
|
1044
|
+
│ * location_new TEXT The location (url or path) of the new data contract yaml. [default: None] [required] │
|
|
1036
1045
|
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
1037
1046
|
╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
|
1038
|
-
│ --help Show this message and exit.
|
|
1047
|
+
│ --help Show this message and exit. │
|
|
1039
1048
|
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
1040
1049
|
```
|
|
1041
1050
|
|
|
@@ -1047,11 +1056,11 @@ datacontract import --format glue --source <database_name>
|
|
|
1047
1056
|
Generate a changelog between data contracts. Prints to stdout.
|
|
1048
1057
|
|
|
1049
1058
|
╭─ Arguments ───────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
|
1050
|
-
│ * location_old TEXT The location (url or path) of the old data contract yaml. [default: None] [required]
|
|
1051
|
-
│ * location_new TEXT The location (url or path) of the new data contract yaml. [default: None] [required]
|
|
1059
|
+
│ * location_old TEXT The location (url or path) of the old data contract yaml. [default: None] [required] │
|
|
1060
|
+
│ * location_new TEXT The location (url or path) of the new data contract yaml. [default: None] [required] │
|
|
1052
1061
|
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
1053
1062
|
╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
|
1054
|
-
│ --help Show this message and exit.
|
|
1063
|
+
│ --help Show this message and exit. │
|
|
1055
1064
|
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
1056
1065
|
```
|
|
1057
1066
|
|
|
@@ -1063,8 +1072,8 @@ datacontract import --format glue --source <database_name>
|
|
|
1063
1072
|
PLACEHOLDER. Currently works as 'changelog' does.
|
|
1064
1073
|
|
|
1065
1074
|
╭─ Arguments ───────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
|
1066
|
-
│ * location_old TEXT The location (url or path) of the old data contract yaml. [default: None] [required]
|
|
1067
|
-
│ * location_new TEXT The location (url or path) of the new data contract yaml. [default: None] [required]
|
|
1075
|
+
│ * location_old TEXT The location (url or path) of the old data contract yaml. [default: None] [required] │
|
|
1076
|
+
│ * location_new TEXT The location (url or path) of the new data contract yaml. [default: None] [required] │
|
|
1068
1077
|
╰───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
1069
1078
|
╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
|
1070
1079
|
│ --help Show this message and exit. │
|
|
@@ -1080,9 +1089,9 @@ datacontract import --format glue --source <database_name>
|
|
|
1080
1089
|
Create an html catalog of data contracts.
|
|
1081
1090
|
|
|
1082
1091
|
╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
|
|
1083
|
-
│ --files TEXT Glob pattern for the data contract files to include in the catalog. [default: *.yaml]
|
|
1084
|
-
│ --output TEXT Output directory for the catalog html files. [default: catalog/]
|
|
1085
|
-
│ --help Show this message and exit.
|
|
1092
|
+
│ --files TEXT Glob pattern for the data contract files to include in the catalog. [default: *.yaml] │
|
|
1093
|
+
│ --output TEXT Output directory for the catalog html files. [default: catalog/] │
|
|
1094
|
+
│ --help Show this message and exit. │
|
|
1086
1095
|
╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
|
|
1087
1096
|
```
|
|
1088
1097
|
|
|
@@ -1104,19 +1113,22 @@ datacontract import --format glue --source <database_name>
|
|
|
1104
1113
|
|
|
1105
1114
|
## Integrations
|
|
1106
1115
|
|
|
1107
|
-
| Integration
|
|
1108
|
-
|
|
1109
|
-
| Data Mesh Manager
|
|
1110
|
-
|
|
|
1116
|
+
| Integration | Option | Description |
|
|
1117
|
+
|-----------------------|------------------------------|---------------------------------------------------------------------------------------------------------------|
|
|
1118
|
+
| Data Mesh Manager | `--publish` | Push full results to the [Data Mesh Manager API](https://api.datamesh-manager.com/swagger/index.html) |
|
|
1119
|
+
| Data Contract Manager | `--publish` | Push full results to the [Data Contract Manager API](https://api.datacontract-manager.com/swagger/index.html) |
|
|
1120
|
+
| OpenTelemetry | `--publish-to-opentelemetry` | Push result as gauge metrics |
|
|
1111
1121
|
|
|
1112
1122
|
### Integration with Data Mesh Manager
|
|
1113
1123
|
|
|
1114
|
-
If you use [Data Mesh Manager](https://datamesh-manager.com/), you can use the data contract URL and append the `--publish` option to send and display the test results. Set an environment variable for your API key.
|
|
1124
|
+
If you use [Data Mesh Manager](https://datamesh-manager.com/) or [Data Contract Manager](https://datacontract-manager.com/), you can use the data contract URL and append the `--publish` option to send and display the test results. Set an environment variable for your API key.
|
|
1115
1125
|
|
|
1116
1126
|
```bash
|
|
1117
1127
|
# Fetch current data contract, execute tests on production, and publish result to data mesh manager
|
|
1118
1128
|
$ EXPORT DATAMESH_MANAGER_API_KEY=xxx
|
|
1119
|
-
$ datacontract test https://demo.datamesh-manager.com/demo279750347121/datacontracts/4df9d6ee-e55d-4088-9598-b635b2fdcbbc/datacontract.yaml
|
|
1129
|
+
$ datacontract test https://demo.datamesh-manager.com/demo279750347121/datacontracts/4df9d6ee-e55d-4088-9598-b635b2fdcbbc/datacontract.yaml \
|
|
1130
|
+
--server production \
|
|
1131
|
+
--publish https://api.datamesh-manager.com/api/test-results
|
|
1120
1132
|
```
|
|
1121
1133
|
|
|
1122
1134
|
### Integration with OpenTelemetry
|
|
@@ -1126,12 +1138,12 @@ If you use OpenTelemetry, you can use the data contract URL and append the `--pu
|
|
|
1126
1138
|
The metric name is "datacontract.cli.test.result" and it uses the following encoding for the result:
|
|
1127
1139
|
|
|
1128
1140
|
| datacontract.cli.test.result | Description |
|
|
1129
|
-
|
|
1130
|
-
| 0
|
|
1131
|
-
| 1
|
|
1132
|
-
| 2
|
|
1133
|
-
| 3
|
|
1134
|
-
| 4
|
|
1141
|
+
|------------------------------|---------------------------------------|
|
|
1142
|
+
| 0 | test run passed, no warnings |
|
|
1143
|
+
| 1 | test run has warnings |
|
|
1144
|
+
| 2 | test run failed |
|
|
1145
|
+
| 3 | test run not possible due to an error |
|
|
1146
|
+
| 4 | test status unknown |
|
|
1135
1147
|
|
|
1136
1148
|
|
|
1137
1149
|
```bash
|
|
@@ -1159,7 +1171,7 @@ Create a data contract based on the actual data. This is the fastest way to get
|
|
|
1159
1171
|
|
|
1160
1172
|
1. Use an existing physical schema (e.g., SQL DDL) as a starting point to define your logical data model in the contract. Double check right after the import whether the actual data meets the imported logical data model. Just to be sure.
|
|
1161
1173
|
```bash
|
|
1162
|
-
$ datacontract import --format sql ddl.sql
|
|
1174
|
+
$ datacontract import --format sql --source ddl.sql
|
|
1163
1175
|
$ datacontract test
|
|
1164
1176
|
```
|
|
1165
1177
|
|
|
@@ -1182,7 +1194,7 @@ Create a data contract based on the actual data. This is the fastest way to get
|
|
|
1182
1194
|
|
|
1183
1195
|
5. Set up a CI pipeline that executes daily and reports the results to the [Data Mesh Manager](https://datamesh-manager.com). Or to some place else. You can even publish to any opentelemetry compatible system.
|
|
1184
1196
|
```bash
|
|
1185
|
-
$ datacontract test --publish https://api.datamesh-manager.com/api/
|
|
1197
|
+
$ datacontract test --publish https://api.datamesh-manager.com/api/test-results
|
|
1186
1198
|
```
|
|
1187
1199
|
|
|
1188
1200
|
### Contract-First
|
|
@@ -1234,7 +1246,7 @@ Examples: adding models or fields
|
|
|
1234
1246
|
- Add the models or fields in the datacontract.yaml
|
|
1235
1247
|
- Increment the minor version of the datacontract.yaml on any change. Simply edit the datacontract.yaml for this.
|
|
1236
1248
|
- You need a policy that these changes are non-breaking. That means that one cannot use the star expression in SQL to query a table under contract. Make the consequences known.
|
|
1237
|
-
- Fail the build in the Pull Request if a datacontract.yaml
|
|
1249
|
+
- Fail the build in the Pull Request if a datacontract.yaml accidentally adds a breaking change even despite only a minor version change
|
|
1238
1250
|
```bash
|
|
1239
1251
|
$ datacontract breaking datacontract-from-pr.yaml datacontract-from-main.yaml
|
|
1240
1252
|
```
|
|
@@ -1435,10 +1447,11 @@ repos:
|
|
|
1435
1447
|
|
|
1436
1448
|
### Available Hook IDs
|
|
1437
1449
|
|
|
1438
|
-
| Hook ID | Description
|
|
1439
|
-
| ----------------- |
|
|
1440
|
-
| datacontract-lint | Runs the lint subcommand.
|
|
1441
|
-
| datacontract-test | Runs the test subcommand. Please look at
|
|
1450
|
+
| Hook ID | Description | Dependency |
|
|
1451
|
+
| ----------------- | -------------------------------------------------- | ---------- |
|
|
1452
|
+
| datacontract-lint | Runs the lint subcommand. | Python3 |
|
|
1453
|
+
| datacontract-test | Runs the test subcommand. Please look at | Python3 |
|
|
1454
|
+
| | [test](#test) section for all available arguments. | |
|
|
1442
1455
|
|
|
1443
1456
|
## Release Steps
|
|
1444
1457
|
|
|
@@ -1460,7 +1473,7 @@ We are happy to receive your contributions. Propose your change in an issue or d
|
|
|
1460
1473
|
|
|
1461
1474
|
## Related Tools
|
|
1462
1475
|
|
|
1463
|
-
- [Data
|
|
1476
|
+
- [Data Contract Manager](https://www.datacontract-manager.com/) is a commercial tool to manage data contracts. It contains a web UI, access management, and data governance for a full enterprise data marketplace.
|
|
1464
1477
|
- [Data Contract GPT](https://gpt.datacontract.com) is a custom GPT that can help you write data contracts.
|
|
1465
1478
|
- [Data Contract Editor](https://editor.datacontract.com) is an editor for Data Contracts, including a live html preview.
|
|
1466
1479
|
|