mirror of
https://github.com/lancedb/lancedb.git
synced 2026-08-17 11:38:19 +00:00
Prashanth Rao
d6f9f8560e
## Summary This updates the Java API reference to close the documentation gaps that can be fixed from the current Java source and generated namespace API. The patch adds an empty table example, shows how to wrap returned Arrow IPC query bytes in a reusable `ArrowFileReader` helper, and documents the Java index operations that are currently exposed by the namespace client: vector indexes, scalar indexes, full text search indexes, and listing indexes. ## Issue Links Fixes https://github.com/lancedb/docs/issues/157 Fixes https://github.com/lancedb/docs/issues/160 Partially addresses https://github.com/lancedb/docs/issues/159 by documenting the index parameters currently exposed by Java. The requested `num_partitions` example is still blocked because `CreateTableIndexRequest` does not expose IVF training parameters yet. Not included: https://github.com/lancedb/docs/issues/158. The current Java docs and source remain remote namespace oriented, so local DB connection documentation should wait until the Java local DB API is available and can be verified. ## Validation - Built the Java core module with OpenJDK 17: `./mvnw -pl lancedb-core -am -DskipTests compile` - Checked the Markdown diff: `git diff --check -- docs/src/java/java.md` The Java build succeeds. It still reports pre-existing checkstyle warnings in the namespace client builder, but the Maven build is green.