How do I lint SQL before it merges using CircleCI?
Add a job to .circleci/config.yml that installs the Bruin CLI and runs bruin validate ./pipeline. It catches SQL that will not compile against the target warehouse before review time is spent on it. Store warehouse credentials as CircleCI contexts, and use a workflow queueing so two deploys can never write the same tables at once. Keep validation and deployment as separate jobs: validation should be fast and credential-free, deployment serialised and gated.
Command
bruin validate ./pipelineDefined in
YAML + CI
Works with
CircleCI + Bruin CLI
What you get
How to do it
- 1
Create or open .circleci/config.yml in your repository.
- 2
Install the Bruin CLI as a step: curl -LsSf https://getbruin.com/install/cli | sh.
- 3
Add bruin validate ./pipeline as the job's command.
- 4
Store warehouse credentials as CircleCI contexts, never in the repository.
- 5
Add a workflow queueing so concurrent runs cannot write the same tables.
- 6
Make the job required for merge, so a failure actually blocks.
How it works in code
# .circleci/config.yml
- run: curl -LsSf https://getbruin.com/install/cli | sh
- run: bruin validate ./pipelineRun bruin validate ./pipeline and CircleCI fails the build when the pipeline does, before the change reaches production.
Worth knowing
A job that reports failures without failing the build gets ignored within weeks. Make it required. And give CI its own warehouse connection pointed at a scratch schema, because a pull request can come from anywhere and should never hold production credentials.
Other ways to do this
Bruin is not always the right answer. Here is where the alternatives are stronger.
| Option | When it is the better choice |
|---|---|
| Bruin | Wire bruin validate ./pipeline into CircleCI so pipeline changes get checked the same way application code does. |
| dbt in CI | The same pattern with dbt build and a state-based selector. Well documented, and the right choice if dbt is already your transformation layer. |
| A managed orchestrator | Tools like Dagster or Prefect Cloud handle scheduling and retries more richly than a CI runner, at the cost of another system to run. |
| Soda in CI | Soda's data-contract checks are the strongest documented option if formal contracts between teams are the main goal. |
Common questions
How do I run data pipelines in CircleCI?
Install the Bruin CLI in a job and run bruin validate ./pipeline. Validation needs no warehouse credentials; deployment reads them from CircleCI contexts.
How do I stop two CircleCI deploys running at once?
Use a workflow queueing. Two pipeline runs writing the same tables concurrently is the hardest data bug to diagnose, and it is entirely preventable.
Should validation and deployment be separate CircleCI jobs?
Yes. Validation should run on every pull request, take seconds, and need no credentials. Deployment should run on merge, be serialised, and be gated. Combining them makes validation slow and deployment unsafe.
Related use cases
Lint SQL before it merges with GitHub Actions
How do I lint SQL before it merges using GitHub Actions?
Linting in CILint SQL before it merges with GitLab CI
How do I lint SQL before it merges using GitLab CI?
Linting in CILint SQL before it merges with Bitbucket Pipelines
How do I lint SQL before it merges using Bitbucket Pipelines?
Deploy data pipelines like software
Open source. Validate on every pull request, deploy on merge, roll back with git.