Update from code changes: document declared computed columns - #330
Open
mintlify[bot] wants to merge 4 commits into
Open
Update from code changes: document declared computed columns#330mintlify[bot] wants to merge 4 commits into
mintlify[bot] wants to merge 4 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Update from code changes updated this PR. Added refresh_column subsection for filling declared computed columns Source PRs
|
Contributor
Author
|
Update from code changes updated this PR. Added background refresh subsection for refresh_column_async job handle Source PRs
|
Contributor
Author
|
Update from code changes updated this PR. Added Enterprise support notes for computed columns and remote refresh behavior Source PRs
|
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
add_columnsnow accepts a SQL expression declaration that commits the column empty and is filled by a laterrefresh_columncall (blocking) orrefresh_column_async(returns a job handle) across Python, TypeScript, and Rust. Computed columns work on both local tables and LanceDB Enterprise, with the refresh on Enterprise running as a server-side backfill job that must be submitted through the async form. The docs page for schema evolution gains "Declare computed columns" and "Refresh a computed column" subsections covering the APIs, when to use them, the local vs. Enterprise behavior, and the write and schema-change restrictions the declaration imposes.Changes
docs/tables/schema.mdxwith Python, TypeScript, and Rust examples and callouts for local vs. Enterprise behavior and the transform-vs-computed restriction.refresh_column/refreshColumn, the returned row count and version, idempotency, and the LSM and Enterprise refusals for the blocking form.refresh_column_async/refreshColumnAsync, the returned job handle, the fact that invalid input is reported by the submitting call rather than by the job, and the read-freshness baseline the successful wait establishes on Enterprise.Update history
add_columns(computed=...)/addColumns({ computed })/.add_columns().computed(...)declaration API (source: feat: declare computed columns by SQL expression lancedb#3937).refresh_column/refreshColumnfor filling declared computed columns (source: feat: refresh computed columns lancedb#3938).refresh_column_async/refreshColumnAsyncreturning a job handle for background refreshes (source: feat: refresh_column_async returns a job handle lancedb#3939).waitestablishes a read-freshness baseline on the handle (source: feat: computed columns on remote tables lancedb#3941).