Redis Streams · Schema

Redis Stream Info

Schema for Redis XINFO STREAM response, providing detailed stream metadata.

Consumer GroupsEvent-DrivenIn-MemoryMessagingRedisStreaming

Properties

Name Type Description
length integer Number of entries in the stream
radix-tree-keys integer Number of keys in the underlying radix tree
radix-tree-nodes integer Number of nodes in the underlying radix tree
last-generated-id string The last generated ID (may not be the last entry ID if entries were deleted)
max-deleted-entry-id string The maximum entry ID that was deleted from the stream
entries-added integer Total number of entries added to the stream over its lifetime
recorded-first-entry-id string The ID of the first entry in the stream
groups integer Number of consumer groups associated with the stream
first-entry object The first entry in the stream
last-entry object The last entry in the stream
View JSON Schema on GitHub

JSON Schema

redis-stream-info.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api-evangelist.com/schemas/redis-streams/redis-stream-info.json",
  "title": "Redis Stream Info",
  "description": "Schema for Redis XINFO STREAM response, providing detailed stream metadata.",
  "type": "object",
  "properties": {
    "length": {
      "type": "integer",
      "description": "Number of entries in the stream"
    },
    "radix-tree-keys": {
      "type": "integer",
      "description": "Number of keys in the underlying radix tree"
    },
    "radix-tree-nodes": {
      "type": "integer",
      "description": "Number of nodes in the underlying radix tree"
    },
    "last-generated-id": {
      "type": "string",
      "description": "The last generated ID (may not be the last entry ID if entries were deleted)"
    },
    "max-deleted-entry-id": {
      "type": "string",
      "description": "The maximum entry ID that was deleted from the stream"
    },
    "entries-added": {
      "type": "integer",
      "description": "Total number of entries added to the stream over its lifetime"
    },
    "recorded-first-entry-id": {
      "type": "string",
      "description": "The ID of the first entry in the stream"
    },
    "groups": {
      "type": "integer",
      "description": "Number of consumer groups associated with the stream"
    },
    "first-entry": {
      "type": "object",
      "description": "The first entry in the stream",
      "properties": {
        "id": {
          "type": "string"
        },
        "fields": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        }
      }
    },
    "last-entry": {
      "type": "object",
      "description": "The last entry in the stream",
      "properties": {
        "id": {
          "type": "string"
        },
        "fields": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          }
        }
      }
    }
  }
}