Update from code changes: document declared computed columns - #330
Update from code changes: document declared computed columns#330mintlify[bot] wants to merge 7 commits into
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Update from code changes updated this PR. Added refresh_column subsection for filling declared computed columns Source PRs
|
|
Update from code changes updated this PR. Added background refresh subsection for refresh_column_async job handle Source PRs
|
|
Update from code changes updated this PR. Added Enterprise support notes for computed columns and remote refresh behavior Source PRs
|
|
Update from code changes updated this PR. Skipped update; Function application surface not yet user-facing Source PRs
|
|
Update from code changes updated this PR. Added batched dependent declarations subsection and refresh-order caveat Source PRs
|
|
Update from code changes updated this PR. Added blob column reference subsection for computed columns Source PRs
|
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. Several computed columns can be declared in one call and reference each other in dependency order, and expressions can read Blob API columns on local tables. 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.add_columnscall.refresh_column/refreshColumn, the returned row count and version, idempotency, the LSM and Enterprise refusals for the blocking form, and the refusal when a computed input still has rows to fill.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).add_columnscall and the refresh-order requirement that refuses a dependent refresh while its input still has rows to fill (source: feat: let a computed-column batch read its own earlier declarations lancedb#4072).