reflekt-jaffle-shop

A demo Reflekt project showing how to:

• Define event schemas
• Pull schema(s) from a schema registry in JSONschema format.
• Push schema(s) to a schema registry for use in event validation.
• Lint schemas to enforce conventions and required metadata.
• Build data artifacts (e.g., dbt packages) based on schemas that model and document event data.

See the Getting Started, CI Suite, and Using data artifacts sections below to see how Reflekt can be used to define, manage, lint, model, and document event data.

Getting Started

• See the Reflekt Github repo for details on commands, schemas, registries, and project configuration.
• Event schemas are defined in the schemas/ directory.
• Data artifacts (e.g., dbt packages) are built in the artifacts/ directory.

CI Suite

Reflekt commands can be used in a CI/CD suite (e.g., GitHub Actions) to:

Trigger	Run	Result
PR Open/Push	reflekt lint	Lint schemas to ensure event and property naming conventions are followed. Check that required metadata is defined for events.
PR Merge	reflekt push	Push schemas from Reflekt project to a schema registry (Segment Protocols) for use in event validation.
PR Merge	reflekt build dbt	Build a dbt package that models and documents event data based on the schemas in a Reflekt project. Create a git tag for the dbt package so it can be easily imported in a downstream dbt project.

Using Data Artifacts

dbt packages

To use a Reflekt dbt package in a downstream dbt project, add it to the packages.yml of the dbt project.

dbt-core

packages:
  - git: "https://github.com/<your_user_or_org>/<your_repo>"  # Replace with Github repo URL for your Reflekt project
    subdirectory: "dbt-packages/<reflekt_dbt_package_name>"
    revision: v0.1.0__reflekt_dbt_package_name  # Example tag. Replace with branch, tag, or commit (full 40-character hash)

dbt-cloud

packages:
  - git: ""https://{{env_var('DBT_ENV_SECRET_GITHUB_PAT')}}@github.com/<your_user_or_org>/<your_repo>.git""  # Replace with your PAT and Github repo URL for your Reflekt project
    subdirectory: "dbt-packages/<reflekt_dbt_package_name>"
    revision: v0.1.0__reflekt_dbt_package_name  # Example tag. Replace with branch, tag, or commit (full 40-character hash)

To use with dbt-cloud, you will need to create a Github personal access token (e.g., DBT_ENV_SECRET_GITHUB_PAT) and configure it as an environment variable in your dbt-cloud account.

For local dbt development, you will need to set the environment variable on your local machine.

# Add the following line to your .zshrc, .bash_profile, etc.
export DBT_ENV_SECRET_GITHUB_PAT=MY_DBT_ENV_SECRET_GITHUB_PAT