{
  "id": "redis-di-describe",
  "title": "redis-di describe",
  "url": "https://redis.io/docs/latest/integrate/redis-data-integration/reference/cli/redis-di-describe/",
  "summary": "Describes a pipeline with its status",
  "tags": [
    "redis-di"
  ],
  "last_updated": "2026-07-13T12:40:14-05:00",
  "page_type": "content",
  "content_hash": "3e51a3e4575e71bc76ae2ffe109a34dad146098854bd2e8f444de57ad36c350b",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "Describes a pipeline, combining its configuration with its runtime status, components, errors, and\nmetrics in a human-readable, sectioned layout. `status` is an alias for this command.\n\nThe RDI version is not shown here, because it is a property of the API connection rather than of the\npipeline; use [`info`](https://redis.io/docs/latest/integrate/redis-data-integration/reference/cli/redis-di-info)\nto see it."
    },
    {
      "id": "usage",
      "title": "Usage",
      "role": "syntax",
      "text": "[code example]\n\nThe pipeline name is an optional argument that defaults to `default`."
    },
    {
      "id": "options",
      "title": "Options",
      "role": "parameters",
      "text": "This command takes only the\n[global options](https://redis.io/docs/latest/integrate/redis-data-integration/reference/cli/redis-di#global-options)."
    },
    {
      "id": "example",
      "title": "Example",
      "role": "example",
      "text": "[code example]\n\nTo watch the status update live, pair the command with `watch`:\n\n[code example]\n\nThe output has a section for each part of the pipeline, for example:\n\n[code example]"
    }
  ],
  "examples": [
    {
      "id": "usage-ex0",
      "language": "plaintext",
      "code": "redis-di describe [pipeline] [flags]",
      "section_id": "usage"
    },
    {
      "id": "example-ex0",
      "language": "bash",
      "code": "redis-di describe\nredis-di status my-pipeline",
      "section_id": "example"
    },
    {
      "id": "example-ex1",
      "language": "bash",
      "code": "watch -n 1 redis-di describe",
      "section_id": "example"
    },
    {
      "id": "example-ex2",
      "language": "plaintext",
      "code": "Name:     default\nActive:   yes\nStatus:   started\nCurrent:  yes\n\nSources:\n  Name   Type  Db Type  Connection        Sync Mode  Connected\n  ----   ----  -------  ----------        ---------  ---------\n  mysql  cdc   mysql    ${HOST_IP}:13000  streaming  yes\n\nTargets:\n  Name    Db Type   Connection        Connected\n  ----    -------   ----------        ---------\n  target  redis     ${HOST_IP}:12000  yes\n\nJobs:\n  Name                Source               Transformations  Outputs  Connections\n  ----                ------               ---------------  -------  -----------\n  address_job         inventory.addresses  1                1        target\n  customers_hash_job  inventory.customers  0                1        target\n\nComponents:\n  Name                Type                Version  Status\n  ----                ----                -------  ------\n  collector-api       collector-api       0.0.0    started\n  collector-source    debezium-collector  ...      started\n  processor           processor           0.0.0    started\n\nStatistics:\n  Name                       Total  Pending  Inserted  Updated  Deleted  Filtered  Rejected  Deduplicated  Last Arrival\n  ----                       -----  -------  --------  -------  -------  --------  --------  ------------  ------------\n  {rdi}:inventory.customers  4      0        4         0        0        0         0         0             2026-06-18T13:42:44Z",
      "section_id": "example"
    }
  ]
}