Get data from Apache Pulsar
Get data from an Apache Pulsar topic. You must create a connection to use this source function. See Create a connection for the DSP Apache Pulsar SSL Connector.
Function output schema
This function outputs records with the schema described in the following table.
Key | Description |
---|---|
key | The key of the record as a string. |
value | The payload of the record in bytes. |
topic | The name of the Pulsar topic where the record is stored, given as a string. |
messageId | The message ID of the record, given as a string. |
The following is an example of a typical record from the pulsar
function:
{ "key": "my-key", "value": "aGVsbG8gd29ybGQ=", "topic": "my-pulsar-topic", "messageId": 1:24 }
Required arguments
- connection_id
- Syntax: string
- Description: The ID of your Pulsar connection.
- Example: "576205b3-f6f5-4ab7-8ffc-a4089a95d0c4"
- topic
- Syntax: string
- Description: The name of the Pulsar topic.
- Example: "my-pulsar-topic"
SPL2 example
You can write the function by providing the arguments in this exact order.
| from pulsar("my-connection-id", "my-topic") |...;
Alternatively, you can use named arguments to list the arguments in any order. See the "Named arguments" section in SPL2 syntax for more details.
| from pulsar(topic: "my-topic", connection_id: "my-connection-id") |...;
Sink functions (Data Destinations) | Core scalar functions |
This documentation applies to the following versions of Splunk® Data Stream Processor: 1.0.1
Feedback submitted, thanks!