Git Sync

name: > the model's display name. the model's slug is the YAML filename
source: > the name/slug of the source. the slug is visible on the source page
type: > one of: raw_sql, table, or dbt_model
dbtModel: > null or the name of the dbt model to select, written as `model.<package_name>.<model_name>`
rawSql: > null or the sql to use, for example, select * from albums
tableName: > null or the table name to use
isSchema: > used internally by Hightouch, this should always be false
primaryKey: > primary key column for this model, for example, album_id

model: > slug of the model for this sync (its YAML filename, without .yaml)
destination: > destination name/slug for this sync
config:
    > destination dependent configuration for this sync.
schedule: > type of schedule to use. the format here varies based on the
            schedule selected, we recommend using the UI as a starting point.
schedulePaused: > boolean, where this sync is paused, or enabled.

primaryLabel: "primary_label_column" # Optional
secondaryLabel: "secondary_label_column" # Optional

eventTimestampColumn: "column_name" # Required

from:
  relationshipName: "" # Relationship name for from -> to
  slug: "model_slug"
  mergeColumns: false # or true
to:
  relationshipName: "" # Relationship name for to -> from
  slug: "model_slug"
  mergeColumns: false
cardinality: "1:1" # One of: "1:1", "1:many", "many:1"
mapping:
  - fromColumn: ""
    toColumn: ""

name: "relationship name"
from:
  slug: "model_slug"
to:
  slug: "model_slug"
through:
  # List of relationship slugs that constitute this through relationship.
  - relationship_slug_1
  - relationship_slug_2

name: > name of the domain
description: > optional: description for the domain
onUndeclaredSchema: > optional: one of "ALLOW_EVENT" (default) or "BLOCK_EVENT" — legacy layout only
sources: > optional: list of event-source slugs this domain is attached to

type: > one of "track", "identify", "group", "page", "screen", or "alias"
name: > for track events, the event name; otherwise should not be present
version: > optional: the version of the event; defaults to "default"
onSchemaViolation: > optional: one of "ALLOW_EVENT" (default) or "BLOCK_EVENT"
onUndeclaredFields: > optional: one of "ALLOW_EVENT" (default), "BLOCK_EVENT", or "OMIT_FIELDS"
includeBuiltInContext: > optional: one of "true" (default), or "false"
schema: |
  Schema object for validating the event, adhering to the JSON Schema spec
  Usually the root of this schema is an object which contains a nested object named properties

# events/domains/web/sample-event-web-default.yaml
name: Sample Event
onSchemaViolation: ALLOW_EVENT
onUndeclaredFields: ALLOW_EVENT
schema:
  type: object # The root of our schema is an object
  properties: # Objects contain a "properties" element in the JSON Schema spec
    properties: # We define a single child named properties
      type: object # Which is an object
      properties: # Finally, the properties our child object contains
        id: # Which is only an optional id field
          type: string # Which is of type string
type: track
version: default

{
  "type": "object",
  "properties": {
    "properties": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        }
      }
    }
  }
}

name: > name of the component
version: > optional: the version of the component; defaults to "default"
description: > optional: description for the component
sources: > optional: list of event-source slugs this component applies to
schema: |
  Schema object for the component, adhering to the JSON Schema spec.
  Imports of other components are represented as $ref values inside this schema.

# READ ONLY FILE
# Changes made here will be ignored. Please use the Hightouch dashboard to create and edit sources and destinations.

sources:
  production-postgres:
    name: Production postgres
    type: postgres
   snowflake-243-tenant:
    name: Snowflake EU instance
    type: snowflake
destinations:
  production-salesforce:
    name: Production Salesforce
    type: salesforce

# e.g. aliases-hightouch-production-workspace.yaml
sources:
  my-source-alias: my-actual-source-id
  othersourcealias: another-workspace-source
destinations:
  my-destination-alias: existing-destination

name: Stocking list
source: staging-postgres
type: table
tableName: public.workspaces
isSchema: false
primaryKey: id

# aliases-acme-staging.yaml
sources:
  aliased-postgres: staging-postgres

# aliases-acme-production.yaml
sources:
  aliased-postgres: production-postgres

name: Stocking list
- source: staging-postgres
+ source: aliased-postgres
type: table
tableName: public.workspaces
isSchema: false
primaryKey: id

#!/bin/bash
# validate-git-sync-yaml.sh
# Validates model and sync YAML files for required fields.

set -euo pipefail

ERRORS=0

# Validate model files
for file in models/*.yaml; do
  [ -f "$file" ] || continue
  for field in name source type primaryKey; do
    if ! yq -e ".$field" "$file" > /dev/null 2>&1; then
      echo "ERROR: $file is missing required field '$field'"
      ERRORS=$((ERRORS + 1))
    fi
  done
done

# Validate sync files
for file in syncs/*.yaml; do
  [ -f "$file" ] || continue
  for field in model destination config schedule schedulePaused; do
    if ! yq -e ".$field" "$file" > /dev/null 2>&1; then
      echo "ERROR: $file is missing required field '$field'"
      ERRORS=$((ERRORS + 1))
    fi
  done
done

if [ "$ERRORS" -gt 0 ]; then
  echo "$ERRORS validation error(s) found."
  exit 1
fi

echo "All YAML files passed validation."

Protected branch update failed - Changes must be made through a pull request