Request for Example Usage or Documentation

[soumilshah1995]

Hi there 👋

I came across this project and found it really interesting. I’m excited to try it out, but I couldn’t find any end-to-end examples or clear documentation beyond the sample code in the repo.

Could you please point me to any existing documentation, or consider adding a few basic usage examples (e.g., how to set up and run a minimal workflow)? It would really help new users understand and adopt the project.

Thanks in advance for your great work!

Best,
Soumil

[Li0k]

Hi. @soumilshah1995 ！

Thank you for your interest in our project. Yes, we are gradually building a more comprehensive test framework and unit tests, hoping it will be helpful to you. Meanwhile, we are also refactor the README and examples doc, which will be available soon.

Would you mind to continue sharing your usage scenarios? We can discuss them here!

• UT test: add compaction unit test #43
• WIP: Test framwork feat(test): add rest catalog testing framework #44
• How does RisingWave use BergLoom?: https://github.com/risingwavelabs/risingwave/blob/393cafdde1e22d88e5f280025823a4ede29ece0a/src/storage/src/hummock/iceberg_compactor_runner.rs#L289

Please feel free to ask us any questions.

[soumilshah1995]

Hi there thanks a lot readme page where code examples appears blank attaching screenshot below

[chenzl25]

Hi there thanks a lot readme page where code examples appears blank attaching screenshot below

Thanks for the feedback @soumilshah1995. We are working on it and will update the example soon.

[chenzl25]

Hi @soumilshah1995 . We've updated the example! You can find the latest version and details in the README file.

[soumilshah1995]

Hi, could you please guide me on how to set up the warehouse and other configuration details?
I’ve looked through the README, but it’s unclear how we’re supposed to use it. Specifically, I’d appreciate some guidance on how to configure the s3Warehouse—what variables need to be set, and how to set them correctly.

Thanks in advance!

[chenzl25]

Here is the example of rest catalog https://github.com/nimtable/iceberg-compaction/blob/main/examples/rest-catalog/src/main.rs