timeplus

Type:

Available in: Cloud, Self-Managed

Executes a streaming or table query on Timeplus Enterprise (Cloud or Self-Hosted) or the timeplusd component, and creates a structured message for each table row received.

If you execute a streaming query, this input runs until the query terminates. For table queries, it shuts down after all rows returned by the query are exhausted.

# Common configuration fields, showing default values
input:
  label: ""
  timeplus:
    query: select * from iot # No default (required)
    url: tcp://localhost:8463
    workspace: "" # No default (optional)
    apikey: "" # No default (optional)
    username: "" # No default (optional)
    password: "" # No default (optional)
yml

Examples

You must generate an API key using the web console of Timeplus Enterprise (Cloud).

input:
  timeplus:
    url: https://us-west-2.timeplus.cloud
    workspace: <workspace-id>
    query: select * from <table-name>
    apikey: <api-key>
yaml

Replace the following placeholders with your own values:

  • <workspace-id>: The ID of the workspace you want to read messages from.

  • <table-name>: The table you want to query.

  • <api-key>: The API key for Timeplus Enterprise REST API.

Fields

query

The query to execute on Timeplus Enterprise (Cloud or Self-Hosted) or timeplusd.

Type: string

# Examples
query: select * from iot
query: select count(*) from table(iot)
yml

url

The URL of your Timeplus instance, which should always include the schema and host.

Type: string

Default: tcp://localhost:8463

# Examples
url: http://localhost:8000
url: http://127.0.0.1:3218
yml

workspace

The ID of the workspace you want to read messages from. This field is required if you are connecting to Timeplus Enterprise (Cloud or Self-Hosted) using HTTP.

Type: string

apikey

The API key for the Timeplus Enterprise REST API. You need to generate the key in the web console of Timeplus Enterprise (Cloud). This field is required if you are reading messages from Timeplus Enterprise (Cloud).

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets.

Type: string

username

The username for the Timeplus application server. This field is required if you are reading messages from Timeplus Enterprise (Self-Hosted) or timeplusd.

Type: string

password

The password for the Timeplus application server. This field is required if you are reading messages from Timeplus Enterprise (Self-Hosted) or timeplusd.

This field contains sensitive information that usually shouldn’t be added to a configuration directly. For more information, see Secrets.

Type: string