Templates

Streaming Event Contracts

Data Contract Template

Minseo (Len) Park

Growth at Soda

Ensure data from streaming event contracts is complete, structured, and reliable before it is used for event-driven data governance, producer-consumer alignment, and integration validation at scale.

Data contract description

This data contract is designed for Teknasyon, where application event streams feed an event-driven data platform used for downstream reporting and machine learning datasets at very large scale. In this use case, streaming_events governs the metadata for a user_interaction stream by defining which team owns it, which topic and environment it belongs to, which schema and version it should follow, and which platform and client versions it is expected to cover, so event definitions can be validated consistently before they move through Teknasyon’s broader ingestion and processing pipeline.

Dataset

Defines the dataset this contract applies to, including its source and scope. This is the single point of reference for what data is being validated and protected.

Dataset checks

Validations that apply to the dataset as a whole, including structural enforcement and basic delivery guarantees. This contract includes a schema check that disallows extra columns and unexpected column reordering, helping detect structural drift early. It also includes a row_count check to ensure the dataset is not empty before it is used downstream.

Column checks

Column-level rules to ensure completeness, correctness, and consistency for individual fields. This contract enforces that contract_name, event_name, product_app, owner_team, owner_contact, environment, topic_name, schema_ref, schema_version, platform, client_version_min, and expected_volume_band are not missing. It applies length guardrails to text-based metadata fields such as contract_name, event_name, product_app, owner_team, owner_contact, and topic_name; restricts environment,platform and expected_volume_band. It also enforces version-pattern formatting for schema_version and client_version_min, and applies a basic length guardrail to schema_ref so schema location metadata remains present and bounded.

streaming_events_data_contract.yaml

dataset

variables:
  CONTRACT_NAME:
    default: "teknasyon_streaming_event_contract"
  EVENT_NAME:
    default: "user_interaction"
  PRODUCT_APP:
    default: "Getcontact"
  OWNER_TEAM:
    default: "Mobile App Team"
  OWNER_CONTACT:
    default: "#mobile-app-support"
  ENVIRONMENT:
    default: "prod"
  TOPIC_NAME:
    default: "user_interaction_topic"
  SCHEMA_REF:
    default: "https://schemas.teknasyon.io/events/user_interaction.json"
  SCHEMA_VERSION:
    default: "1.0.0"
  PLATFORM:
    default: "ios"
  CLIENT_VERSION_MIN:
    default: "1.5.0"
  EXPECTED_VOLUME_BAND:
    default: "high"

checks:
  - schema:
      allow_extra_columns: false
      allow_other_column_order: false
  - row_count:
      threshold:
        must_be_greater_than: 0

columns:
  - name: contract_name
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Contract Name length"
          valid_min_length: 1
          valid_max_length: 128
  - name: event_name
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Event Name length"
          valid_min_length: 1
          valid_max_length: 128
  - name: product_app
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Product App name length"
          valid_min_length: 1
          valid_max_length: 128
  - name: owner_team
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Owner Team length"
          valid_min_length: 1
          valid_max_length: 64
  - name: owner_contact
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Owner Contact format"
          valid_min_length: 3
          valid_max_length: 128
  - name: environment
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Valid Environments"
          valid_values:
            - prod
            - rc
  - name: topic_name
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Topic Name length"
          valid_min_length: 1
          valid_max_length: 128
  - name: schema_ref
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Schema Location URL"
          valid_min_length: 5
          valid_max_length: 255
  - name: schema_version
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Schema Version format"
          valid_format:
            name: Version pattern
            regex: '^[0-9]+\.[0-9]+\.[0-9]+$'
  - name: platform
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Valid Platforms"
          valid_values:
            - ios
            - android
            - web
            - backend
            - multi
  - name: client_version_min
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Client Version format"
          valid_format:
            name: Version pattern
            regex: '^[0-9]+\.[0-9]+\.[0-9]+$'
  - name: expected_volume_band
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Expected Volume Band"
          valid_values

Data contract description

Dataset

Defines the dataset this contract applies to, including its source and scope. This is the single point of reference for what data is being validated and protected.

Dataset checks

Column checks

streaming_events_data_contract.yaml

dataset

variables:
  CONTRACT_NAME:
    default: "teknasyon_streaming_event_contract"
  EVENT_NAME:
    default: "user_interaction"
  PRODUCT_APP:
    default: "Getcontact"
  OWNER_TEAM:
    default: "Mobile App Team"
  OWNER_CONTACT:
    default: "#mobile-app-support"
  ENVIRONMENT:
    default: "prod"
  TOPIC_NAME:
    default: "user_interaction_topic"
  SCHEMA_REF:
    default: "https://schemas.teknasyon.io/events/user_interaction.json"
  SCHEMA_VERSION:
    default: "1.0.0"
  PLATFORM:
    default: "ios"
  CLIENT_VERSION_MIN:
    default: "1.5.0"
  EXPECTED_VOLUME_BAND:
    default: "high"

checks:
  - schema:
      allow_extra_columns: false
      allow_other_column_order: false
  - row_count:
      threshold:
        must_be_greater_than: 0

columns:
  - name: contract_name
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Contract Name length"
          valid_min_length: 1
          valid_max_length: 128
  - name: event_name
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Event Name length"
          valid_min_length: 1
          valid_max_length: 128
  - name: product_app
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Product App name length"
          valid_min_length: 1
          valid_max_length: 128
  - name: owner_team
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Owner Team length"
          valid_min_length: 1
          valid_max_length: 64
  - name: owner_contact
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Owner Contact format"
          valid_min_length: 3
          valid_max_length: 128
  - name: environment
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Valid Environments"
          valid_values:
            - prod
            - rc
  - name: topic_name
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Topic Name length"
          valid_min_length: 1
          valid_max_length: 128
  - name: schema_ref
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Schema Location URL"
          valid_min_length: 5
          valid_max_length: 255
  - name: schema_version
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Schema Version format"
          valid_format:
            name: Version pattern
            regex: '^[0-9]+\.[0-9]+\.[0-9]+$'
  - name: platform
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Valid Platforms"
          valid_values:
            - ios
            - android
            - web
            - backend
            - multi
  - name: client_version_min
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Client Version format"
          valid_format:
            name: Version pattern
            regex: '^[0-9]+\.[0-9]+\.[0-9]+$'
  - name: expected_volume_band
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Expected Volume Band"
          valid_values

Data contract description

streaming_events_data_contract.yaml

dataset

variables:
  CONTRACT_NAME:
    default: "teknasyon_streaming_event_contract"
  EVENT_NAME:
    default: "user_interaction"
  PRODUCT_APP:
    default: "Getcontact"
  OWNER_TEAM:
    default: "Mobile App Team"
  OWNER_CONTACT:
    default: "#mobile-app-support"
  ENVIRONMENT:
    default: "prod"
  TOPIC_NAME:
    default: "user_interaction_topic"
  SCHEMA_REF:
    default: "https://schemas.teknasyon.io/events/user_interaction.json"
  SCHEMA_VERSION:
    default: "1.0.0"
  PLATFORM:
    default: "ios"
  CLIENT_VERSION_MIN:
    default: "1.5.0"
  EXPECTED_VOLUME_BAND:
    default: "high"

checks:
  - schema:
      allow_extra_columns: false
      allow_other_column_order: false
  - row_count:
      threshold:
        must_be_greater_than: 0

columns:
  - name: contract_name
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Contract Name length"
          valid_min_length: 1
          valid_max_length: 128
  - name: event_name
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Event Name length"
          valid_min_length: 1
          valid_max_length: 128
  - name: product_app
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Product App name length"
          valid_min_length: 1
          valid_max_length: 128
  - name: owner_team
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Owner Team length"
          valid_min_length: 1
          valid_max_length: 64
  - name: owner_contact
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Owner Contact format"
          valid_min_length: 3
          valid_max_length: 128
  - name: environment
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Valid Environments"
          valid_values:
            - prod
            - rc
  - name: topic_name
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Topic Name length"
          valid_min_length: 1
          valid_max_length: 128
  - name: schema_ref
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Schema Location URL"
          valid_min_length: 5
          valid_max_length: 255
  - name: schema_version
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Schema Version format"
          valid_format:
            name: Version pattern
            regex: '^[0-9]+\.[0-9]+\.[0-9]+$'
  - name: platform
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Valid Platforms"
          valid_values:
            - ios
            - android
            - web
            - backend
            - multi
  - name: client_version_min
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Client Version format"
          valid_format:
            name: Version pattern
            regex: '^[0-9]+\.[0-9]+\.[0-9]+$'
  - name: expected_volume_band
    data_type: string
    checks:
      - missing:
      - invalid:
          name: "Expected Volume Band"
          valid_values

How to Enforce Data Contracts with Soda

Embed data quality through data contracts at any point in your pipeline.

# pip install soda-{data source} for other data sources

pip install soda-postgres

# verify the contract locally against a data source

soda contract verify -c contract.yml -ds ds_config.yml

# publish and schedule the contract with Soda Cloud

soda contract publish -c contract.yml -sc sc_config.yml

Check out the CLI documentation to learn more.

How to Automatically Create Data Contracts.
In one Click.

Automatically write and publish data contracts using Soda's AI-powered data contract copilot.

Make data contracts work in production

Business knows what good data looks like. Engineering knows how to deliver it at scale. Soda unites both, turning governance expectations into executable contracts.

Book a demo