{
  "id": "redis-di-scaffold",
  "title": "redis-di scaffold",
  "url": "https://redis.io/docs/latest/integrate/write-behind/reference/cli/redis-di-scaffold/",
  "summary": "Generates configuration files for Write-behind and Debezium (when ingesting data to Redis)",
  "tags": [
    "docs",
    "integrate",
    "rs",
    "rdi"
  ],
  "last_updated": "2026-04-01T08:10:08-05:00",
  "page_type": "content",
  "content_hash": "bc7df2c5c3f09d41a0b2797543718e228f6c2e3df831cee7346e343e54e04619",
  "sections": [
    {
      "id": "usage",
      "title": "Usage",
      "role": "syntax",
      "text": "[code example]"
    },
    {
      "id": "options",
      "title": "Options",
      "role": "parameters",
      "text": "- `loglevel`:\n\n  - Type: Choice(['DEBUG', 'INFO', 'WARN', 'ERROR', 'CRITICAL'])\n  - Default: `info`\n  - Usage: `--loglevel\n-log-level`\n\n- `db_type` (REQUIRED):\n\n  - Type: Choice([<DbType.MYSQL: 'mysql'>, <DbType.ORACLE: 'oracle'>, <DbType.POSTGRESQL: 'postgresql'>, <DbType.REDIS: 'redis'>, <DbType.SQLSERVER: 'sqlserver'>])\n  - Default: `none`\n  - Usage: `--db-type`\n\n  DB type\n\n- `strategy`:\n\n  - Type: Choice([<Strategy.INGEST: 'ingest'>, <Strategy.WRITE_BEHIND: 'write_behind'>])\n  - Default: `ingest`\n  - Usage: `--strategy`\n\n  Strategy\n\n  Output to directory or stdout\n\n- `directory`:\n\n  - Type: STRING\n  - Default: `none`\n  - Usage: `--dir`\n\n  Directory containing Write-behind configuration\n\n- `preview`:\n\n  - Type: Choice(['debezium/application.properties', 'config.yaml'])\n  - Default: `none`\n  - Usage: `--preview`\n\n  Print the content of specified config file to CLI output\n\n- `help`:\n\n  - Type: BOOL\n  - Default: `false`\n  - Usage: `--help`\n\n  Show this message and exit."
    },
    {
      "id": "cli-help",
      "title": "CLI help",
      "role": "content",
      "text": "[code example]"
    }
  ],
  "examples": [
    {
      "id": "usage-ex0",
      "language": "plaintext",
      "code": "Usage: redis-di scaffold [OPTIONS]",
      "section_id": "usage"
    },
    {
      "id": "cli-help-ex0",
      "language": "plaintext",
      "code": "Usage: redis-di scaffold [OPTIONS]\n\n  Generates configuration files for Write-behind and Debezium (when ingesting data to\n  Redis)\n\nOptions:\n  -log-level, --loglevel [DEBUG|INFO|WARN|ERROR|CRITICAL]\n                                  [default: INFO]\n  --db-type [mysql|oracle|postgresql|redis|sqlserver]\n                                  DB type  [required]\n  --strategy [ingest|write_behind]\n                                  Strategy  [default: ingest]\n  Output formats: [mutually_exclusive, required]\n                                  Output to directory or stdout\n    --dir TEXT                    Directory containing Write-behind configuration\n    --preview [debezium/application.properties|config.yaml]\n                                  Print the content of specified config file\n                                  to CLI output\n  --help                          Show this message and exit.",
      "section_id": "cli-help"
    }
  ]
}