{
  "schema_version": 2,
  "id": "integrate/redis-data-integration/reference/cli/redis-di-scaffold",
  "title": "redis-di scaffold",
  "url": "https://redis.io/docs/latest/integrate/redis-data-integration/2.0.0/reference/cli/redis-di-scaffold/",
  "summary": "Generates pipeline configuration files",
  "content": "\nGenerates a starter pipeline configuration for the given source database type. With `--dir`, the\ncommand writes a `config.yaml` file and a `jobs/job.yaml` file into that directory, prompting\nbefore overwriting existing files unless `--force` is set. Without `--dir`, it prints the\nconfiguration to standard output.\n\n## Usage\n\n```\nredis-di scaffold [flags]\n```\n\n## Options\n\n| Option          | Description                                                                                                                     |\n| :-------------- | :------------------------------------------------------------------------------------------------------------------------------ |\n| `--db-type`     | Source database type (required): `mariadb`, `mongodb`, `mysql`, `oracle`, `postgresql`, `snowflake`, `sqlserver`, or `spanner`. |\n| `--db-flavor`   | Source database flavor: `mongodb-atlas`, `mongodb-replica-set`, or `mongodb-sharded-cluster`.                                   |\n| `--source-name` | Name of the generated source; defaults to the database type.                                                                    |\n| `--dir`         | Directory to write the configuration and job files to; prints the configuration to standard output when omitted.                |\n| `--force`       | Skip the confirmation prompt when overwriting an existing file.                                                                 |\n\nThis command also accepts the\n[global options](https://redis.io/docs/latest/integrate/redis-data-integration/reference/cli/redis-di#global-options).\n\n## Example\n\n```bash\n# Print a PostgreSQL configuration to stdout\nredis-di scaffold --db-type postgresql\n\n# Write a MySQL configuration into a directory\nredis-di scaffold --db-type mysql --dir /opt/rdi/config\n\n# Name the generated source 'inventory' instead of 'mysql'\nredis-di scaffold --db-type mysql --source-name inventory --dir /opt/rdi/config\n```\n",
  "tags": ["redis-di"],
  "last_updated": "2026-10-30T16:31:14Z"
}