Sigma Data Model Manager

Overview

This tool lets you manage Sigma data models as code using GitHub for version control. Sigma is always the source of truth - this tool helps you track changes, review via PRs, and maintain history.

When changes are merged to your main branch, they automatically sync to Sigma via GitHub Actions.

Step 1: Get Sigma API Credentials

Log in to Sigma Computing
Go to Administration → Developer Access
Click Create New under Client Credentials
Copy the Client ID and Client Secret

⚠️ Save the Client Secret immediately - you cannot view it again!

Step 2: Set Up GitHub Repository

Create a new private GitHub repository
Download the repo template files and copy them to your repository
Your repo structure should look like:
- .github/workflows/ - automation workflows
- scripts/ - Python sync scripts
- data-models/ - your JSON files
- config.yml - configuration
Commit and push these files to your repo

Step 3: Configure GitHub Secrets & Variables

Go to your repo: Settings → Secrets and variables → Actions

Add Repository Secrets:

`SIGMA_CLIENT_ID`	Your Sigma API Client ID
`SIGMA_SECRET`	Your Sigma API Client Secret

Add Variables (click Variables tab):

`SIGMA_CLOUD`	`aws`, `azure`, or `gcp`
`SIGMA_FOLDER_ID`	Folder ID for new data models

Step 4: Enable Workflow Permissions

Go to Settings → Actions → General
Under Workflow permissions, select "Read and write permissions"
Check "Allow GitHub Actions to create and approve pull requests"
Click Save

Step 5: Create GitHub Personal Access Token

Go to github.com/settings/tokens
Click Generate new token (classic)
Select only the repo scope
Click Generate token
Copy the token (starts with ghp_)

Step 6: Find Your Sigma Folder ID

In Sigma, navigate to the folder where you want data models created
Look at the URL: ...sigmacomputing.com/.../folder/abc123xyz
The folder ID is the last part of the URL

Using This Tool

Enter your Sigma credentials above and click Connect to Sigma
Enter your GitHub token and repo (format: owner/repo-name)
Click Connect to GitHub
Select a data model to edit, or click + New to create one
Make changes and click Commit Changes

Commit Workflow:

On main branch: Commit automatically creates a new feature branch + PR to main for review
On feature branch: Commit pushes directly to that branch. When ready, click "Open PR to Main" button

This ensures all changes to main go through PR review before automatically syncing to Sigma! ✅

🌿 Branch Management & Workflow

Click the branch selector in the toolbar (or press Ctrl/Cmd + B) to:

Switch branches - View and edit models on different branches
Create feature branches - Create isolated branches for your changes

How commits work:

On main: Can't commit directly. Commits automatically create a new branch + PR for review
On feature branch: Commits push directly. Use "Open PR to Main" button when ready to merge

This workflow ensures main is always protected and changes sync to Sigma only after PR approval.

📜 Commit History & Restore

The History panel on the right shows all commits for the selected model:

View Diff - Compare any previous version to the current version side-by-side
Restore - Load a previous version into the editor, then commit to save it

Use this to review changes over time or roll back to a previous version.

⚠️ Sigma is the Source of Truth

This tool helps you version control and review changes, but Sigma is always the source of truth for your data models.

Changes made directly in Sigma's UI are not automatically synced to GitHub
Use ↻ Pull from Sigma to fetch the latest version from Sigma into this tool
Then commit those changes to keep GitHub in sync

💡 Best practice: Use "Pull from Sigma" regularly to ensure GitHub matches what's in Sigma.

⌨️ Keyboard Shortcuts

`Ctrl/Cmd + S`	Open commit modal
`Ctrl/Cmd + B`	Open branch management
`Esc`	Close any modal