Copilot commented on code in PR #242: URL: https://github.com/apache/fluss-rust/pull/242#discussion_r2781518052
########## docs/rust-client.md: ########## @@ -0,0 +1,748 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> + +# Fluss Rust Client Guide + +This guide covers how to use the Fluss Rust client for reading and writing data to log tables and primary key tables. + +## Prerequisites + +- Rust 1.85+ +- Protobuf compiler (`protoc`) - only required when [building from source](#building-from-source) + +## Adding to Your Project + +The Fluss Rust client is published to [crates.io](https://crates.io/crates/fluss-rs) as `fluss-rs`. The crate's library name is `fluss`, so you import it with `use fluss::...`. + +```toml +[dependencies] +fluss-rs = "0.1" +tokio = { version = "1", features = ["full"] } +``` + +### Feature Flags + +The Fluss crate supports optional storage backends: + +```toml +[dependencies] +# Default: memory and filesystem storage +fluss-rs = "0.1" + +# With S3 storage support +fluss-rs = { version = "0.1", features = ["storage-s3"] } + +# With OSS storage support +fluss-rs = { version = "0.1", features = ["storage-oss"] } + +# All storage backends +fluss-rs = { version = "0.1", features = ["storage-all"] } +``` + +Available features: +- `storage-memory` (default) - In-memory storage +- `storage-fs` (default) - Filesystem storage +- `storage-s3` - Amazon S3 storage +- `storage-oss` - Alibaba OSS storage +- `storage-all` - All storage backends + +### Alternative: Git or Path Dependency + +For development against unreleased changes, you can depend on the Git repository or a local checkout: + +```toml +[dependencies] +# From Git +fluss = { git = "https://github.com/apache/fluss-rust.git";, package = "fluss-rs" } + +# From local path +fluss = { path = "/path/to/fluss-rust/crates/fluss", package = "fluss-rs" } +``` + +> **Note:** When using `git` or `path` dependencies, the `package = "fluss-rs"` field is required so that Cargo resolves the correct package while still allowing `use fluss::...` imports. + +## Building from Source + +### 1. Clone the Repository + +```bash +git clone https://github.com/apache/fluss-rust.git +cd fluss-rust +``` + +### 2. Install Dependencies + +The Protobuf compiler (`protoc`) is required to build from source. + +#### macOS + +```bash +brew install protobuf +``` + +#### Ubuntu/Debian + +```bash +sudo apt-get install protobuf-compiler +``` + +### 3. Build the Library + +```bash +cargo build --workspace --all-targets +``` + +### 4. Run Tests + +```bash +# Unit tests +cargo test --workspace + +# Integration tests (requires running Fluss cluster) +RUST_TEST_THREADS=1 cargo test --features integration_tests --workspace +``` + +## Connection Setup + +```rust +use fluss::client::FlussConnection; +use fluss::config::Config; +use fluss::error::Result; + +#[tokio::main] +async fn main() -> Result<()> { + let mut config = Config::default(); + config.bootstrap_server = "127.0.0.1:9123".to_string(); + + let conn = FlussConnection::new(config).await?; + + // Use the connection... + + Ok(()) +} +``` + +### Configuration Options + +| Option | Description | Default | +|--------|-------------|---------| +| `bootstrap_server` | Coordinator server address | `127.0.0.1:9123` | +| `request_max_size` | Maximum request size in bytes | 10 MB | +| `writer_acks` | Acknowledgment setting (`all` waits for all replicas) | `all` | +| `writer_retries` | Number of retries on failure | `i32::MAX` | +| `writer_batch_size` | Batch size for writes | 2 MB | + +## Admin Operations + +### Get Admin Interface + +```rust +let admin = conn.get_admin().await?; +``` + +### Database Operations + +```rust +// Create database +admin.create_database("my_database", true, None).await?; + +// List all databases +let databases = admin.list_databases().await?; +println!("Databases: {:?}", databases); + +// Check if database exists +let exists = admin.database_exists("my_database").await?; + +// Get database information +let db_info = admin.get_database_info("my_database").await?; + +// Drop database (with cascade option to drop all tables) Review Comment: The comment says this drop is using the cascade option to drop all tables, but the call passes `cascade = false`. Either change the description or pass `true` for the cascade flag so the example matches what it claims. ```suggestion // Drop database ``` -- 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]
