# Synthesized Platform Documentation

> Source: https://docs.synthesized.io/tdk/latest/
> For the complete documentation index, see [llms.txt](https://docs.synthesized.io/llms.txt).

/\* Landing Page Inline Styles \*/ .card-grid-4 { display: grid !important; grid-template-columns: repeat(2, 1fr) !important; gap: 1.5rem !important; margin: 2rem 0 3rem 0 !important; width: 100% !important; } .feature-cards { display: grid !important; grid-template-columns: 1fr !important; gap: 2rem !important; margin: 2rem 0 3rem 0 !important; width: 100% !important; } .card-grid-4 .card { background: #f8f9fa; border: 1px solid #e9ecef; border-radius: 0.75rem; padding: 1.5rem; transition: all 0.3s ease; box-sizing: border-box; } .card-grid-4 .card:hover { transform: translateY(-4px); box-shadow: 0 8px 24px rgba(0, 0, 0, 0.1); border-color: rgb(14, 141, 135); } .feature-card { background: linear-gradient(135deg, #f8f9fa 0%, #ffffff 100%); border: 2px solid #e9ecef; border-radius: 1rem; padding: 2rem; transition: all 0.3s ease; box-sizing: border-box; } .feature-card:hover { transform: translateY(-6px); box-shadow: 0 12px 32px rgba(0, 0, 0, 0.12); } .feature-card.masking { border-left: 4px solid rgb(223, 66, 93); } .feature-card.generation { border-left: 4px solid rgb(14, 141, 135); } .feature-card.subsetting { border-left: 4px solid rgb(35, 83, 174); } .card h3, .feature-card h3 { margin-top: 0; margin-bottom: 0.75rem; font-size: 1.25rem; color: rgb(19, 6, 84); } .feature-card h3 { font-size: 1.5rem; } .card p, .feature-card p { margin-bottom: 1rem; color: #555; line-height: 1.6; } .card ul, .feature-card ul { margin: 0.5rem 0 1rem 0; padding-left: 1.25rem; } .card li, .feature-card li { margin-bottom: 0.5rem; color: #666; } .card a, .feature-card a { color: rgb(19, 6, 84); text-decoration: none; font-weight: 500; } .card a:hover, .feature-card a:hover { color: rgb(14, 141, 135); text-decoration: underline; } /\* Clickable card link styles \*/ .card-link, .feature-card-link { text-decoration: none !important; color: inherit; display: block; } .card-link:hover, .feature-card-link:hover { text-decoration: none !important; } .card-link h3, .feature-card-link h3 { color: rgb(19, 6, 84); } .card-link p, .feature-card-link p { color: #555; } .card-link li, .feature-card-link li { color: #666; } @media (max-width: 768px) { .card-grid-4 { grid-template-columns: 1fr !important; } }

Transform, generate, and subset production data with privacy-preserving data transformations. Deploy in minutes, scale efficiently, maintain referential integrity.

* * *

## Getting Started

[

### 5-Minute Quick Start

Get up and running in minutes

- Install with `docker-compose up`
- Run your first masking transformation
- See results in 5 minutes



](https://docs.synthesized.io/tdk/latest/user_guide/010_get_started/quickstart.html)[

### Connect Data Sources

Connect your databases quickly

- PostgreSQL, MySQL, Oracle, SQL Server
- JDBC URL examples
- Required permissions



](https://docs.synthesized.io/tdk/latest/user_guide/010_get_started/datasources.html)[

### Create Your First Workflow

Build and execute workflows

- YAML configuration basics
- Choose transformers
- Execute workflow



](https://docs.synthesized.io/tdk/latest/user_guide/010_get_started/workflow.html)[

### Core Concepts

Learn the fundamentals

- How masking works
- How generation works
- How subsetting works



](https://docs.synthesized.io/tdk/latest/user_guide/030_core_concepts/index.html)

* * *

## Guides by Use Case

[

### 🎭 Masking Data

Anonymize PII and sensitive data for non-production environments while preserving data utility and relationships.

- Mask specific column types (email, SSN, credit cards)
- 35+ built-in transformers
- Preserve referential integrity
- Incremental masking support



](https://docs.synthesized.io/tdk/latest/user_guide/020_guides/masking_data/index.html)[

### ✨ Generating Data

Create realistic synthetic test data that preserves statistical distributions and referential integrity.

- Categorical, numerical, and temporal generators
- Custom distributions and probabilities
- Maintain foreign key relationships
- Generate millions of rows



](https://docs.synthesized.io/tdk/latest/user_guide/020_guides/generating_data/index.html)[

### ✂️ Subsetting Data

Extract 10%, 25%, or 50% of production data for development and testing while maintaining referential integrity.

- Filter by date, ID range, or custom conditions
- Preserve foreign key relationships
- Combine with masking
- Target specific tables



](https://docs.synthesized.io/tdk/latest/user_guide/020_guides/subsetting_data/index.html)

* * *

## Deployment & Operations

[

### 🐳 Docker Compose

Production-ready deployment with Docker Compose



](https://docs.synthesized.io/tdk/latest/user_guide/050_deployment_operations/production_setup/dc.html)[

### ☸️ Kubernetes (Helm)

Deploy to Kubernetes with Helm charts



](https://docs.synthesized.io/tdk/latest/user_guide/050_deployment_operations/production_setup/helm.html)[

### 🔐 Security & SSO

Authentication, LDAP, Kerberos, RBAC



](https://docs.synthesized.io/tdk/latest/user_guide/060_security_compliance/index.html)[

### 🔧 Administration

User management, licensing, roles



](https://docs.synthesized.io/tdk/latest/user_guide/050_deployment_operations/administration/index.html)

* * *

## Reference & Advanced

[

### 📚 Transformers Reference

35+ built-in transformers for masking and generation



](https://docs.synthesized.io/tdk/latest/user_guide/040_reference/transformers/index.html)[

### 🔌 API Reference

REST API endpoints and CLI commands



](https://docs.synthesized.io/tdk/latest/user_guide/040_reference/api_reference/index.html)[

### 🎯 Advanced Workflows

Custom transformers, scripting, multi-mode workflows



](https://docs.synthesized.io/tdk/latest/user_guide/020_guides/advanced_workflows/index.html)[

### ❓ Troubleshooting

Common issues, performance tuning, diagnostic tools



](https://docs.synthesized.io/tdk/latest/user_guide/080_troubleshooting/index.html)

* * *

## Popular Topics

- [Database permissions setup](https://docs.synthesized.io/tdk/latest/user_guide/010_get_started/database_permissions)
- [JDBC connection examples](https://docs.synthesized.io/tdk/latest/user_guide/010_get_started/jdbc_url)
- [Configuration reference](https://docs.synthesized.io/tdk/latest/user_guide/040_reference/configuration/configuration_reference)
- [PII detection & protection](https://docs.synthesized.io/tdk/latest/user_guide/030_core_concepts/pii)
- [GitHub Actions integration](https://docs.synthesized.io/tdk/latest/user_guide/070_integrations/external_tools/github_actions)
- [Masking transformers](https://docs.synthesized.io/tdk/latest/user_guide/020_guides/masking_data/transformers)
- [Performance optimization](https://docs.synthesized.io/tdk/latest/user_guide/080_troubleshooting/performance/improving_performance)

* * *

## Need Help?

- [💬 FAQ](https://docs.synthesized.io/tdk/latest/faq/synthesized-platform) - Frequently asked questions
- [🐛 Report Issue](https://synthesized.atlassian.net/servicedesk/customer/portals) - Bug reports and feature requests
- [📧 Support](mailto:support@synthesized.io) - Get help from our team
