Oracle Database · Schema

Oracle Transactional Event Queue Message

Represents a message in Oracle Transactional Event Queues (TxEventQ), the Kafka-compatible event streaming system built into Oracle Database.

CloudDatabaseEnterpriseOracleREST APISQL

Properties

Name	Type	Description
key	stringnull	Message key used for partition assignment and ordering guarantees
value	object	The message payload content, can be any JSON value
headers	object	Optional message headers for metadata and routing
topic	string	Name of the TxEventQ topic
partition	integer	Partition number within the topic
offset	integer	Sequential offset of the message within its partition
timestamp	string	Timestamp when the message was produced or appended
timestampType	string	Type of timestamp

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://oracle.com/schemas/database/event-message.json",
  "title": "Oracle Transactional Event Queue Message",
  "description": "Represents a message in Oracle Transactional Event Queues (TxEventQ), the Kafka-compatible event streaming system built into Oracle Database.",
  "type": "object",
  "properties": {
    "key": {
      "type": ["string", "null"],
      "description": "Message key used for partition assignment and ordering guarantees"
    },
    "value": {
      "description": "The message payload content, can be any JSON value"
    },
    "headers": {
      "type": "object",
      "description": "Optional message headers for metadata and routing",
      "additionalProperties": {
        "type": "string"
      }
    },
    "topic": {
      "type": "string",
      "description": "Name of the TxEventQ topic"
    },
    "partition": {
      "type": "integer",
      "description": "Partition number within the topic",
      "minimum": 0
    },
    "offset": {
      "type": "integer",
      "format": "int64",
      "description": "Sequential offset of the message within its partition",
      "minimum": 0
    },
    "timestamp": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the message was produced or appended"
    },
    "timestampType": {
      "type": "string",
      "description": "Type of timestamp",
      "enum": ["CREATE_TIME", "LOG_APPEND_TIME"]
    }
  },
  "required": ["value"]
}