timeplus
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)
Examples
From Timeplus Enterprise Cloud via HTTP
You will need to create API Key on Timeplus Enterprise Cloud Web console first and then set the apikey
field.
input:
timeplus:
url: https://us-west-2.timeplus.cloud
workspace: my_workspace_id
query: select * from iot
apikey: <Your API Key>
From Timeplus Enterprise (self-hosted) via HTTP
For self-housted Timeplus Enterprise, you will need to specify the username and password as well as the URL of the App server
input:
timeplus:
url: http://localhost:8000
workspace: my_workspace_id
query: select * from iot
username: username
password: pw
Fields
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 Manage Secrets before adding it to your configuration. |
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 Manage Secrets before adding it to your configuration. |
Type: string
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)
url
The URL of your Timeplus instance, which should always include the schema and host.
Type: string
Default: tcp://localhost:8463