feat: add lance_dataset_alter_columns for rename / nullability / type changes#44
Merged
Merged
Conversation
… changes Second of three PRs covering the schema-evolution roadmap entry. Exposes upstream's `Dataset::alter_columns` — rename, change nullability, or change data type of one or more columns in a single manifest commit. Rename and nullability-only changes are zero-copy and preserve indices; a type change rewrites the column's data files and drops any indices that referenced it.
Contributor
Author
|
cc @jja725 |
Collaborator
|
I've been vacation and thanks for the contribution @LuciferYang |
Contributor
Author
|
Thank you @jja725 |
jja725
pushed a commit
that referenced
this pull request
Jun 11, 2026
…n addition (#45) ## Summary Last of three PRs against #41. Exposes upstream's `Dataset::add_columns` through the three `NewColumnTransform` cases that translate cleanly across the C ABI: - **SQL expressions** — derive new columns from SQL over existing columns. - **All-null columns** — add nullable columns from an Arrow schema. On the modern format this is metadata-only; the legacy format can't represent it that way and returns `LANCE_ERR_NOT_SUPPORTED`. - **Stream** — splice in precomputed column data from an Arrow C stream, aligned positionally to the dataset's existing rows. Upstream's fourth variant, `BatchUDF`, is left out on purpose: it carries a Rust closure that can't cross the C ABI, and the stream variant already covers the same "bring your own computed data" use case. Each call mutates the dataset in place under an exclusive write lock; scanners already in flight keep their pre-add view via the same Arc clone-on-write as the `_drop_columns` (#42) / `_alter_columns` (#44) siblings. Three focused entry points rather than one mode-tagged function, because the inputs are genuinely different shapes (name/expression pairs vs. a schema pointer vs. a stream). Upstream's `read_columns` parameter isn't exposed — it only feeds `BatchUDF`; for these three variants upstream ignores it. `batch_size` is forwarded where it does something (SQL scan, stream alignment) and omitted from the metadata-only all-null path. ## Surface ```c typedef struct LanceSqlColumn { const char* name; const char* expression; } LanceSqlColumn; int32_t lance_dataset_add_columns_sql( LanceDataset* dataset, const LanceSqlColumn* columns, size_t num_columns, uint64_t batch_size); int32_t lance_dataset_add_columns_nulls( LanceDataset* dataset, const struct ArrowSchema* schema); int32_t lance_dataset_add_columns_stream( LanceDataset* dataset, struct ArrowArrayStream* stream, uint64_t batch_size); ``` `batch_size` uses `0` for the upstream default and is range-checked to `u32`. Two error-code details are worth calling out, both matching existing behavior: a SQL expression referencing a non-existent column surfaces as `LANCE_ERR_INTERNAL` (an upstream schema error, the same path as `lance_dataset_delete`), whereas a syntax error is `LANCE_ERR_INVALID_ARGUMENT`. Because these are `unsafe extern "C"` entry points under `panic = "abort"`, the stream variant pre-validates the mandatory CADI callbacks before handing the stream to arrow-rs (which would otherwise abort on a NULL `get_schema` / `get_next`), and the all-null variant rejects an uninitialised or non-UTF-8 top-level schema `format` before arrow-rs's `assert!`/`expect` can fire. The stream is consumed (released) on every non-NULL return path. ## Tests Rust integration tests cover all three variants end to end: computed values (single and multi-column SQL, constant expressions, honored `batch_size`), all-null backfill, and multi-fragment stream alignment — plus the full rejection surface (NULL/empty/non-UTF-8 inputs, name collisions, row-count mismatch, invalid `batch_size`, released/missing-callback streams, non-nullable all-null fields, and the legacy-format `NOT_SUPPORTED` path). Stream-consumption is proven with a drop counter rather than a vacuous release-slot check. C and C++ smoke tests exercise the SQL happy path and each variant's argument rejections across the ABI.
This was referenced Jun 16, 2026
jja725
pushed a commit
that referenced
this pull request
Jun 16, 2026
The schema-evolution series is fully merged, so this flips the Phase 3 roadmap row from `[ ]` to `[x]` and names the functions that cover it, matching the style of the rows around it. Covered by: - #45 — `lance_dataset_add_columns_sql/_nulls/_stream` - #44 — `lance_dataset_alter_columns` - #42 — `lance_dataset_drop_columns` Closes #41. Docs-only; no code or test changes.
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
Second of three PRs against #41. Exposes upstream's
Dataset::alter_columns— rename a column, change its nullability, or change its data type, committing a new manifest. Rename and nullability-only changes are zero-copy and preserve indices on the affected column; a type change rewrites the column's data files and drops any associated indices, mirroring upstream behavior.Mutates the dataset in place under an exclusive write lock; scanners already in flight against it keep their pre-alteration view via the existing Arc clone-on-write, same as
_delete(#31) /_drop_columns(#42).Surface
Per-alteration validation runs up front with index-tagged error messages. The struct uses sentinels for the three optional fields (
rename = NULL,nullable_mode = UNCHANGED,data_type = NULL); at least one must request a change, so a zero-init struct with onlypathset is rejected as a no-op rather than silently consuming a manifest version.Two design choices worth calling out:
nullable_modeisint32_t, not the enum directly. The struct is read across the FFI boundary, and Rust treats a#[repr(C)]enum read from C with an out-of-range discriminant as UB. So the field isint32_tand aLanceColumnNullableMode::from_raw(i32)helper converts and returnsINVALID_ARGUMENTfor unknown values — same pattern asmerge_insert'sWhenMatched::from_raw.data_typeborrows an ArrowArrowSchema. The wrapper never calls itsreleasecallback. Before handing the pointer to arrow-rs, the wrapper checks bothrelease == NULL(the Arrow CADI "released" sentinel) andformat == NULL(catchesFFI_ArrowSchema::empty()and other half-built structs that would otherwise hit anassert!inDataType::try_fromand abort the host process underpanic = "abort").The C++ wrapper takes
const std::vector<lance::ColumnAlteration>&and uses the same direct-pass convention asupdate/merge_insertsiblings —raw.data()unconditionally; an empty vector flows through the Rust-sidenum_alterations == 0guard so the error message is precise.Tests
Nineteen new Rust integration tests cover the positive paths (rename, relax / tighten nullability, Int32→Int64 upcast with value round-trip, combined rename+relax, multi-alteration per call, version bump) and the full rejection surface (NULL dataset / NULL array / zero count / NULL path / empty path / empty rename / unknown column / incompatible cast / no-op alteration with schema-unchanged assertion / invalid
nullable_modediscriminant / uninitialisedFFI_ArrowSchema/ tightening nullability when existing rows hold NULLs).C and C++ smoke tests slot in before
test_drop_columns, relaxidto nullable, and verify viaArrowSchema.flags & ARROW_FLAG_NULLABLE. Both also exercise the NULL / zero / no-op / bad-discriminant negative paths.cargo testandcargo test --test compile_and_run_test -- --ignoredboth green.Follow-up
lance_dataset_add_columns— SQL expressions / AllNulls / ArrowArrayStreamThe README roadmap entry stays unticked until that lands.