Prisma · Schema

StreamCreateRequest

Request to create a new named event stream

Properties

Name Type Description
name string Unique name for the stream. Used for resumability; reconnecting with the same name resumes from the last acknowledged position.
model string The Prisma model name to stream events for
filter object
View JSON Schema on GitHub

JSON Schema

prisma-streamcreaterequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/StreamCreateRequest",
  "title": "StreamCreateRequest",
  "type": "object",
  "description": "Request to create a new named event stream",
  "properties": {
    "name": {
      "type": "string",
      "description": "Unique name for the stream. Used for resumability; reconnecting with the same name resumes from the last acknowledged position.",
      "examples": [
        "all-user-events"
      ]
    },
    "model": {
      "type": "string",
      "description": "The Prisma model name to stream events for",
      "examples": [
        "User"
      ]
    },
    "filter": {
      "$ref": "#/components/schemas/EventFilter"
    }
  },
  "required": [
    "name",
    "model"
  ]
}