Repository navigation
fix(table): register the documented tuning options on the table factory - #99
Merged
fightBoxing merged 1 commit intoNov 9, 2026
Conversation
The docs and LanceOptions exposed eight tuning knobs that the dynamic table factory never declared, so a DDL using them failed at translation with 'ValidationException: Unsupported options found for lance': read.limit, write.memory-cap-bytes, index.num-bits, index.max-level, index.m, index.ef-construction, vector.ef and vector.refine-factor. Register them in optionalOptions() and thread them into the LanceOptions builder, then add DocumentedOptionsTest to keep the docs and the factory in sync: it asserts every documented key is registered, that one DDL using all of them survives translation, and that the values actually reach LanceOptions. Refresh docs/src for 0.2.0: - index: supported version matrix, upsert/delete, schema evolution and Hadoop-filesystem reads; - install: both artifacts, per-module builds, JDK 17 add-opens note, and a note that 1.18 / 1.19 are no longer built; - config: write.memory-cap-bytes, the overwrite once-per-job semantics, primary key changelog modes, and hadoop.* path options; - create-catalog: ALTER TABLE is supported on the lance catalog (add / rename / drop column) but not on the namespace catalog, and type changes are rejected; - create-table: primary key tables and the index tuning knobs per index type; - insert-into: the corrected write modes and the upsert/delete story; - select / performance / time-travel: aggregate pushdown, the memory cap, and the version-retention note. Co-authored-by: Cursor <cursoragent@cursor.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
While refreshing
docs/srcfor 0.2.0 I found that eight tuning options were documented and present inLanceOptions, but never declared onLanceDynamicTableFactory. A DDL using any of them failed at translation:So the fix and the docs refresh land together.
Code fix
optionalOptions().LanceOptionsbuilder inbuildLanceOptions().DocumentedOptionsTest, which pins the contract:explainSqlruns the factory's option validation);LanceOptions(read limit, memory cap, PQ/HNSW index knobs, vector search knobs).LanceSqlITCase#testOptionalOptionsto the full documented key set.Docs refresh (
docs/src)index.mdinstall.mdlance-namespacedependency, JDK 17--add-opensnoteconfig.mdwrite.memory-cap-bytes; the overwrite-once-per-job semantics; primary-key changelog modes;hadoop.*path optionsoperations/ddl/create-catalog.mdALTER TABLEis supported on thelancecatalog (add / rename / drop column) and rejected onlance-namespace; type changes rejected;RENAME TABLEmatrix per catalogoperations/ddl/create-table.mdoperations/dml/insert-into.mdoperations/dql/select.mdoperations/dql/time-travel.mdperformance.mdVerification
mvn clean package(JDK 17) →BUILD SUCCESSlance-flink-1.20Tests run: 278, Failures: 0, Errors: 0, Skipped: 18lance-flink-2.1Tests run: 337, Failures: 0, Errors: 0, Skipped: 18New:
DocumentedOptionsTest(4 cases) andLanceSqlITCase#testDocumentedTuningOptionsAreAcceptedByTheFactory.