-
Notifications
You must be signed in to change notification settings - Fork 27
Add missing custom properties method and doc for table descriptor builder in C++. Add assertion for custom property in integration test. #336
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+48
−43
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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 | | ||
|
Comment on lines
+249
to
+250
|
||
|
|
||
| ## `TableDescriptorBuilder` | ||
|
|
||
| | Method | Description | | ||
| |----------------------------------------------------------------------------------|---------------------------------------------| | ||
| | `fn schema(schema: Schema) -> Self` | Set the schema | | ||
| | `fn log_format(format: LogFormat) -> Self` | Set log format (e.g., `LogFormat::ARROW`) | | ||
| | `fn kv_format(format: KvFormat) -> Self` | Set KV format (e.g., `KvFormat::COMPACTED`) | | ||
| | `fn property(key: &str, value: &str) -> Self` | Set a table property | | ||
| | `fn partitioned_by(keys: Vec<&str>) -> Self` | Set partition columns | | ||
| | `fn distributed_by(bucket_count: Option<i32>, bucket_keys: Vec<String>) -> Self` | Set bucket distribution | | ||
| | `fn comment(comment: &str) -> Self` | Set table comment | | ||
| | `fn build() -> Result<TableDescriptor>` | Build the table descriptor | | ||
| | Method | Description | | ||
| |-------------------------------------------------------------------------------------------|---------------------------------------------| | ||
| | `fn schema(schema: Schema) -> Self` | Set the schema | | ||
| | `fn log_format(format: LogFormat) -> Self` | Set log format (e.g., `LogFormat::ARROW`) | | ||
| | `fn kv_format(format: KvFormat) -> Self` | Set KV format (e.g., `KvFormat::COMPACTED`) | | ||
| | `fn property(key: &str, value: &str) -> Self` | Set a table property | | ||
| | `fn custom_property(key: impl Into<String>, value: impl Into<String>) -> Self` | Set a single custom property | | ||
| | `fn custom_properties(properties: HashMap<impl Into<String>, impl Into<String>>) -> Self` | Set custom properties | | ||
| | `fn partitioned_by(keys: Vec<&str>) -> Self` | Set partition columns | | ||
| | `fn distributed_by(bucket_count: Option<i32>, bucket_keys: Vec<String>) -> Self` | Set bucket distribution | | ||
| | `fn comment(comment: &str) -> Self` | Set table comment | | ||
| | `fn build() -> Result<TableDescriptor>` | Build the table descriptor | | ||
|
|
||
| ## `TablePath` | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since currently, only default format is support. So, not document the api is fine to me