Snowflake Data Validation - Documentation Index

Welcome to the Snowflake Data Validation CLI documentation. The Snowflake Data Validation CLI (snowflake-data-validation or sdv) is a comprehensive command-line tool for validating data migrations between source databases (SQL Server, Teradata, Amazon Redshift, Snowflake) and Snowflake. It provides multi-level validation strategies to ensure data consistency and quality, including Snowflake-to-Snowflake validation for cross-account or cross-region migrations.

Documentation roadmap

1. Command References by Database Dialect

Choose your source database for dialect-specific commands:

Each command reference includes:

  • Detailed syntax and options for all commands
  • Connection configuration specifics
  • Complete examples
  • Troubleshooting tips
  • Best practices for that platform

2. CLI Usage Guide - Comprehensive Reference

Start here for complete documentation.

A comprehensive, customer-facing guide covering all aspects of the CLI tool.

Contents:

  • Complete installation instructions
  • Detailed command reference for all source databases
  • In-depth configuration file reference with all options explained
  • Complete configuration examples
  • Advanced usage patterns
  • Troubleshooting guide

Best for:

  • First-time users getting started
  • Users needing detailed explanations of configuration options
  • Troubleshooting issues
  • Understanding all available features

3. Quick Reference Guide - Fast Lookup

Use this for quick lookups and reminders.

A concise reference guide with essential information in an easy-to-scan format.

Contents:

  • Command syntax at a glance
  • Quick configuration templates
  • Table configuration patterns
  • Common CLI options reference
  • Performance tips
  • Common issues and quick fixes

Best for:

  • Experienced users who need quick reminders
  • Looking up specific syntax
  • Quick configuration templates
  • Performance optimization tips

4. Configuration Examples - Ready-to-Use configurations

Copy and adapt these real-world examples.

A collection of ready-to-use configuration file examples for various scenarios.

Contents:

  • 16+ complete configuration examples
  • SQL Server configurations
  • Teradata configurations
  • Redshift configurations
  • Snowflake-to-Snowflake configurations
  • Scenario-based examples (dev, staging, production, PII-compliant, etc.)
  • Tips for adapting examples
  • Security best practices

Best for:

  • Jump-starting your configuration
  • Finding a configuration similar to your use case
  • Learning by example
  • Best practices for different scenarios

Quick Navigation by Task

The following sections provide quick references to the documentation for specific tasks.

Get Started

  1. Follow installation instructions in CLI Usage Guide
  2. Copy an example from Configuration Examples
  3. Run your first validation using the Quick Reference

Understand All Options

→ CLI Usage Guide - Configuration File Reference

Find a Command

→ Quick Reference - Common Commands

Create a Configuration File

→ Configuration Examples (pick the closest match to your scenario)

Troubleshoot an Issue

→ CLI Usage Guide - Troubleshooting

Optimize Performance

→ Quick Reference - Performance Tips

Validate Large Tables

→ CLI Usage Guide - Working with Large Tables

Understand Connection Options

→ CLI Usage Guide - Connection Configuration

Set Up Validation Levels

→ CLI Usage Guide - Validation Configuration

Configure Table-Specific Settings

→ CLI Usage Guide - Table Configuration

Configure View Validation

→ CLI Usage Guide - View Configuration

View Validation Examples

→ Configuration Examples - View Validation

Documentation by Source Database

The following sections provide quick references to the documentation for specific source databases.

SQL Server Users

Essential Reading:

  1. SQL Server Commands Reference - Complete command reference
  2. Quick Reference - SQL Server Connection
  3. CLI Usage Guide - SQL Server Commands
  4. Configuration Examples - SQL Server Examples

Key Examples:

Teradata Users

Essential Reading:

  1. Teradata Commands Reference - Complete command reference
  2. Quick Reference - Teradata Connection
  3. CLI Usage Guide - Teradata Commands
  4. Configuration Examples - Teradata Examples

Key Examples:

Amazon Redshift Users

Essential Reading:

  1. Amazon Redshift Commands Reference - Complete command reference
  2. Quick Reference - Redshift Connection
  3. CLI Usage Guide - Redshift Commands
  4. Configuration Examples - Redshift Examples

Key Examples:

Documentation by Use Case

Development Environment

Staging Environment

Production Environment

PII/Compliance Requirements

Migration Cutover

Continuous/Incremental Validation

View Validation

Validate database views alongside or separately from tables. Views are materialized into temporary tables for comparison.

Key Features:

  • Validate views with the same options as tables (column selection, filtering, column mappings)
  • Support for target database/schema/name overrides
  • Views are automatically materialized for accurate comparison

Snowflake-to-Snowflake Validation

Validate data between different Snowflake accounts, regions, or databases.

Essential Reading:

  1. Snowflake Commands Reference - Complete command reference
  2. CLI Usage Guide - Snowflake Commands
  3. Configuration Examples - Snowflake Examples

Key Features:

  • Cross-account validation with separate source and target credentials
  • IPC mode for direct connection parameter specification
  • Source-only validation with Parquet file export for offline comparison
  • Same validation capabilities as other source platforms (schema, metrics, row-level)

Configuration Reference

The following sections provide quick references to the documentation for specific configuration scenarios.

Quick Config Template

→ Quick Reference - Configuration Template

Complete Field Reference

→ CLI Usage Guide - Configuration File Reference

Real-World Examples

→ Configuration Examples

Common Workflows

The following sections provide quick references to the documentation for common workflows.

First-Time Setup Workflow

  1. Install the CLI

  2. Generate configuration template

  3. Copy and modify an example

  4. Run validation

  5. Review results

Troubleshooting Workflow

  1. Check error message

  2. Review configuration

  3. Enable debug logging

  4. Review logs

  5. Adjust configuration

Performance Optimization Workflow

  1. Review performance tips

  2. Enable chunking

  3. Adjust thread count

  4. Add filters

  5. Test with examples

Feature Matrix

FeatureCommand RefsQuick ReferenceUsage GuideExamples
Installation✓✓✓✓
Command Syntax✓✓✓✓✓✓✓✓
Configuration✓✓✓✓✓✓✓✓✓
Connection Setup✓✓✓✓✓✓✓✓✓✓
Table Config✓✓✓✓✓✓✓✓
View Config✓✓✓✓✓✓✓✓
Validation Levels✓✓✓✓✓✓
Performance✓✓✓✓✓✓✓
Troubleshooting✓✓✓✓✓✓✓✓
Examples✓✓✓✓✓✓✓✓

Legend: ✓ = Covered, ✓✓ = Good Coverage, ✓✓✓ = Comprehensive Coverage

Learning Path

Beginner Path

  1. Day 1: Understanding the Tool

  2. Day 2: First Validation

  3. Day 3: Configuration Mastery

Intermediate Path

  1. Optimize Performance

  2. Advanced Features

  3. CI/CD Integration

Expert Path

  1. Custom Templates

  2. Async Workflows

  3. Production Deployment

Search Tips

Finding Information Quickly

For Commands:

For Configuration:

For Errors:

Additional Support

If you cannot find what you need in these documents:

Email us at snowconvert-support@snowflake.com