Skip to content

Fix scanner's example documentation test to allow cargo test --release to complete #129

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.

Sign up for GitHub

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
luoyuxia merged 2 commits into from
Jan 9, 2026
Merged

Fix scanner's example documentation test to allow cargo test --release to complete #129

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6686992
Ignore on scanner's example documentation test to allow `cargo test -…
leekeiabstraction Jan 8, 2026
eb8c080
Use full compilable example for scanner documentation
leekeiabstraction Jan 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
86 changes: 84 additions & 2 deletions crates/fluss/src/client/table/scanner.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,49 @@ impl<'a> TableScan<'a> {
///
/// # Example
/// ```
/// let scanner = table.new_scan().project(&[0, 2, 3])?.create_log_scanner();
/// # use fluss::client::FlussConnection;
/// # use fluss::config::Config;
/// # use fluss::error::Result;
/// # use fluss::metadata::{DataTypes, Schema, TableDescriptor, TablePath};
/// # use fluss::row::InternalRow;
/// # use std::time::Duration;
///
/// # pub async fn example() -> Result<()> {
/// let mut config = Config::default();
/// config.bootstrap_server = Some("127.0.0.1:9123".to_string());
/// let conn = FlussConnection::new(config).await?;
///
/// let table_descriptor = TableDescriptor::builder()
/// .schema(
/// Schema::builder()
/// .column("col1", DataTypes::int())
/// .column("col2", DataTypes::string())
/// .column("col3", DataTypes::string())
/// .column("col3", DataTypes::string())
/// .build()?,
/// ).build()?;
/// let table_path = TablePath::new("fluss".to_owned(), "rust_test_long".to_owned());
/// let admin = conn.get_admin().await?;
/// admin.create_table(&table_path, &table_descriptor, true)
/// .await?;
/// let table_info = admin.get_table(&table_path).await?;
/// let table = conn.get_table(&table_path).await?;
///
/// // Project columns by indices
/// let scanner = table.new_scan().project(&[0, 2, 3])?.create_log_scanner()?;
/// let scan_records = scanner.poll(Duration::from_secs(10)).await?;
/// for record in scan_records {
/// let row = record.row();
/// println!(
/// "{{{}, {}, {}}}@{}",
/// row.get_int(0),
/// row.get_string(2),
/// row.get_string(3),
/// record.offset()
/// );
/// }
/// # Ok(())
/// # }
/// ```
pub fn project(mut self, column_indices: &[usize]) -> Result<Self> {
if column_indices.is_empty() {
Expand Down Expand Up @@ -107,7 +149,47 @@ impl<'a> TableScan<'a> {
///
/// # Example
/// ```
/// let scanner = table.new_scan().project_by_name(&["col1", "col3"])?.create_log_scanner();
/// # use fluss::client::FlussConnection;
/// # use fluss::config::Config;
/// # use fluss::error::Result;
/// # use fluss::metadata::{DataTypes, Schema, TableDescriptor, TablePath};
/// # use fluss::row::InternalRow;
/// # use std::time::Duration;
///
/// # pub async fn example() -> Result<()> {
/// let mut config = Config::default();
/// config.bootstrap_server = Some("127.0.0.1:9123".to_string());
/// let conn = FlussConnection::new(config).await?;
///
/// let table_descriptor = TableDescriptor::builder()
/// .schema(
/// Schema::builder()
/// .column("col1", DataTypes::int())
/// .column("col2", DataTypes::string())
/// .column("col3", DataTypes::string())
/// .build()?,
/// ).build()?;
/// let table_path = TablePath::new("fluss".to_owned(), "rust_test_long".to_owned());
/// let admin = conn.get_admin().await?;
/// admin.create_table(&table_path, &table_descriptor, true)
/// .await?;
/// let table_info = admin.get_table(&table_path).await?;
/// let table = conn.get_table(&table_path).await?;
///
/// // Project columns by column names
/// let scanner = table.new_scan().project_by_name(&["col1", "col3"])?.create_log_scanner()?;
/// let scan_records = scanner.poll(Duration::from_secs(10)).await?;
/// for record in scan_records {
/// let row = record.row();
/// println!(
/// "{{{}, {}}}@{}",
/// row.get_int(0),
/// row.get_string(1),
/// record.offset()
/// );
/// }
/// # Ok(())
/// # }
/// ```
pub fn project_by_name(mut self, column_names: &[&str]) -> Result<Self> {
if column_names.is_empty() {
Expand Down
Loading