Update from code changes: document server-side job operations - #326
Open
mintlify[bot] wants to merge 3 commits into
Open
Update from code changes: document server-side job operations#326mintlify[bot] wants to merge 3 commits into
mintlify[bot] wants to merge 3 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Update from code changes updated this PR. Documented typed Job[T] results with refresh_column_async example 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
Documents the new connection-level job APIs added in lancedb/lancedb#3755 —
job,list_jobs,get_job,cancel_job, andjob_history, along with the non-blockingJob.status()snapshot — and the typedJob[T]result contract from lancedb/lancedb#4013 that lets Python callers read structured payloads (e.g.RefreshColumnResult) fromjob.wait(). Together these let LanceDB Enterprise users introspect, monitor, and cancel background work from Python and TypeScript.Changes
enterprise/jobs.mdxcovering theJobhandle, listing/describing jobs, cancellation, and reading job history as Arrow.docs.jsonunder LanceDB Enterprise.Job[T]contract in Python (wait()returns the endpoint's result), withrefresh_column_async→RefreshColumnResultas the worked example; noted the TypeScriptwait()return type is unchanged.Context
Upstream PRs: lancedb/lancedb#3755, lancedb/lancedb#4013
Update history
job,list_jobs,get_job,cancel_job,job_history, and theJobhandle for LanceDB Enterprise (feat: connection-level job operations lancedb#3755).Job[T]in Python and arefresh_column_async→RefreshColumnResultexample; clarified that TypeScriptwait()still resolves tovoid(feat: return typed refresh job results lancedb#4013).