@emqx/shared-ui-i18n 0.0.57 → 0.0.58
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.js +2 -2
- package/dist/index.umd.cjs +2 -2
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -1368,7 +1368,7 @@ HGETALL mqtt_acl:\${username}`
|
|
|
1368
1368
|
disable_prepared_statements: "在连接中禁用预处理语句。某些端点(如事务模式下的 PGBouncer 或 Supabase)不支持会话功能(如预处理语句)。对于此类连接,应启用此选项。",
|
|
1369
1369
|
health_check_topic: "专用于精确检查健康状态的主题名称。",
|
|
1370
1370
|
max_records: "每个聚合对象允许的记录(事件)数量。每次聚合上传包含的事件数量不会超过此数值,但可能会更少。<br/>如果事件速率足够高,在同一时间间隔内显然可能会有多个聚合上传。这些上传将具有不同但连续的序列号,这些序列号将是 S3 对象键的一部分。",
|
|
1371
|
-
max_linger_time: "每个分区生产者,等待收集消息以形成批次的最长时间。<br/>默认值 <code>0</code> 表示不等待。对于非内存缓冲模式,建议至少配置 <code>5ms</code> 以减少 I/O
|
|
1371
|
+
max_linger_time: "每个分区生产者,等待收集消息以形成批次的最长时间。<br/>默认值 <code>0</code> 表示不等待。对于非内存缓冲模式,建议至少配置 <code>5ms</code> 以减少 I/O 操作。<br/>从 EMQX 5.10.2 及 6.0.1 开始,在写入内存缓冲区时没有等待时间。",
|
|
1372
1372
|
max_linger_bytes: "每个分区生产者,等待收集消息以形成批次的最大字节数。",
|
|
1373
1373
|
undefined_vars_as_null: "在写入数据库时,将未定义的变量视为 NULL。<br/>当启用此选项时,如果在模板中使用未定义的变量(例如 `${'{'}var{'}'}`),它们将被替换为 `NULL`,而不是字符串 `undefined`。如果此选项未启用(默认为关闭),可能会插入字符串 `undefined`。<br/>如果可能,此选项应始终设置为 `true`;默认值 `false` 仅用于确保向后兼容性。",
|
|
1374
1374
|
max_inactive: "HTTP 驱动在无任何活动时,尝试重连前的最大等待时间。",
|
|
@@ -1808,7 +1808,7 @@ For bridges only have ingress direction data flow, it can be set to 0 otherwise
|
|
|
1808
1808
|
disable_prepared_statements: "Disables the usage of prepared statements in the connections. Some endpoints, like PGBouncer or Supabase in Transaction mode, do not support session features such as prepared statements. For such connections, this option should be enabled.",
|
|
1809
1809
|
health_check_topic: "Topic name used exclusively for more accurate health checks.",
|
|
1810
1810
|
max_records: "Number of records (events) allowed per each aggregated object. Each aggregated upload will contain no more than that number of events, but may contain less.<br/>If event rate is high enough, there obviously may be more than one aggregated upload during the same time interval. These uploads will have different, but consecutive sequence numbers, which will be a part of S3 object key.",
|
|
1811
|
-
max_linger_time: "Maximum duration for a per-partition producer to wait for messages in order to collect a batch to buffer.<br/>The default value <code>0</code> means no wait. For non-memory buffer mode, it's advised to configure at least <code>5ms</code> for less IOPS.",
|
|
1811
|
+
max_linger_time: "Maximum duration for a per-partition producer to wait for messages in order to collect a batch to buffer.<br/>The default value <code>0</code> means no wait. For non-memory buffer mode, it's advised to configure at least <code>5ms</code> for less IOPS. <br/>There is no linger time when writing to memory buffer since EMQX 5.10.2 and 6.0.1.",
|
|
1812
1812
|
max_linger_bytes: "Maximum number of bytes for a per-partition producer to wait for messages in order to collect a batch to buffer.",
|
|
1813
1813
|
undefined_vars_as_null: "When writing to databases, treat undefined variables as NULL.<br/>When this option is enabled, if undefined variables (like `${'{'}var{'}'}`) are used in templates, they will be replaced with `NULL` instead of the string `undefined`. If this option is not enabled (default), the string `undefined` might be inserted.<br/>This option should always be `true` if possible; the default value `false` is only to ensure backward compatibility.",
|
|
1814
1814
|
max_inactive: "Maximum amount of time without any activity that the HTTP driver will wait before attempting to reconnect.",
|
package/dist/index.umd.cjs
CHANGED
|
@@ -80,7 +80,7 @@ HSET mqtt_acl:emqx_u 't/#' subscribe
|
|
|
80
80
|
|
|
81
81
|
# sample cmd
|
|
82
82
|
HGETALL mqtt_acl:\${username}`}},n={async:"Async",sync:"Sync",get:"GET",post:"POST",delete:"DELETE",put:"PUT",producer:"Producer",consumer:"Consumer",ns:"nanosecond",us:"microsecond",ms:"millisecond",s:"second",none:"None",base64:"Base64",json:"JSON",authentication_auth_gssapi_kerberos:"Kerberos",authentication_auth_username_password:"Basic auth",authentication_auth_basic:"Basic auth",authentication_auth_token:"Token",authentication_none:"None",parameters_connector_single:"single",parameters_connector_rs:"rs",parameters_connector_sharded:"sharded",parameters_redis_single_connector:"single",parameters_redis_sentinel_connector:"rs",parameters_redis_cluster_connector:"sharded",parameters_connector_influxdb_api_v_1:"v1",parameters_connector_influxdb_api_v_2:"v2",parameters_action_update:"Update",parameters_action_delete:"Delete",parameters_action_create:"Create",parameters_s_3_direct_upload_parameters:"Direct Upload",parameters_s_3_aggregated_upload_parameters:"Aggregated Upload",parameters_direct_parameters:"Direct Upload",parameters_aggreg_parameters:"Aggregated Upload",all_partitions:"All Partitions",plain:"Plain",scram_sha_256:"SHA256",scram_sha_512:"SHA512",m:"minute",h:"hour",d:"day",no_compression:"No compression",restapi:"REST API",thrift:"Thrift Protocol",protocol_v1:"v1",protocol_v2:"v2",protocol_v3:"v3",influxdb_v1:"InfluxDB Line Protocol",aggregated:"Aggregated Upload",parameters_proxy_none:"None",parameters_proxy_proxy_config:"Enable Proxy",proxy_none:"None",proxy_proxy_config:"Enable Proxy",vhost:"Virtual Hosted",path:"Path",v3:"v3(3.1)",v4:"v4(3.1.1)",v5:"v5(5.0)",timeseries:"TimeSeries",parameters_aggregation_container_container_json_lines:"JSON Lines",parameters_container_container_json_lines:"JSON Lines",parameters_aggregation_container_container_csv:"CSV",parameters_container_container_csv:"CSV",authentication_msk_iam:"AWS IAM for MSK",parameters_streaming_parameters:"Streaming",parameters_aggregation_container_container_parquet:"Parquet",parameters_aggregation_container_container_avro:"Avro",arrow_flight:"Arrow Flight"},c={async:"异步",sync:"同步",get:"GET",post:"POST",delete:"DELETE",put:"PUT",producer:"生产者",consumer:"消费者",ns:"纳秒",us:"微秒",ms:"毫秒",s:"秒",none:"None",base64:"Base64",json:"JSON",authentication_auth_gssapi_kerberos:"Kerberos",authentication_auth_username_password:"基础认证",authentication_auth_basic:"基础认证",authentication_auth_token:"Token",authentication_none:"无",parameters_connector_single:"single",parameters_connector_rs:"rs",parameters_connector_sharded:"sharded",parameters_redis_single_connector:"single",parameters_redis_sentinel_connector:"sentinel",parameters_redis_cluster_connector:"cluster",parameters_connector_influxdb_api_v_1:"v1",parameters_connector_influxdb_api_v_2:"v2",parameters_action_update:"更新",parameters_action_delete:"删除",parameters_action_create:"创建",parameters_s_3_direct_upload_parameters:"直接上传",parameters_s_3_aggregated_upload_parameters:"聚合上传",parameters_direct_parameters:"直接上传",parameters_aggreg_parameters:"聚合上传",all_partitions:"所有分区",plain:"Plain",scram_sha_256:"SHA256",scram_sha_512:"SHA512",m:"分钟",h:"小时",d:"天",no_compression:"不压缩",restapi:"REST API",thrift:"Thrift 协议",protocol_v1:"v1",protocol_v2:"v2",protocol_v3:"v3",influxdb_v1:"InfluxDB 行协议",aggregated:"聚合上传",parameters_proxy_none:"无",parameters_proxy_proxy_config:"开启代理",proxy_none:"无",proxy_proxy_config:"开启代理",vhost:"虚拟托管",path:"路径",v3:"v3(3.1)",v4:"v4(3.1.1)",v5:"v5(5.0)",timeseries:"时序",parameters_aggregation_container_container_json_lines:"JSON Lines",parameters_container_container_json_lines:"JSON Lines",parameters_aggregation_container_container_csv:"CSV",parameters_container_container_csv:"CSV",authentication_msk_iam:"AWS IAM for MSK",parameters_streaming_parameters:"流式",parameters_aggregation_container_container_parquet:"Parquet",parameters_aggregation_container_container_avro:"Avro",arrow_flight:"Arrow Flight"},l={common:{auto_restart_interval:"资源断开以后,自动重连的时间间隔。",batch_size:"最大批量请求大小。如果设为 1,则无批处理。",batch_time:"在较低消息率情况下尝试累积批量输出时的最大等待间隔,以提高资源的利用率。",enable_queue:"启用磁盘缓存队列(仅对 egress 方向桥接有用)。",health_check_interval:"健康检查间隔。",health_check_interval_jitter:"在健康检查间隔中添加一个均匀的随机延迟,以便使用同一连接器的动作和 Source 在不同时间点开始其健康检查。",inflight_window:"请求飞行队列窗口大小。当请求模式为异步时,如果需要严格保证来自同一 MQTT 客户端的消息有序,则必须将此值设为 1。",query_mode:"请求模式。可选 '同步/异步',默认为'异步'模式。",request_ttl:"从请求进入缓冲区开始计时,如果请求在规定的时间内仍停留在缓冲区内或者已发送但未能及时收到响应或确认,该请求将被视为过期。",start_timeout:"在回复资源创建请求前等待资源进入健康状态的时间。",worker_pool_size:"缓存队列 worker 数量。仅对 egress 类型的桥接有意义。当桥接仅有 ingress 方向时,可设置为 0,否则必须大于 0。",max_buffer_bytes:"每个缓存 worker 允许使用的最大字节数。",password:"相关联的外部数据库中,用于认证或识别的密码。",pool_size:"桥接远端服务时使用的连接池大小。",prepare_statement:"SQL 预处理语句列表。",ssl:"启用 SSL 连接。",username:"相关联的外部数据库中,用于认证或识别的用户名。",database:"数据库名字。",tcp_keepalive:"启用连接器的 TCP keepalive。<br/>该值是三个逗号分隔的数字,格式为`空闲时间,间隔时间,尝试次数`<br/>- 空闲时间:连接在服务器开始发送 keep-alive 探测之前需要空闲的秒数(Linux 默认为 7200)。<br/>- 间隔时间:TCP keep-alive 探测之间的秒数(Linux 默认为 75)。<br/>- 尝试次数:在从另一端获得响应之前发送的 TCP keep-alive 探测的最大次数(Linux 默认为 9)。<br/>例如,\"240,30,5\" 表示:在连接空闲 240 秒后发送 TCP keepalive 探测,并在每隔 30 秒发送一次探测,如果连续 5 次没有响应,则应该关闭连接。<br/>默认值:'none'",sndbuf:"TCP socket 的发送缓存调优。默认值是针对高吞吐量的一个推荐值。",recbuf:"TCP socket 的收包缓存调优。默认值是针对高吞吐量的一个推荐值。",nodelay:"设置 `true` 让系统内核立即发送。否则当需要发送的内容很少时,可能会有一定延迟(默认 40 毫秒)。",pool_type:"连接池的类型。可以是`random`、`hash`之一。",max_retries:"请求出错时的最大重试次数。",memory_overload_protection:`在缓冲区模式设置为 <code>memory</code> 时适用
|
|
83
|
-
在内存压力较大时,EMQX 将删除旧的缓冲消息。注意:此配置仅适用于 Linux。`,disable_prepared_statements:"在连接中禁用预处理语句。某些端点(如事务模式下的 PGBouncer 或 Supabase)不支持会话功能(如预处理语句)。对于此类连接,应启用此选项。",health_check_topic:"专用于精确检查健康状态的主题名称。",max_records:"每个聚合对象允许的记录(事件)数量。每次聚合上传包含的事件数量不会超过此数值,但可能会更少。<br/>如果事件速率足够高,在同一时间间隔内显然可能会有多个聚合上传。这些上传将具有不同但连续的序列号,这些序列号将是 S3 对象键的一部分。",max_linger_time:"每个分区生产者,等待收集消息以形成批次的最长时间。<br/>默认值 <code>0</code> 表示不等待。对于非内存缓冲模式,建议至少配置 <code>5ms</code> 以减少 I/O
|
|
83
|
+
在内存压力较大时,EMQX 将删除旧的缓冲消息。注意:此配置仅适用于 Linux。`,disable_prepared_statements:"在连接中禁用预处理语句。某些端点(如事务模式下的 PGBouncer 或 Supabase)不支持会话功能(如预处理语句)。对于此类连接,应启用此选项。",health_check_topic:"专用于精确检查健康状态的主题名称。",max_records:"每个聚合对象允许的记录(事件)数量。每次聚合上传包含的事件数量不会超过此数值,但可能会更少。<br/>如果事件速率足够高,在同一时间间隔内显然可能会有多个聚合上传。这些上传将具有不同但连续的序列号,这些序列号将是 S3 对象键的一部分。",max_linger_time:"每个分区生产者,等待收集消息以形成批次的最长时间。<br/>默认值 <code>0</code> 表示不等待。对于非内存缓冲模式,建议至少配置 <code>5ms</code> 以减少 I/O 操作。<br/>从 EMQX 5.10.2 及 6.0.1 开始,在写入内存缓冲区时没有等待时间。",max_linger_bytes:"每个分区生产者,等待收集消息以形成批次的最大字节数。",undefined_vars_as_null:"在写入数据库时,将未定义的变量视为 NULL。<br/>当启用此选项时,如果在模板中使用未定义的变量(例如 `${'{'}var{'}'}`),它们将被替换为 `NULL`,而不是字符串 `undefined`。如果此选项未启用(默认为关闭),可能会插入字符串 `undefined`。<br/>如果可能,此选项应始终设置为 `true`;默认值 `false` 仅用于确保向后兼容性。",max_inactive:"HTTP 驱动在无任何活动时,尝试重连前的最大等待时间。",ipv6_probe:"是否探测 IPv6 支持。",min_part_size:"分块上传的最小分块大小。<br/>上传的数据将在内存中累积,直到达到此大小。",max_part_size:"分块上传的最大分块大小。<br/>S3 上传程序不会尝试上传超过此大小的部分。",private_key:`为 Pipe User 配置的私钥。支持以下输入格式:
|
|
84
84
|
- 明文密钥:直接以字符串形式输入PEM格式的私钥内容。
|
|
85
85
|
- 文件路径:指定包含私钥的文件路径。确保路径以<code>file://</code>开头。文件路径必须在集群的所有节点上相同。`,pipe_user:"具有使用 Pipe 权限的角色的用户名。最低要求的权限是`operate`和`monitor`。",proxy:"代理配置。当前仅支持 HTTP 代理(不支持 HTTPS)。",private_key_path:"用于 ODBC 连接的私钥的完整文件路径。此路径必须在集群的所有节点上保持一致。",private_key_password:"用于解密私钥的密码。如果私钥未加密,请不要设置此值。",allow_auto_topic_creation:"是否允许在元数据获取请求时自动创建主题。"},mqtt:{bridge_mode:"该设置仅适用于 MQTT 协议版本低于 5.0 的情况,且远程 MQTT 服务必须支持该功能。开启后,远端服务器将识别当前连接为一个桥接,消息回环检测更高效,收到的保留消息标志位会透传给本地。",clean_start:"当重新连接到远程服务,该 MQTT 服务作为入口桥接时,是否启动一个干净的会话。",retry_interval:"在未收到 ACK 的情况下,QoS1/QoS2 消息的重试间隔。",clientid_prefix:"连接器随机生成客户端 ID 时所使用的前缀。",max_inflight:"消息发布时,可以同时等待确认的未确认消息数量,用以提高消息传递效率和吞吐量。",topic:"消息发布主题,支持使用 ${'{'}field{'}'} 语法提取变量动态拼接主题。",source_topic:"消息订阅主题,支持使用 + 和 # 通配符。当 EMQX 运行在集群模式下或连接器配置了连接池时,为了避免消息重复,必须使用共享订阅。",payload:"例如:${'{'}payload{'}'}, ${'{'}clientid{'}'}, ${'{'}topic{'}'}, ${'{'}username{'}'} 等。请根据使用动作的业务需求来选择字段,置空则原样转发消息。支持使用 ${'{'}field{'}'} 语法读取数据。",static_clientids:"配置 EMQX 节点与静态客户端 ID 的对应关系。当配置了映射关系后,只有在映射中指定的 EMQX 节点才会创建对应的 MQTT 客户端连接。",node:"EMQX 的节点名称,例如:<code>emqx{'@'}10.0.0.1</code>",ids:"指定给该节点的静态客户端 ID 列表"},http:{url:"HTTP 连接器的 URL。<br/>路径中支持占位符,但在主机或端口部分中不能使用占位符。<br/>例如,`http://localhost:9901/${'{'}topic{'}'}` 是允许的,但是 `http://${'{'}host{'}'}:9901/message` 或 `http://localhost:${'{'}port{'}'}/message `不允许。",body:"例如:${'{'}payload{'}'}, ${'{'}clientid{'}'}, ${'{'}topic{'}'}, ${'{'}username{'}'} 等。请根据使用动作的业务需求来选择字段,置空则原样转发消息。",path:"此操作的 URL 路径。<br/>此路径将附加到连接器的 <code>url</code> 配置中,以形成完整的 URL 地址。此选项中允许使用带有变量的模板。 例如,<code>/room/{'{'}$room_no{'}'}</code>"},cassandra:{keyspace:"要连接到的 Keyspace 名称。",servers:"将要连接的 IPv4 或 IPv6 地址,或者主机名。<br/>主机名具有以下形式:`Host[:Port][,Host2:Port]`。<br/>如果未指定 `[:Port]`,则使用 Cassandra 默认端口 9042。",cql:"CQL 模板"},clickhouse:{batch_value_separator:"默认为逗号 ',',适用于 VALUES 格式。您也可以使用其他分隔符, 请参考 [INSERT INTO 语句](https://clickhouse.com/docs/zh/sql-reference/statements/insert-into)。",connect_timeout:"连接 Clickhouse 服务器的超时时间。",url:"你想连接到的 Clickhouse 服务器的 HTTP URL(例如 http://myhostname:8123)。",sql:"可以使用 ${'{'}field{'}'} 占位符来引用消息与客户端上下文中的变量,请确保对应字段存在且数据格式符合预期。此处不支持 [SQL 预处理](https://docs.emqx.com/zh/enterprise/v5.0/data-integration/data-bridges.html#sql-预处理)。"},dynamo:{template:`模板,默认值为空。当此值为空时,整个消息将存储在数据库中。<br/>模板可以是任何带有占位符的有效 JSON,并确保表中所有的键都在这里,例如:<br/> \`{'{'}"id" : "\${'{'}id{'}'}", "clientid" : "\${'{'}clientid{'}'}", "data" : "\${'{'}payload.data{'}'}"{'}'}\``,url:"DynamoDB 的地址。",table:"DynamoDB 的表。",aws_access_key_id:"DynamoDB 的访问 ID。",aws_secret_access_key:"DynamoDB 的访问密钥。",region:"AWS DynamoDB 所在的区域"},gcp_pubsub_producer:{pipelining:"正整数,设置最大可发送的异步 HTTP 请求数量。当设置为 1 时,表示每次发送完成 HTTP 请求后都需要等待服务器返回,再继续发送下一个请求。",connect_timeout:"连接 GCP 服务器的超时时间。",service_account_json:"包含将与 PubSub 一起使用的 GCP 服务账户凭证的 JSON。<br/>当创建 GCP 服务账户时(如 https://developers.google.com/identity/protocols/oauth2/service-account#creatinganaccount ),可以选择下载 JSON 形式的凭证,然后在该配置项中使用。",pubsub_topic:"要发布消息的 GCP PubSub 主题。",payload_template:"用于格式化外发信息的模板。 如果未定义,将以 JSON 格式发送所有可用的上下文。",attributes_template:"用于格式化消息属性的模板。未定义的值将被渲染为空字符串。空键将从属性映射中删除。",ordering_key_template:"用于格式化消息排序键的模板。未定义的值将被渲染为空字符串。如果此值为空,则不会将其添加到消息中。"},gcp_pubsub_consumer:{topic:"要消费的 GCP PubSub 主题。",pipelining:"正整数,设置最大可发送的异步 HTTP 请求数量。当设置为 1 时,表示每次发送完成 HTTP 请求后都需要等待服务器返回,再继续发送下一个请求。",service_account_json:"包含将与 PubSub 一起使用的 GCP 服务账户凭证的 JSON。<br/>当创建 GCP 服务账户时(如 https://developers.google.com/identity/protocols/oauth2/service-account#creatinganaccount ),可以选择下载 JSON 形式的凭证,然后在该配置项中使用。",pull_max_messages:`从 GCP PubSub 中在一个拉取请求里检索的最大消息数。
|
|
86
86
|
实际数量可能小于指定的值。`,connect_timeout:"连接 GCP 服务器的超时时间。"},hstreamdb:{url:"HStreamDB 服务器的 URL。使用 gRPC HTTP 服务器地址。",partition_key:"HStreamDB 分区键。支持占位符。",grpc_flush_timeout:"刷新 gRPC 调用到 HStreamDB 服务器的时间间隔。",aggregation_pool_size:"记录聚合池的大小。增大聚合池可提升并行处理能力,但可能会因批处理变小而影响效率。",max_batches:"刷新队列中最大未确认批次数。",writer_pool_size:"写入池大小。扩大池规模可增加并行化和同时写入操作,可能提升吞吐量。但需权衡内存消耗和资源竞争。",batch_interval:"两个连续(批量)请求之间的最大间隔。",record_template:"将被转发到 HStreamDB 的 HStream record 模板。支持占位符。<br/>注意:当使用 `raw record` 模板(意味着数据不是有效的 JSON)时,应该在 HStream 中使用 `read` 或 `subscription` 来获取数据。",parameters_batch_size:"单个请求中可发送的插入数据子句的最大数量。"},influxdb:{server:"将要连接的 IPv4 或 IPv6 地址,或者主机名。<br/><br/>主机名具有以下形式:`Host[:Port]`。<br/><br/>如果未指定 `[:Port]`,则使用 InfluxDB 默认端口 8086。",token:"InfluxDB token。",org:"InfluxDB 组织名称。",bucket:"InfluxDB bucket 名称。",write_syntax:"使用 InfluxDB API Line Protocol 写入 InfluxDB 的数据,支持占位符,参考 [InfluxDB 2.3 Line Protocol](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/line-protocol/) 及 [InfluxDB 1.8 Line Protocol](https://docs.influxdata.com/influxdb/v1.8/write_protocols/line_protocol_tutorial/) <br/>TLDR: <br/>```<measurement>[,<tag_key>=<tag_value>[,<tag_key>=<tag_value>]] <field_key>=<field_value>[,<field_key>=<field_value>] [<timestamp>]```<br/>注意,整形数值占位符后需要添加一个字符 `i` 类型标识。例如 `${'{'}payload.int_value{'}'}i`",precision:"InfluxDB 时间精度。"},datalayers:{write_syntax:"Datalayers 采用与 InfluxDB v1 完全兼容的行协议,为用户提供了熟悉且高效的数据写入方式。虽然兼容InfluxDB v1 的语法,但 Datalayers 在底层实现上有其独特之处,以优化性能和适应其特定的存储结构。参考 [InfluxDB Line Protocol](https://docs.datalayers.cn/datalayers/latest/development-guide/writing-with-influxdb-line-protocol.html)",precision:"Datalayers 时间精度。",enable_prepared:`启用 Datalayers 连接器的预处理语句。
|
|
@@ -106,7 +106,7 @@ HGETALL mqtt_acl:\${username}`}},n={async:"Async",sync:"Sync",get:"GET",post:"PO
|
|
|
106
106
|
默认值:1,即主分片。`,index:"要执行操作的索引或索引别名的名称,支持 ${'{'}var{'}'} 格式的占位符。",id:"索引内文档的唯一标识符,支持 ${'{'}var{'}'} 格式的占位符。如果未指定 ID,则由 Elasticsearch 自动生成。",doc:"自定义文档模板,支持 ${'{'}var{'}'} 格式的占位符,要求必须可以被转换为 JSON 对象。\n 例如 `{'{'} \"field\": \"${'{'}payload.field{'}'}\" {'}'}`,或 `${'{'}payload{'}'}`。",overwrite:"当文档已经存在时覆盖文档,否则文档将写入失败。",enable_pipelining:"一个正整数。是否连续发送 HTTP 请求,当设置为 1 时,这意味着每次发送 HTTP 请求后,您需要等待服务器返回,然后继续发送下一个请求。",connect_timeout:"连接到 ElasticSearch 服务器时的超时时间。",doc_as_upsert:"尝试更新的文档不存在时,将更新操作当作一个插入操作,并将提供的文档当作新文档插入。"},s3:{acl:"上传的对象的访问权限。",content:"要存储的对象的内容。默认情况下,它是包含所有字段的 JSON 文本格式。支持如 ${'{'}payload{'}'} 的占位符设置。存储格式取决于变量的格式,支持二进制内容。",bucket:"将要上传文件的存储桶的名称。需要在 S3 中预先创建好,支持 ${'{'}var{'}'} 占位符格式。",key:"要存储的对象的键。支持如 ${'{'}var{'}'} 的占位符设置。",column_order:"在生成的 CSV 文件中首先按列排序的事件字段。<br/>无论此设置如何,生成的 CSV 都将包含聚合事件的所有字段,但此处未明确提及的所有列将按字典顺序排在这里列出的字段之后。",time_interval:"在上传前将事件聚合到单个对象中的时间量。"},azure_blob_storage:{column_order:"在生成的 CSV 文件中首先按列排序的事件字段。<br/>无论此设置如何,生成的 CSV 都将包含聚合事件的所有字段,但此处未明确提及的所有列将按字典顺序排在这里列出的字段之后。",time_interval:"在上传前将事件聚合到单个对象中的时间量。",content:"要存储的对象的内容。默认情况下,它是包含所有字段的 JSON 文本格式。支持如 ${'{'}payload{'}'} 的占位符设置。存储格式取决于变量的格式,支持二进制内容。",blob:"Azure Blob Storage blob 名称。",parameters_container:"Azure Blob Storage 容器名称。"},snowflake:{database:"包含 Snowflake 资源的数据库名称。",schema:"包含 Snowflake 资源的模式名称。",stage:"用于将数据文件加载到 Snowflake 的 Stage 名称。",pipe:"用于将数据摄取到表中的 Pipe 名称。"},snowflake_streaming:{schema:"包含 Snowflake 资源的模式名称。",pipe:"用于将数据导入表的管道名称。"},tablestore:{isint:"是否尝试将数值写为整数。默认为 false,表示将整数写为浮点数。",isbinary:"是否尝试将二进制值写为二进制类型。默认为 false,表示将二进制值写为字符串。"},disk_log:{filepath:"日志文件的基础路径。实际日志文件将采用 `filepath.N` 格式,其中 `N` 是 `1..max_file_number` 范围内的值。当前使用的文件可通过查找最近修改日期的文件来确定。注意,包含该文件的目录也必须对 EMQX 应用程序用户可写,因为目录中还会包含内部使用的额外文件(以 `.siz` 和 `.idx` 为后缀)。",max_file_size:"当前活动日志文件的最大大小。每个日志文件至少会写入一条记录,因此如果单条日志记录超过此值,最终文件大小可能会超过此最大值。",max_file_number:"要使用的最大日志文件数量。一旦达到最大文件数量且需要新的轮转时,最旧的文件将被截断并用作新的当前文件。",write_mode:"同步或异步写入日志到磁盘。",template:"写入的 JSON 对象的内容。支持模板。"},s3tables:{s_3_client_transport_options_request_timeout:"向 S3 服务发起单次 HTTP 请求的最大等待时间,超时后会重试或失败。"}},d={common:{auto_restart_interval:"The auto restart interval after the resource is disconnected.",batch_size:"Maximum batch count. If equal to 1, there's effectively no batching.",batch_time:"Maximum waiting interval when accumulating a batch at a low message rates for more efficient resource usage.",enable_queue:`Enable disk buffer queue (only applicable for egress bridges).
|
|
107
107
|
When Enabled, messages will be buffered on disk when the bridge connection is down.
|
|
108
108
|
When disabled the messages are buffered in RAM only.`,health_check_interval:"Health check interval.",health_check_interval_jitter:"A uniform random delay to be added to health check interval, so that Actions and Sources from the same Connector start their health checks at different instants.",inflight_window:"Query inflight window. When query_mode is set to async, this config has to be set to 1 if messages from the same MQTT client have to be strictly ordered.",query_mode:"Query mode. Optional 'sync/async', default 'async'.",request_ttl:"Starting from the moment when the request enters the buffer, if the request remains in the buffer for the specified time or is sent but does not receive a response or acknowledgement in time, the request is considered expired.",start_timeout:"Time interval to wait for an auto-started resource to become healthy before responding resource creation requests.",worker_pool_size:`The number of buffer workers. Only applicable for egress type bridges.
|
|
109
|
-
For bridges only have ingress direction data flow, it can be set to 0 otherwise must be greater than 0.`,max_buffer_bytes:"Maximum number of bytes to buffer for each buffer worker.",password:"Password used for authentication with the external database.",pool_size:"Size of the connection pool towards the bridge target service.",prepare_statement:"Key-value list of SQL prepared statements.",ssl:"SSL connection settings.",username:"The username in the external database used for authentication or identification purposes.",database:"Database name.",tcp_keepalive:"Enable TCP keepalive for connector.<br/>The value is a comma-separated list of three numbers in the format of `Idle,Interval,Probes`<br/>- Idle: The number of seconds of idle time needed by a connection before the server begins to send out keep-alive probes (default on Linux is 7200).<br/>- Interval: The number of seconds between TCP keep-alive probes (default on Linux is 75).<br/>- Probes: The maximum number of TCP keep-alive probes to send before considering the connection as closed if no response is received from the other end (default on Linux is 9).<br/>For example \"240,30,5\" means: send TCP keepalive probes after 240 seconds of idle time, and send probes every 30 second. If there are no responses for 5 consecutive attempts, the connection should be closed.<br/>Default: 'none'",sndbuf:"Fine tune the socket send buffer. The default value is tuned for high throughput.",recbuf:"Fine tune the socket receive buffer. The default value is tuned for high throughput.",nodelay:"When set to `true`, TCP buffer is sent as soon as possible. Otherwise, the OS kernel may buffer small TCP packets for a while (40 ms by default).",pool_type:"The type of the pool. Can be one of `random`, `hash`.",max_retries:"Max retry times if an error occurs when sending a request.",memory_overload_protection:"This setting applies when the buffer mode is configured as <code>memory</code>. EMQX will automatically discard older buffered messages when it encounters high memory pressure. Note: This configuration is effective only on Linux systems.",disable_prepared_statements:"Disables the usage of prepared statements in the connections. Some endpoints, like PGBouncer or Supabase in Transaction mode, do not support session features such as prepared statements. For such connections, this option should be enabled.",health_check_topic:"Topic name used exclusively for more accurate health checks.",max_records:"Number of records (events) allowed per each aggregated object. Each aggregated upload will contain no more than that number of events, but may contain less.<br/>If event rate is high enough, there obviously may be more than one aggregated upload during the same time interval. These uploads will have different, but consecutive sequence numbers, which will be a part of S3 object key.",max_linger_time:"Maximum duration for a per-partition producer to wait for messages in order to collect a batch to buffer.<br/>The default value <code>0</code> means no wait. For non-memory buffer mode, it's advised to configure at least <code>5ms</code> for less IOPS.",max_linger_bytes:"Maximum number of bytes for a per-partition producer to wait for messages in order to collect a batch to buffer.",undefined_vars_as_null:"When writing to databases, treat undefined variables as NULL.<br/>When this option is enabled, if undefined variables (like `${'{'}var{'}'}`) are used in templates, they will be replaced with `NULL` instead of the string `undefined`. If this option is not enabled (default), the string `undefined` might be inserted.<br/>This option should always be `true` if possible; the default value `false` is only to ensure backward compatibility.",max_inactive:"Maximum amount of time without any activity that the HTTP driver will wait before attempting to reconnect.",ipv6_probe:"Whether to probe for IPv6 support.",min_part_size:"The minimum part size for multipart uploads.<br/>Uploaded data will be accumulated in memory until this size is reached.",max_part_size:"The maximum part size for multipart uploads.<br/>S3 uploader won't try to upload parts larger than this size.",private_key:`The private key configured for the Pipe User. This supports the input formats below:
|
|
109
|
+
For bridges only have ingress direction data flow, it can be set to 0 otherwise must be greater than 0.`,max_buffer_bytes:"Maximum number of bytes to buffer for each buffer worker.",password:"Password used for authentication with the external database.",pool_size:"Size of the connection pool towards the bridge target service.",prepare_statement:"Key-value list of SQL prepared statements.",ssl:"SSL connection settings.",username:"The username in the external database used for authentication or identification purposes.",database:"Database name.",tcp_keepalive:"Enable TCP keepalive for connector.<br/>The value is a comma-separated list of three numbers in the format of `Idle,Interval,Probes`<br/>- Idle: The number of seconds of idle time needed by a connection before the server begins to send out keep-alive probes (default on Linux is 7200).<br/>- Interval: The number of seconds between TCP keep-alive probes (default on Linux is 75).<br/>- Probes: The maximum number of TCP keep-alive probes to send before considering the connection as closed if no response is received from the other end (default on Linux is 9).<br/>For example \"240,30,5\" means: send TCP keepalive probes after 240 seconds of idle time, and send probes every 30 second. If there are no responses for 5 consecutive attempts, the connection should be closed.<br/>Default: 'none'",sndbuf:"Fine tune the socket send buffer. The default value is tuned for high throughput.",recbuf:"Fine tune the socket receive buffer. The default value is tuned for high throughput.",nodelay:"When set to `true`, TCP buffer is sent as soon as possible. Otherwise, the OS kernel may buffer small TCP packets for a while (40 ms by default).",pool_type:"The type of the pool. Can be one of `random`, `hash`.",max_retries:"Max retry times if an error occurs when sending a request.",memory_overload_protection:"This setting applies when the buffer mode is configured as <code>memory</code>. EMQX will automatically discard older buffered messages when it encounters high memory pressure. Note: This configuration is effective only on Linux systems.",disable_prepared_statements:"Disables the usage of prepared statements in the connections. Some endpoints, like PGBouncer or Supabase in Transaction mode, do not support session features such as prepared statements. For such connections, this option should be enabled.",health_check_topic:"Topic name used exclusively for more accurate health checks.",max_records:"Number of records (events) allowed per each aggregated object. Each aggregated upload will contain no more than that number of events, but may contain less.<br/>If event rate is high enough, there obviously may be more than one aggregated upload during the same time interval. These uploads will have different, but consecutive sequence numbers, which will be a part of S3 object key.",max_linger_time:"Maximum duration for a per-partition producer to wait for messages in order to collect a batch to buffer.<br/>The default value <code>0</code> means no wait. For non-memory buffer mode, it's advised to configure at least <code>5ms</code> for less IOPS. <br/>There is no linger time when writing to memory buffer since EMQX 5.10.2 and 6.0.1.",max_linger_bytes:"Maximum number of bytes for a per-partition producer to wait for messages in order to collect a batch to buffer.",undefined_vars_as_null:"When writing to databases, treat undefined variables as NULL.<br/>When this option is enabled, if undefined variables (like `${'{'}var{'}'}`) are used in templates, they will be replaced with `NULL` instead of the string `undefined`. If this option is not enabled (default), the string `undefined` might be inserted.<br/>This option should always be `true` if possible; the default value `false` is only to ensure backward compatibility.",max_inactive:"Maximum amount of time without any activity that the HTTP driver will wait before attempting to reconnect.",ipv6_probe:"Whether to probe for IPv6 support.",min_part_size:"The minimum part size for multipart uploads.<br/>Uploaded data will be accumulated in memory until this size is reached.",max_part_size:"The maximum part size for multipart uploads.<br/>S3 uploader won't try to upload parts larger than this size.",private_key:`The private key configured for the Pipe User. This supports the input formats below:
|
|
110
110
|
- Plain key: Enter the private key contents in PEM format directly as a string value.
|
|
111
111
|
- File Path: Specify the path to a file that contains the private key. Ensure the path starts with <code>file://</code>. The file path must be the same on all nodes in the cluster.`,pipe_user:"A username which has a role with permissions over the Pipe to be used. The minimum permissions are `operate` and `monitor`.",proxy:"Proxy configuration. Only HTTP proxies are currently supported (no HTTPS).",private_key_path:"Full file path to the private key to be used for the ODBC connection. This path must be the same on all nodes of the cluster.",private_key_password:"Password to decrypt the private key. Do not set this value if the private key is not encrypted.",allow_auto_topic_creation:"Set to true to allow automatic topic creation with metadata fetch request."},mqtt:{bridge_mode:"This setting is only for MQTT protocol version older than 5.0, and the remote MQTT broker MUST support this feature. After being enabled, the remote broker will recognize the current connection as a bridge, that loop detection will be more effective and that retained messages will be propagated correctly.",clean_start:"Whether to start a clean session when reconnecting a remote broker for ingress bridge.",retry_interval:"Retry interval for QoS1/QoS2 messages if no ACK is received.",clientid_prefix:"The prefix used when the connector randomly generates a Client ID.",max_inflight:"The number of Unacked messages that can be simultaneously waited for during message publishing, in order to improve message delivery efficiency and throughput.",topic:"Message publishing topic, supports using ${'{'}field{'}'} syntax to extract variables and dynamically concatenate the topic.",source_topic:"Message subscription topics support the use of + and # wildcards. When EMQX is running in cluster mode or the connector is configured with a connection pool, shared subscriptions must be used to avoid message duplication.",payload:"For example: ${'{'}payload{'}'}, ${'{'}clientid{'}'}, ${'{'}topic{'}'} , ${'{'}username{'}'}, etc. Use fields according to the action requirements of your business and forwards the message as it is if it is empty.Supports reading data using ${'{'}field{'}'} syntax.",static_clientids:"Entries mapping EMQX node names to static client IDs. If any entries are defined, then only EMQX nodes matching those entries will start MQTT clients with the corresponding clientids.",node:"EMQX node name, e.g.: <code>emqx{'@'}10.0.0.1</code>.",ids:"Array of static client IDs assigned to this node."},http:{url:"The URL of the HTTP Connector.<br/>Template with variables is allowed in the path, but variables cannot be used in the host or port part.<br/>For example, `http://localhost:9901/${'{'}topic{'}'}` is allowed, but`http://${'{'}host{'}'}:9901/message` or `http://localhost:${'{'}port{'}'}/message`is not allowed.",body:"For example: ${'{'}payload{'}'}, ${'{'}clientid{'}'}, ${'{'}topic{'}'} , ${'{'}username{'}'}, etc. Use fields according to the action requirements of your business and forwards the message as it is if it is empty.",path:"The URL path for this Action.<br/>This path will be appended to the Connector's <code>url</code> configuration to form the full URL address.Template with variables is allowed in this option. For example, <code>/room/{'{'}$room_no{'}'}</code>"},cassandra:{keyspace:"Keyspace name to connect to.",servers:"The IPv4 or IPv6 address or the hostname to connect to.<br/>A host entry has the following form: `Host[:Port][,Host2:Port]`.<br/>The Cassandra default port 9042 is used if `[:Port]` is not specified.",cql:"CQL Template"},clickhouse:{batch_value_separator:"The default value ',' works for the VALUES format. You can also use other separator if other format is specified. See [INSERT INTO Statement](https://clickhouse.com/docs/en/sql-reference/statements/insert-into).",connect_timeout:"The timeout when connecting to the Clickhouse server.",url:"The HTTP URL to the Clickhouse server that you want to connect to (for example http://myhostname:8123)",sql:"The template string can contain ${'{'}field{'}'} placeholders for message metadata and payload field. Make sure that the inserted values are formatted and escaped correctly. [Prepared Statement](https://docs.emqx.com/en/enterprise/v5.0/data-integration/data-bridges.html#Prepared-Statement) is not supported."},dynamo:{template:`Template, the default value is empty. When this value is empty the whole message will be stored in the database.<br/>The template can be any valid JSON with placeholders and make sure all keys for table are here, example:<br/> \`{'{'}"id" : "\${'{'}id{'}'}", "clientid" : "\${'{'}clientid{'}'}", "data" : "\${'{'}payload.data{'}'}"{'}'}\``,url:"The url of DynamoDB endpoint.",table:"DynamoDB Table.",aws_access_key_id:"Access Key ID for connecting to DynamoDB.",aws_secret_access_key:"AWS Secret Access Key for connecting to DynamoDB.",region:"Region of the AWS dynamo"},gcp_pubsub_producer:{pipelining:"A positive integer. Whether to send HTTP requests continuously, when set to 1, it means that after each HTTP request is sent, you need to wait for the server to return and then continue to send the next request.",connect_timeout:"The timeout when connecting to the GCP server.",service_account_json:"JSON containing the GCP Service Account credentials to be used with PubSub.<br/>When a GCP Service Account is created (as described in https://developers.google.com/identity/protocols/oauth2/service-account#creatinganaccount), you have the option of downloading the credentials in JSON form. That's the file needed.",pubsub_topic:"The GCP PubSub topic to publish messages to.",payload_template:"The template for formatting the outgoing messages. If undefined, will send all the available context in JSON format.",attributes_template:"The template for formatting the outgoing message attributes. Undefined values will be rendered as empty string values. Empty keys are removed from the attribute map.",ordering_key_template:"The template for formatting the outgoing message ordering key. Undefined values will be rendered as empty string values. This value will not be added to the message if it's empty."},gcp_pubsub_consumer:{topic:"GCP PubSub topic to consume from.",pipelining:"A positive integer. Whether to send HTTP requests continuously, when set to 1, it means that after each HTTP request is sent, you need to wait for the server to return and then continue to send the next request.",service_account_json:"JSON containing the GCP Service Account credentials to be used with PubSub.<br/>When a GCP Service Account is created (as described in https://developers.google.com/identity/protocols/oauth2/service-account#creatinganaccount), you have the option of downloading the credentials in JSON form. That's the file needed.",pull_max_messages:`The maximum number of messages to retrieve from GCP PubSub in a single pull request.
|
|
112
112
|
The actual number may be less than the specified value.`,connect_timeout:"The timeout when connecting to the GCP server."},hstreamdb:{url:"HStreamDB Server URL. Using gRPC http server address.",partition_key:"HStreamDB Partition Key. Placeholders supported.",grpc_flush_timeout:"Time interval for flushing gRPC calls to the HStreamDB server.",aggregation_pool_size:"The size of the record aggregation pool. A larger aggregation pool size can lead to enhanced parallelization but may also result in reduced efficiency due to smaller batch sizes.",max_batches:"Maximum number of unconfirmed batches in the flush queue.",writer_pool_size:"The size of the writer pool. A larger pool may increase parallelization and concurrent write operations, potentially boosting throughput. Trade-offs include greater memory consumption and possible resource contention.",batch_interval:"Maximum interval that is allowed between two successive (batch) request.",record_template:"The HStream record template to be forwarded to the HStreamDB. Placeholders supported.<br/>NOTE: When you use `raw record` template (which means the data is not a valid JSON), you should use `read` or `subscription` in HStream to get the data.",parameters_batch_size:"Maximum number of insert data clauses that can be sent in a single request."},influxdb:{server:"The IPv4 or IPv6 address or the hostname to connect to.<br/><br/>A host entry has the following form: `Host[:Port]`.<br/><br/>The InfluxDB default port 8086 is used if `[:Port]` is not specified.",token:"InfluxDB token.",org:"Organization name of InfluxDB.",bucket:"InfluxDB bucket name.",write_syntax:"Conf of InfluxDB line protocol to write data points. It is a text-based format that provides the measurement, tag set, field set, and timestamp of a data point, and placeholder supported. See also [InfluxDB 2.3 Line Protocol](https://docs.influxdata.com/influxdb/v2.3/reference/syntax/line-protocol/) and [InfluxDB 1.8 Line Protocol](https://docs.influxdata.com/influxdb/v1.8/write_protocols/line_protocol_tutorial/) <br/>TLDR:<br/>```<measurement>[,<tag_key>=<tag_value>[,<tag_key>=<tag_value>]] <field_key>=<field_value>[,<field_key>=<field_value>] [<timestamp>]```<br/>Please note that a placeholder for an integer value must be annotated with a suffix `i`. For example `${'{'}payload.int_value{'}'}i`.",precision:"InfluxDB time precision."},datalayers:{write_syntax:"Datalayers adopts a line protocol fully compatible with InfluxDB v1, providing users with a familiar and efficient method for data ingestion. While compatible with InfluxDB v1 syntax, Datalayers has its unique characteristics in its underlying implementation to optimize performance and adapt to its specific storage structure. For more information, refer to [InfluxDB Line Protocol](https://docs.datalayers.cn/datalayers/latest/development-guide/writing-with-influxdb-line-protocol.html).",precision:"Datalayers time precision.",enable_prepared:`Enable prepared statements for the Datalayers connector.
|