Copilot commented on code in PR #336:
URL: https://github.com/apache/fluss-rust/pull/336#discussion_r2816912459
##########
website/docs/user-guide/rust/api-reference.md:
##########
@@ -239,27 +239,30 @@ writer.append(&row)?.await?;
## `TableDescriptor`
-| Method | Description
|
-|----------------------------------------------------|--------------------------------------|
-| `fn builder() -> TableDescriptorBuilder` | Create a table
descriptor builder |
-| `fn schema(&self) -> &Schema` | Get the table schema
|
-| `fn partition_keys(&self) -> &[String]` | Get partition key
column names |
-| `fn has_primary_key(&self) -> bool` | Check if the table has
a primary key |
-| `fn properties(&self) -> &HashMap<String, String>` | Get all table
properties |
-| `fn comment(&self) -> Option<&str>` | Get table comment
|
+| Method | Description
|
+|-----------------------------------------------------------|--------------------------------------|
+| `fn builder() -> TableDescriptorBuilder` | Create a table
descriptor builder |
+| `fn schema(&self) -> &Schema` | Get the table
schema |
+| `fn partition_keys(&self) -> &[String]` | Get partition
key column names |
+| `fn has_primary_key(&self) -> bool` | Check if the
table has a primary key |
+| `fn properties(&self) -> &HashMap<String, String>` | Get all table
properties |
+| `fn custom_properties(&self) -> &HashMap<String, String>` | Get custom
properties |
+| `fn comment(&self) -> Option<&str>` | Get table
comment |
Review Comment:
The PR description mentions "Add custom properties assertions in integration
test" and "Integration tests ran and completed", but this PR only contains
documentation updates and no test changes are visible in the diff. The
integration test changes may have been committed separately or the PR
description may need to be updated to accurately reflect the scope of changes.
##########
website/docs/user-guide/cpp/api-reference.md:
##########
@@ -286,15 +286,16 @@ When using `table.NewRow()`, the `Set()` method
auto-routes to the correct type
## `TableDescriptor::Builder`
-| Method
| Description |
-|-----------------------------------------------------------------------------|----------------------------|
-| `SetSchema(const Schema& schema) -> Builder&`
| Set the table schema |
-| `SetPartitionKeys(const std::vector<std::string>& keys) -> Builder&`
| Set partition key columns |
-| `SetBucketCount(int32_t count) -> Builder&`
| Set the number of buckets |
-| `SetBucketKeys(const std::vector<std::string>& keys) -> Builder&`
| Set bucket key columns |
-| `SetProperty(const std::string& key, const std::string& value) -> Builder&`
| Set a table property |
-| `SetComment(const std::string& comment) -> Builder&`
| Set a table comment |
-| `Build() -> TableDescriptor`
| Build the table descriptor |
+| Method
| Description |
+|-----------------------------------------------------------------------------------|----------------------------|
+| `SetSchema(const Schema& schema) -> Builder&`
| Set the table schema |
+| `SetPartitionKeys(const std::vector<std::string>& keys) -> Builder&`
| Set partition key columns |
+| `SetBucketCount(int32_t count) -> Builder&`
| Set the number of buckets |
+| `SetBucketKeys(const std::vector<std::string>& keys) -> Builder&`
| Set bucket key columns |
+| `SetProperty(const std::string& key, const std::string& value) -> Builder&`
| Set a table property |
+| `SetCustomProperty(const std::string& key, const std::string& value) ->
Builder&` | Set a custom property |
+| `SetComment(const std::string& comment) -> Builder&`
| Set a table comment |
Review Comment:
The C++ TableDescriptor::Builder has SetLogFormat and SetKvFormat helper
methods (as seen in bindings/cpp/include/fluss.hpp lines 415-421), but these
are not documented in this API reference table. These methods should be added
to the documentation for completeness, similar to how log_format and kv_format
are documented for the Rust API.
```suggestion
| `SetComment(const std::string& comment) -> Builder&`
| Set a table comment |
| `SetLogFormat(const std::string& format) -> Builder&`
| Set the log format |
| `SetKvFormat(const std::string& format) -> Builder&`
| Set the key-value format |
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
