docs(HStreamDB bridge): make pool size descriptions better

This commit is contained in:
Kjell Winblad 2024-02-19 11:33:37 +01:00
parent 0cb28f5f40
commit def95aa22b
3 changed files with 6 additions and 6 deletions

View File

@ -110,10 +110,10 @@ bridge_v2_examples(Method) ->
action_values() -> action_values() ->
#{ #{
<<"parameters">> => #{ <<"parameters">> => #{
<<"aggregation_pool_size">> => 8,
<<"partition_key">> => <<"hej">>, <<"partition_key">> => <<"hej">>,
<<"record_template">> => <<"${payload}">>, <<"record_template">> => <<"${payload}">>,
<<"stream">> => <<"mqtt_message">>, <<"stream">> => <<"mqtt_message">>,
<<"aggregation_pool_size">> => 8,
<<"writer_pool_size">> => 8 <<"writer_pool_size">> => 8
} }
}. }.

View File

@ -60,7 +60,7 @@ grpc_flush_timeout.label:
"""gRPC Flush Interval""" """gRPC Flush Interval"""
aggregation_pool_size.desc: aggregation_pool_size.desc:
"""Size of record aggregation pool.""" """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."""
aggregation_pool_size.label: aggregation_pool_size.label:
"""Aggregation Pool Size""" """Aggregation Pool Size"""
@ -72,7 +72,7 @@ max_batches.label:
"""Max Batches""" """Max Batches"""
writer_pool_size.desc: writer_pool_size.desc:
"""The size of the writer pool.""" """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."""
writer_pool_size.label: writer_pool_size.label:
"""Writer Pool Size""" """Writer Pool Size"""

View File

@ -19,7 +19,7 @@ name.label:
"""Connector Name""" """Connector Name"""
url.desc: url.desc:
"""HStreamDB Server URL. Using gRPC http server address.""" """HStreamDB Server URL. This URL will be used as the gRPC HTTP server address."""
url.label: url.label:
"""HStreamDB Server URL""" """HStreamDB Server URL"""
@ -37,13 +37,13 @@ partition_key.label:
"""HStreamDB Partition Key""" """HStreamDB Partition Key"""
pool_size.desc: pool_size.desc:
"""HStreamDB Pool Size.""" """The size of the aggregation pool and the writer pool (see the description of the HStreamDB action for more information about these pools). Larger pool sizes can enhance parallelization but may also reduce efficiency due to smaller batch sizes."""
pool_size.label: pool_size.label:
"""HStreamDB Pool Size""" """HStreamDB Pool Size"""
grpc_timeout.desc: grpc_timeout.desc:
"""HStreamDB gRPC Timeout.""" """The timeout for HStreamDB gRPC requests."""
grpc_timeout.label: grpc_timeout.label:
"""HStreamDB gRPC Timeout""" """HStreamDB gRPC Timeout"""