Snowflake Data Validation - Documentation Index¶

1. Command References by Database Dialect¶

Choose your source database for dialect-specific commands:

• SQL Server Commands Reference - Complete SQL Server command documentation

• Teradata Commands Reference - Complete Teradata command documentation

• Amazon Redshift Commands Reference - Complete Redshift command documentation

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

• 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

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

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:

• Example 1: Minimal SQL Server Configuration

• Example 2: Production SQL Server with SSL/TLS

• Example 3: SQL Server Incremental Validation

• Example 4: SQL Server with Column Mappings

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:

• Example 5: Basic Teradata Configuration

• Example 6: Teradata Large-Scale Migration

• Example 7: Teradata Multi-Schema Validation

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:

• Example 8: Basic Redshift Configuration

• Example 9: Redshift Data Lake Migration

• Example 10: Redshift with Complex Filtering

Development Environment¶

• Configuration Example 11: Development Environment - Fast Validation

• Quick Reference - Common Commands

Staging Environment¶

• Configuration Example 12: Staging Environment - Comprehensive Testing

• CLI Usage Guide - Advanced Usage

Production Environment¶

• Configuration Example 13: Production - Maximum Performance

• CLI Usage Guide - Working with Large Tables

• Quick Reference - Performance Tips

PII/Compliance Requirements¶

• Configuration Example 14: PII-Compliant Validation

• CLI Usage Guide - Table Configuration

Migration Cutover¶

• Configuration Example 15: Migration Cutover Validation

• CLI Usage Guide - Advanced Usage

Continuous/Incremental Validation¶

• Configuration Example 16: Continuous Validation - Daily Incremental

• CLI Usage Guide - Advanced Usage

Quick Config Template¶

→ Quick Reference - Configuration Template

Complete Field Reference¶

→ CLI Usage Guide - Configuration File Reference

Real-World Examples¶

→ Configuration Examples

First-Time Setup Workflow¶

1. Install the CLI

   • → CLI Usage Guide - Installation

2. Generate configuration template

   • → Quick Reference - Get Templates

3. Copy and modify an example

   • → Configuration Examples

4. Run validation

   • → Quick Reference - Run Validation

5. Review results

   • → CLI Usage Guide - Validation Reports

Troubleshooting Workflow¶

1. Check error message

   • → CLI Usage Guide - Troubleshooting

2. Review configuration

   • → Quick Reference - Configuration Template

3. Enable debug logging

   • → CLI Usage Guide - Logging Configuration

4. Review logs

   • → CLI Usage Guide - Troubleshooting

5. Adjust configuration

   • → Configuration Examples

Performance Optimization Workflow¶

1. Review performance tips

   • → Quick Reference - Performance Tips

2. Enable chunking

   • → CLI Usage Guide - Working with Large Tables

3. Adjust thread count

   • → CLI Usage Guide - Global Configuration

4. Add filters

   • → CLI Usage Guide - Table Configuration

5. Test with examples

   • → Configuration Examples - Production

Beginner Path¶

1. Day 1: Understanding the Tool

   • Read the Main Project Repository

   • Skim CLI Usage Guide - Overview

   • Review Quick Reference

2. Day 2: First Validation

   • Follow CLI Usage Guide - Quick Start

   • Copy Configuration Example 1 or 5 or 8

   • Run your first validation

3. Day 3: Configuration Mastery

   • Read CLI Usage Guide - Configuration Reference

   • Review multiple Configuration Examples

   • Customize configuration for your needs

Intermediate Path¶

1. Optimize Performance

   • CLI Usage Guide - Working with Large Tables

   • Quick Reference - Performance Tips

2. Advanced Features

   • CLI Usage Guide - Advanced Usage

   • Configuration Examples - Scenario-Based

3. CI/CD Integration

   • CLI Usage Guide - CI/CD Integration

   • Configuration Examples - Continuous Validation

Expert Path¶

1. Custom Templates

   • CLI Usage Guide - Using Custom Query Templates

2. Async Workflows

   • CLI Usage Guide - Asynchronous Validation Workflow

3. Production Deployment

   • Configuration Example 13 & 15

Finding Information Quickly¶

For Commands:

• Look in Quick Reference first

• For details, see CLI Usage Guide - CLI Commands

For Configuration:

• Start with Quick Reference - Configuration Template

• For full details, see CLI Usage Guide - Configuration Reference

• For examples, see Configuration Examples

For Errors:

• Check CLI Usage Guide - Troubleshooting

• Review Quick Reference - Common Issues