leekeiabstraction commented on code in PR #300:
URL: https://github.com/apache/fluss-rust/pull/300#discussion_r2808094939
##########
website/docs/user-guide/cpp/api-reference.md:
##########
@@ -0,0 +1,494 @@
+---
+sidebar_position: 2
+---
+# API Reference
+
+Complete API reference for the Fluss C++ client.
+
+## `Result`
+
+| Field / Method | Type | Description
|
+|-----------------|---------------|----------------------------------------------------------------|
+| `error_code` | `int32_t` | 0 for success, non-zero for errors
|
+| `error_message` | `std::string` | Human-readable error description
|
+| `Ok()` | `bool` | Returns `true` if operation succeeded
(`error_code == 0`) |
+
+## `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 |
+
+## `Connection`
+
+| Method |
Description |
+|-------------------------------------------------------------------------|---------------------------------------------------|
+| `static Create(const Configuration& config, Connection& out) -> Result` |
Create a connection to a Fluss cluster |
+| `GetAdmin(Admin& out) -> Result` |
Get the admin interface |
+| `GetTable(const TablePath& table_path, Table& out) -> Result` |
Get a table for read/write operations |
+| `Available() -> bool` |
Check if the connection is valid and initialized |
+
+## `Admin`
+
+### Database Operations
+
+| Method
| Description |
+|---------------------------------------------------------------------------------------------------------------------------|--------------------------|
+| `CreateDatabase(const std::string& database_name, const DatabaseDescriptor&
descriptor, bool ignore_if_exists) -> Result` | Create a database |
+| `DropDatabase(const std::string& name, bool ignore_if_not_exists, bool
cascade) -> Result` | Drop a database |
+| `ListDatabases(std::vector<std::string>& out) -> Result`
| List all databases |
+| `DatabaseExists(const std::string& name, bool& out) -> Result`
| Check if a database exists |
+| `GetDatabaseInfo(const std::string& name, DatabaseInfo& out) -> Result`
| Get database metadata |
+
+### Table Operations
+
+| Method
| Description |
+|------------------------------------------------------------------------------------------------------------|-----------------------------|
+| `CreateTable(const TablePath& path, const TableDescriptor& descriptor, bool
ignore_if_exists) -> Result` | Create a table |
+| `DropTable(const TablePath& path, bool ignore_if_not_exists) -> Result`
| Drop a table |
+| `GetTableInfo(const TablePath& path, TableInfo& out) -> Result`
| Get table metadata |
+| `ListTables(const std::string& database_name, std::vector<std::string>& out)
-> Result` | List tables in a database |
+| `TableExists(const TablePath& path, bool& out) -> Result`
| Check if a table exists |
+
+### Partition Operations
+
+| Method
|
Description |
+|-------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------|
+| `CreatePartition(const TablePath& path, const
std::unordered_map<std::string, std::string>& partition_spec, bool
ignore_if_exists) -> Result` | Create a partition |
+| `DropPartition(const TablePath& path, const std::unordered_map<std::string,
std::string>& partition_spec, bool ignore_if_not_exists) -> Result` | Drop a
partition |
+| `ListPartitionInfos(const TablePath& path, std::vector<PartitionInfo>& out)
-> Result` | List
partition metadata |
+
+### Offset Operations
+
+| Method
| Description
|
+|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------|
+| `ListOffsets(const TablePath& path, const std::vector<int32_t>& bucket_ids,
const OffsetQuery& query, std::unordered_map<int32_t, int64_t>& out) -> Result`
| Get offsets for buckets
|
+| `ListPartitionOffsets(const TablePath& path, const std::string&
partition_name, const std::vector<int32_t>& bucket_ids, const OffsetQuery&
query, std::unordered_map<int32_t, int64_t>& out) -> Result` | Get offsets for
a partition's buckets |
+
+### Lake Operations
+
+| Method
| Description |
+|-----------------------------------------------------------------------------|------------------------------|
+| `GetLatestLakeSnapshot(const TablePath& path, LakeSnapshot& out) -> Result`
| Get the latest lake snapshot |
+
+## `Table`
+
+| Method | Description |
+|-------------------------------|------------------------------------------|
+| `NewRow() -> GenericRow` | Create a schema-aware row for this table |
+| `NewAppend() -> TableAppend` | Create an append builder for log tables |
+| `NewUpsert() -> TableUpsert` | Create an upsert builder for PK tables |
+| `NewLookup() -> TableLookup` | Create a lookup builder for PK tables |
+| `NewScan() -> TableScan` | Create a scan builder |
+| `GetTableInfo() -> TableInfo` | Get table metadata |
+| `GetTablePath() -> TablePath` | Get the table path |
+| `HasPrimaryKey() -> bool` | Check if the table has a primary key |
+
+## `TableAppend`
+
+| Method | Description |
+|----------------------------------------------|-------------------------|
+| `CreateWriter(AppendWriter& out) -> Result` | Create an append writer |
+
+## `TableUpsert`
+
+| Method
| Description |
+|------------------------------------------------------------------------------|--------------------------------------------|
+| `PartialUpdateByIndex(std::vector<size_t> column_indices) -> TableUpsert&`
| Configure partial update by column indices |
+| `PartialUpdateByName(std::vector<std::string> column_names) -> TableUpsert&`
| Configure partial update by column names |
+| `CreateWriter(UpsertWriter& out) -> Result`
| Create an upsert writer |
+
+## `TableLookup`
+
+| Method | Description
|
+|-------------------------------------------|-------------------------------------|
+| `CreateLookuper(Lookuper& out) -> Result` | Create a lookuper for point
lookups |
+
+## `TableScan`
+
+| Method |
Description |
+|----------------------------------------------------------------------|-----------------------------------------------|
+| `ProjectByIndex(std::vector<size_t> column_indices) -> TableScan&` |
Project columns by index |
+| `ProjectByName(std::vector<std::string> column_names) -> TableScan&` |
Project columns by name |
+| `CreateLogScanner(LogScanner& out) -> Result` |
Create a record-based log scanner |
+| `CreateRecordBatchLogScanner(LogScanner& out) -> Result` |
Create an Arrow RecordBatch-based log scanner |
+
+## `AppendWriter`
+
+| Method | Description
|
+|-------------------------------------------------------------|----------------------------------------|
+| `Append(const GenericRow& row) -> Result` | Append a row
(fire-and-forget) |
+| `Append(const GenericRow& row, WriteResult& out) -> Result` | Append a row
with write acknowledgment |
+| `Flush() -> Result` | Flush all
pending writes |
+
+## `UpsertWriter`
+
+| Method | Description
|
+|-------------------------------------------------------------|-----------------------------------------------|
+| `Upsert(const GenericRow& row) -> Result` | Upsert a row
(fire-and-forget) |
+| `Upsert(const GenericRow& row, WriteResult& out) -> Result` | Upsert a row
with write acknowledgment |
+| `Delete(const GenericRow& row) -> Result` | Delete a row
by primary key (fire-and-forget) |
+| `Delete(const GenericRow& row, WriteResult& out) -> Result` | Delete a row
with write acknowledgment |
+| `Flush() -> Result` | Flush all
pending operations |
+
+## `WriteResult`
+
+| Method | Description |
+|--------------------|---------------------------------------------|
+| `Wait() -> Result` | Wait for server acknowledgment of the write |
+
+## `Lookuper`
+
+| Method |
Description |
+|----------------------------------------------------------------------------|-----------------------------|
+| `Lookup(const GenericRow& pk_row, bool& found, GenericRow& out) -> Result` |
Lookup a row by primary key |
+
+## `LogScanner`
+
+| Method
| Description |
+|------------------------------------------------------------------------------------------------------|-------------------------------------------|
+| `Subscribe(int32_t bucket_id, int64_t offset) -> Result`
| Subscribe to a single bucket at an offset |
+| `Subscribe(const std::vector<BucketSubscription>& bucket_offsets) -> Result`
| Subscribe to multiple buckets |
+| `SubscribePartitionBuckets(int64_t partition_id, int32_t bucket_id, int64_t
start_offset) -> Result` | Subscribe to a single partition bucket |
+| `SubscribePartitionBuckets(const std::vector<PartitionBucketSubscription>&
subscriptions) -> Result` | Subscribe to multiple partition buckets |
+| `Unsubscribe(int32_t bucket_id) -> Result`
| Unsubscribe from a non-partitioned bucket |
+| `UnsubscribePartition(int64_t partition_id, int32_t bucket_id) -> Result`
| Unsubscribe from a partition bucket |
+| `Poll(int64_t timeout_ms, ScanRecords& out) -> Result`
| Poll individual records |
+| `PollRecordBatch(int64_t timeout_ms, ArrowRecordBatches& out) -> Result`
| Poll Arrow RecordBatches |
+
+## `GenericRow`
+
+### Index-Based Getters
+
+| Method | Description
|
+|------------------------------------------------|--------------------------------|
+| `GetBool(size_t idx) -> bool` | Get boolean value at index
|
+| `GetInt32(size_t idx) -> int32_t` | Get 32-bit integer at index
|
+| `GetInt64(size_t idx) -> int64_t` | Get 64-bit integer at index
|
+| `GetFloat32(size_t idx) -> float` | Get 32-bit float at index
|
+| `GetFloat64(size_t idx) -> double` | Get 64-bit float at index
|
+| `GetString(size_t idx) -> std::string` | Get string at index
|
+| `GetBytes(size_t idx) -> std::vector<uint8_t>` | Get binary data at index
|
+| `GetDate(size_t idx) -> Date` | Get date at index
|
+| `GetTime(size_t idx) -> Time` | Get time at index
|
+| `GetTimestamp(size_t idx) -> Timestamp` | Get timestamp at index
|
+| `DecimalToString(size_t idx) -> std::string` | Get decimal as string at
index |
+
+### Index-Based Setters
+
+| Method | Description
|
+|-----------------------------------------------------------|--------------------------------|
+| `SetNull(size_t idx)` | Set field to
null |
+| `SetBool(size_t idx, bool value)` | Set boolean
value |
+| `SetInt32(size_t idx, int32_t value)` | Set 32-bit
integer |
+| `SetInt64(size_t idx, int64_t value)` | Set 64-bit
integer |
+| `SetFloat32(size_t idx, float value)` | Set 32-bit float
|
+| `SetFloat64(size_t idx, double value)` | Set 64-bit float
|
+| `SetString(size_t idx, const std::string& value)` | Set string value
|
+| `SetBytes(size_t idx, const std::vector<uint8_t>& value)` | Set binary data
|
+| `SetDate(size_t idx, const Date& value)` | Set date value
|
+| `SetTime(size_t idx, const Time& value)` | Set time value
|
+| `SetTimestampNtz(size_t idx, const Timestamp& value)` | Set timestamp
without timezone |
+| `SetTimestampLtz(size_t idx, const Timestamp& value)` | Set timestamp
with timezone |
+| `SetDecimal(size_t idx, const std::string& value)` | Set decimal from
string |
+
+### Name-Based Setters
+
+When using `table.NewRow()`, the `Set()` method auto-routes to the correct
type based on the schema:
+
+| Method | Description
|
+|----------------------------------------------------------|-----------------------------------|
+| `Set(const std::string& name, bool value)` | Set boolean by
column name |
Review Comment:
Well spotted! Addressed in latest commit
--
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]
