You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@fluss.apache.org by yu...@apache.org on 2026/03/01 04:03:09 UTC
(fluss-rust) branch main updated: [doc] Update API Ref following SASL / NoKeyAssigner (#396)
This is an automated email from the ASF dual-hosted git repository.
yuxia pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/fluss-rust.git
The following commit(s) were added to refs/heads/main by this push:
new 94e7cbf [doc] Update API Ref following SASL / NoKeyAssigner (#396)
94e7cbf is described below
commit 94e7cbfe223f5e5c10416546207158f54309cbe2
Author: Keith Lee <le...@gmail.com>
AuthorDate: Sun Mar 1 04:03:03 2026 +0000
[doc] Update API Ref following SASL / NoKeyAssigner (#396)
---
website/docs/user-guide/cpp/api-reference.md | 28 ++++++++++++++---------
website/docs/user-guide/python/api-reference.md | 30 ++++++++++++++++---------
website/docs/user-guide/rust/api-reference.md | 28 ++++++++++++++---------
3 files changed, 55 insertions(+), 31 deletions(-)
diff --git a/website/docs/user-guide/cpp/api-reference.md b/website/docs/user-guide/cpp/api-reference.md
index 489f13a..debd311 100644
--- a/website/docs/user-guide/cpp/api-reference.md
+++ b/website/docs/user-guide/cpp/api-reference.md
@@ -15,16 +15,24 @@ Complete API reference for the Fluss C++ client.
## `Configuration`
-| Field | Type | Default | Description |
-|-----------------------------------|---------------|----------------------|-----------------------------------------------------------------|
-| `bootstrap_servers` | `std::string` | `"127.0.0.1:9123"` | Coordinator server address |
-| `writer_request_max_size` | `int32_t` | `10485760` (10 MB) | Maximum request size in bytes |
-| `writer_acks` | `std::string` | `"all"` | Acknowledgment setting (`"all"`, `"0"`, `"1"`, or `"-1"`) |
-| `writer_retries` | `int32_t` | `INT32_MAX` | Number of retries on failure |
-| `writer_batch_size` | `int32_t` | `2097152` (2 MB) | Batch size for writes in bytes |
-| `scanner_remote_log_prefetch_num` | `size_t` | `4` | Number of remote log segments to prefetch |
-| `remote_file_download_thread_num` | `size_t` | `3` | Number of threads for remote log downloads |
-| `scanner_log_max_poll_records` | `size_t` | `500` | Maximum number of records returned in a single Poll() |
+| Field | Type | Default | Description |
+|---------------------------------------|---------------|----------------------|------------------------------------------------------------------------------------------|
+| `bootstrap_servers` | `std::string` | `"127.0.0.1:9123"` | Coordinator server address |
+| `writer_request_max_size` | `int32_t` | `10485760` (10 MB) | Maximum request size in bytes |
+| `writer_acks` | `std::string` | `"all"` | Acknowledgment setting (`"all"`, `"0"`, `"1"`, or `"-1"`) |
+| `writer_retries` | `int32_t` | `INT32_MAX` | Number of retries on failure |
+| `writer_batch_size` | `int32_t` | `2097152` (2 MB) | Batch size for writes in bytes |
+| `writer_batch_timeout_ms` | `int64_t` | `100` | Maximum time in ms to wait for a writer batch to fill up before sending |
+| `writer_bucket_no_key_assigner` | `std::string` | `"sticky"` | Bucket assignment strategy for tables without bucket keys: `"sticky"` or `"round_robin"` |
+| `scanner_remote_log_prefetch_num` | `size_t` | `4` | Number of remote log segments to prefetch |
+| `remote_file_download_thread_num` | `size_t` | `3` | Number of threads for remote log downloads |
+| `scanner_remote_log_read_concurrency` | `size_t` | `4` | Streaming read concurrency within a remote log file |
+| `scanner_log_max_poll_records` | `size_t` | `500` | Maximum number of records returned in a single Poll() |
+| `connect_timeout_ms` | `uint64_t` | `120000` | TCP connect timeout in milliseconds |
+| `security_protocol` | `std::string` | `"PLAINTEXT"` | `"PLAINTEXT"` (default) or `"sasl"` for SASL auth |
+| `security_sasl_mechanism` | `std::string` | `"PLAIN"` | SASL mechanism (only `"PLAIN"` is supported) |
+| `security_sasl_username` | `std::string` | (empty) | SASL username (required when protocol is `"sasl"`) |
+| `security_sasl_password` | `std::string` | (empty) | SASL password (required when protocol is `"sasl"`) |
## `Connection`
diff --git a/website/docs/user-guide/python/api-reference.md b/website/docs/user-guide/python/api-reference.md
index 1c97066..8f7ab61 100644
--- a/website/docs/user-guide/python/api-reference.md
+++ b/website/docs/user-guide/python/api-reference.md
@@ -7,17 +7,25 @@ Complete API reference for the Fluss Python client.
## `Config`
-| Method / Property | Description |
-|------------------------------------|-----------------------------------------------------------|
-| `Config(properties: dict = None)` | Create config from a dict of key-value pairs |
-| `bootstrap_servers` | Get/set coordinator server address |
-| `writer_request_max_size` | Get/set max request size in bytes |
-| `writer_acks` | Get/set acknowledgment setting (`"all"` for all replicas) |
-| `writer_retries` | Get/set number of retries on failure |
-| `writer_batch_size` | Get/set write batch size in bytes |
-| `scanner_remote_log_prefetch_num` | Get/set number of remote log segments to prefetch |
-| `remote_file_download_thread_num` | Get/set number of threads for remote log downloads |
-| `scanner_log_max_poll_records` | Get/set max number of records returned in a single poll() |
+| Method / Property | Description |
+|---------------------------------------|-----------------------------------------------------------------------------------------|
+| `Config(properties: dict = None)` | Create config from a dict of key-value pairs |
+| `bootstrap_servers` | Get/set coordinator server address |
+| `writer_request_max_size` | Get/set max request size in bytes |
+| `writer_acks` | Get/set acknowledgment setting (`"all"` for all replicas) |
+| `writer_retries` | Get/set number of retries on failure |
+| `writer_batch_size` | Get/set write batch size in bytes |
+| `writer_batch_timeout_ms` | Get/set max time in ms to wait for a writer batch to fill up before sending |
+| `writer.bucket.no-key-assigner` | Bucket assignment strategy (`"sticky"` or `"round_robin"`); set via `Config(dict)` only |
+| `scanner_remote_log_prefetch_num` | Get/set number of remote log segments to prefetch |
+| `remote_file_download_thread_num` | Get/set number of threads for remote log downloads |
+| `scanner_remote_log_read_concurrency` | Get/set streaming read concurrency within a remote log file |
+| `scanner_log_max_poll_records` | Get/set max number of records returned in a single poll() |
+| `connect_timeout_ms` | Get/set TCP connect timeout in milliseconds |
+| `security_protocol` | Get/set security protocol (`"PLAINTEXT"` or `"sasl"`) |
+| `security_sasl_mechanism` | Get/set SASL mechanism (only `"PLAIN"` is supported) |
+| `security_sasl_username` | Get/set SASL username (required when protocol is `"sasl"`) |
+| `security_sasl_password` | Get/set SASL password (required when protocol is `"sasl"`) |
## `FlussConnection`
diff --git a/website/docs/user-guide/rust/api-reference.md b/website/docs/user-guide/rust/api-reference.md
index 2d149aa..3d72f55 100644
--- a/website/docs/user-guide/rust/api-reference.md
+++ b/website/docs/user-guide/rust/api-reference.md
@@ -7,16 +7,24 @@ Complete API reference for the Fluss Rust client.
## `Config`
-| Field | Type | Default | Description |
-|-----------------------------------|----------|--------------------|---------------------------------------------------------|
-| `bootstrap_servers` | `String` | `"127.0.0.1:9123"` | Coordinator server address |
-| `writer_request_max_size` | `i32` | `10485760` (10 MB) | Maximum request size in bytes |
-| `writer_acks` | `String` | `"all"` | Acknowledgment setting (`"all"` waits for all replicas) |
-| `writer_retries` | `i32` | `i32::MAX` | Number of retries on failure |
-| `writer_batch_size` | `i32` | `2097152` (2 MB) | Batch size for writes in bytes |
-| `scanner_remote_log_prefetch_num` | `usize` | `4` | Number of remote log segments to prefetch |
-| `remote_file_download_thread_num` | `usize` | `3` | Number of threads for remote log downloads |
-| `scanner_log_max_poll_records` | `usize` | `500` | Maximum number of records returned in a single poll() |
+| Field | Type | Default | Description |
+|---------------------------------------|-----------------|--------------------|--------------------------------------------------------------------------------------|
+| `bootstrap_servers` | `String` | `"127.0.0.1:9123"` | Coordinator server address |
+| `writer_request_max_size` | `i32` | `10485760` (10 MB) | Maximum request size in bytes |
+| `writer_acks` | `String` | `"all"` | Acknowledgment setting (`"all"` waits for all replicas) |
+| `writer_retries` | `i32` | `i32::MAX` | Number of retries on failure |
+| `writer_batch_size` | `i32` | `2097152` (2 MB) | Batch size for writes in bytes |
+| `writer_batch_timeout_ms` | `i64` | `100` | Maximum time in ms to wait for a writer batch to fill up before sending |
+| `writer_bucket_no_key_assigner` | `NoKeyAssigner` | `sticky` | Bucket assignment strategy for tables without bucket keys: `sticky` or `round_robin` |
+| `scanner_remote_log_prefetch_num` | `usize` | `4` | Number of remote log segments to prefetch |
+| `remote_file_download_thread_num` | `usize` | `3` | Number of threads for remote log downloads |
+| `scanner_remote_log_read_concurrency` | `usize` | `4` | Streaming read concurrency within a remote log file |
+| `scanner_log_max_poll_records` | `usize` | `500` | Maximum number of records returned in a single poll() |
+| `connect_timeout_ms` | `u64` | `120000` | TCP connect timeout in milliseconds |
+| `security_protocol` | `String` | `"PLAINTEXT"` | `PLAINTEXT` (default) or `sasl` for SASL auth |
+| `security_sasl_mechanism` | `String` | `"PLAIN"` | SASL mechanism (only `PLAIN` is supported) |
+| `security_sasl_username` | `String` | (empty) | SASL username (required when protocol is `sasl`) |
+| `security_sasl_password` | `String` | (empty) | SASL password (required when protocol is `sasl`) |
## `FlussConnection`