数据源

Timeplus与各种系统相结合，作为数据来源，例如Apache Kafka。

您可以定义一个或多个源来设置后台任务将数据加载到Timeplus中。 更多详情请检查 数据导入 部分。

API 数据源

如果您需要调用 API 来创建数据源，以下是参考资料。

kafka

请参考 https://kafka.apache.org/

属性	必填项	描述	默认值
brokers	yes	指定broker地址列表。 这是一个以逗号分隔的字符串。 例如kafka1:9092,kafka2:9092,kafka3:9092
主题	yes	指定要连接的Kafka主题
offset	yes	指定Kafka offset配置。 支持latest,earliest
data_type	yes	指定用于创建流的数据类型。 支持json，text，avro，debezium-json，debezium-json-upsert
group	no	指定Kafka消费者组。 如果用户未指定，则使用带有timeplus-source前缀的源uuid作为默认值	timeplus-source-<uuid>
sasl	no	指定用于简单身份验证和安全层（SASL）的认证机制。 支持none，plain，scram-sha-256，scram-sha-512	none
用户名	no	指定用于身份验证的用户名
密码	no	指定用于身份验证的密码
tls.disable	no	如果设置为true，则禁用 TLS 加密	false
tls.skip_verify_server	no	如果设置为true，则在使用 TLS 时会跳过服务器证书验证	false
schema_registry_address	no	为Kafka指定架构注册表的URL，仅在data_type为avro时适用
schema_registry_api_key	no	为架构注册表身份验证指定API密钥
schema_registry_api_secret	no	为架构注册表身份验证指定API密钥

stream_generator

a source that generates random data for test

属性	必填项	描述	默认值
template	yes	指定用于生成数据的模板，支持iot，user_logins，devops
间隔	no	指定事件间隔。 例如：200ms	200ms

websocket

refer to https://developer.mozilla.org/en-US/docs/Web/API/WebSocket

属性	必填项	描述	默认值
url	yes	Specifies the URL of the websocket server url
open_message	no	An optional message to send to the server upon connection.
open_message_type	no	指定用于创建流的数据类型。 support json,text,	text
data_type	yes	指定用于创建流的数据类型。 support json,text,

nats

refer to https://docs.nats.io/nats-concepts/what-is-nats

属性	必填项	描述	默认值
url	yes	A list of URLs to connect to. for example [nats://127.0.0.1:4222]
subject	yes	A subject to consume from. A subject to consume from. Supports wildcards for consuming multiple subjects.
queue	no	An optional queue group to consume as.
nak_delay	no	An optional delay duration on redelivering a message when negatively acknowledged.
prefetch_count	no	The maximum number of messages to pull at a time.	524288
data_type	yes	指定用于创建流的数据类型。 support json,text,
tls.disable	no	如果设置为true，则禁用 TLS 加密	false
tls.skip_verify_server	no	如果设置为true，则在使用 TLS 时会跳过服务器证书验证	false

nats_jetstream

refer to https://docs.nats.io/nats-concepts/jetstream

属性	必填项	描述	默认值
url	yes	A list of URLs to connect to. for example [nats://127.0.0.1:4222]
subject	yes	A subject to consume from. A subject to consume from. Supports wildcards for consuming multiple subjects.
queue	no	An optional queue group to consume as.
durable	no	Preserve the state of your consumer under a durable name.
流 Stream	no	A stream to consume from. A stream to consume from. Either a subject or stream must be specified..
deliver	no	Determines which messages to deliver when consuming without a durable subscriber. support all last support all last	all
bind	no	A bool indicates that the subscription should use an existing consumer.
ack_wait	no	The maximum amount of time NATS server should wait for an ack from consumer.	30s
max_ack_pending	no	The maximum number of outstanding acks to be allowed before consuming is halted.	1024
data_type	yes	指定用于创建流的数据类型。 支持json，text
tls.disable	no	如果设置为true，则禁用 TLS 加密	false
tls.skip_verify_server	no	如果设置为true，则在使用 TLS 时会跳过服务器证书验证	false

pulsar

请参考https://pulsar.apache.org/

属性	必填项	描述	默认值
主题	yes	指定要连接的pulsar的主题
经纪网址	yes	指定要连接的broker URL
auth_type	yes	指定要使用的身份验证类型。 支持``，oauth2，token
auth_params	no	将身份验证参数指定为键值对	{}

livepeer

参考https://livepeer.org/

属性	必填项	描述	默认值
间隔	yes	指定livepeer api的拉取间隔。 例如：300s
api_key	yes	指定livepeer的API 密钥
data_type	yes	指定用于创建流的数据类型。 支持json，text

ably

参考https://ably.com/

属性	必填项	描述	默认值
api_key	yes	api_key的属性是一个字符串，用于对Ably服务进行身份验证和授权。 它代表与Ably账户关联的API密钥，是向Ably的服务发出经过身份验证的请求所需要的
channel	yes	channel的属性制定了向其发送消息或从中接收消息的channel的名称。 Ably中的channels用于对消息进行分组和分类。 这个属性允许你为互动选择目标渠道