mirror of
https://github.com/lancedb/lancedb.git
synced 2026-10-13 15:22:30 +00:00
Jack YeandBrendan Clement
47b7babc08
Move the public website pages into `docs/web` beside the SDK, with
shared navigation and executable example sources in `docs/web-tests`.
The combined website is assembled by
[lancedb/docs#355](https://github.com/lancedb/docs/pull/355), with six
Enterprise replacements from
[lancedb/sophon#7681](https://github.com/lancedb/sophon/pull/7681).
This includes Function guidance, runnable Quickstarts, regenerated
snippets, production contact/demo fixes, the legacy SQL route, and the
LeRobot redirect. LeRobot remains attributed to Geneva; all 34 Geneva
pages remain in the docs repository until Function officially launches.
Materialized-view guidance follows the full rebuild refresh introduced
by #4373: local refresh writes the complete result, has no `full`
argument, supports `source_version`, and no longer requires stable row
IDs. Deployment SQL refresh options and stable-ID setup are qualified by
version/configuration. Function input guidance distinguishes ordinary
stored columns from computed inputs supported by newer deployments.
**Validation:** independently accepted local checks include 95 Python
tests (real Enterprise excluded), eight TypeScript tests, Rust
Quickstart, snippet parity, typos, deterministic assembly, Mint
validation and links/anchors/redirects. The combined baseline retains
all 181 production routes and 17 legacy redirects. Examples ran locally
against source-built Python SDK 0.40.0b13; existing GitHub workflows do
not run `docs/web-tests`. New main at `069b2f7d` is 0.41.0b0 and adds
computed Function inputs; that SDK was not exercised by the accepted
tests. Latest prose corrections receive focused site validation.
**Merge/rollout:** merge this and #7681 before #355's combined CI, which
reads producer `main`. This is migration infrastructure: section
overlays, source-owned skills and automatic versioned paired releases
remain follow-ups. The current manual publisher is transitional. Hosted
validation, a supported SDK/Enterprise release pair and a real
Enterprise walkthrough remain pending.
Production Mintlify watches `lancedb/docs:deploy-freeze`, directory
`docs`; preserve that source through review. The separate SDK GitHub
Pages reference workflow rebuilds on main merges.
**Updated-head CI (9a50f8db):**
[Typos](https://github.com/lancedb/lancedb/actions/runs/37654185443/job/112904990558),
[PR
title](https://github.com/lancedb/lancedb/actions/runs/37654179507/job/112904974595)
and
[Aikido](https://app.aikido.dev/featurebranch/scan/215386145?groupId=74229)
pass. Critical findings in the example lockfiles were patched: all Sharp
copies use 0.35.5, protobufjs 7.6.6, tar 7.5.22, quinn-proto 0.11.19,
zerovec 0.11.8 and zerovec-derive 0.11.6. The SDK's product dependencies
are unchanged. The revised lockfiles pass eight TypeScript examples,
HuggingFace decode/resize/crop/rescale/normalize plus AVIF roundtrip,
and Rust Quickstart. Aikido passing does not mean every advisory is
cleared; npm still reports 29 high and five moderate advisories in the
example dependency graph. No scanner bypass or suppression was added.
The Function prose correction passes combined/standalone Mint,
deterministic assembly, routes and assets. The revised 325-file site
checksum is
`175bec06864abb400dd292e667ba93448c0479b8359fd7bf6146afabf9040647`. This
PR remains open for independent review; further merges are on hold.
---------
Co-authored-by: Brendan Clement <brendan.clement@lancedb.com>
91 lines
2.4 KiB
Plaintext
91 lines
2.4 KiB
Plaintext
---
|
|
title: "Job"
|
|
sidebarTitle: "Job"
|
|
description: "SHOW JOBS, SHOW ERRORS, and controlling a running job with PAUSE, RESUME and CANCEL."
|
|
icon: hourglass-half
|
|
keywords: ["show jobs", "show errors", "pause job", "resume job", "cancel job", "sql"]
|
|
---
|
|
|
|
<Badge color="red">Enterprise</Badge> [SQL runs on a deployment.](/sql)
|
|
|
|
A [job](/basics/jobs) is not a catalog object -- it has no schema and is not
|
|
namespaced -- but it has its own SQL statements, grouped here the same way the
|
|
catalog objects are.
|
|
|
|
## SHOW JOBS {#show}
|
|
|
|
```sql
|
|
SHOW JOBS
|
|
```
|
|
|
|
Every job the server knows about -- id, type, state, creation time. The SQL
|
|
counterpart of `list_jobs`.
|
|
|
|
## SHOW ERRORS {#errors}
|
|
|
|
```sql
|
|
SHOW ERRORS ON <table> [FOR JOB '<job-id>'] [LIMIT <n>]
|
|
```
|
|
|
|
```sql
|
|
SHOW ERRORS ON documents
|
|
SHOW ERRORS ON documents FOR JOB 'job-abc' LIMIT 100
|
|
```
|
|
|
|
Why rows failed. Reach for this when a [refresh](/sql/dml/refresh) reports
|
|
fewer filled rows than you expected.
|
|
|
|
**Errors and limits**
|
|
|
|
| | |
|
|
| --- | --- |
|
|
| `LIMIT` | must be between 1 and 100,000 |
|
|
| Failed jobs scanned without `FOR JOB` | 32 most recent |
|
|
| Tables the server does not open directly | not supported |
|
|
|
|
Without `FOR JOB` this surveys recent failures and stops at 32 jobs. When the
|
|
listing stops at your `LIMIT`, the message says so -- narrow with `FOR JOB`
|
|
rather than raising the limit blindly.
|
|
|
|
## PAUSE JOB {#pause}
|
|
|
|
```sql
|
|
PAUSE JOB 'j-ci-abc-def'
|
|
```
|
|
|
|
## RESUME JOB {#resume}
|
|
|
|
```sql
|
|
RESUME JOB 'j-ci-abc-def'
|
|
```
|
|
|
|
## CANCEL JOB {#cancel}
|
|
|
|
```sql
|
|
CANCEL JOB 'j-ci-abc-def'
|
|
```
|
|
|
|
The job id is always a quoted string literal. All three take exactly one and
|
|
nothing after it -- a second token on the line is a syntax error rather than
|
|
being ignored.
|
|
|
|
<Note>
|
|
Cancellation is a request, matching the SDK's
|
|
[`cancel()`](/basics/jobs#managing): it does not guarantee the job stops before
|
|
doing more work, and asking twice or cancelling a finished job does nothing.
|
|
`CANCEL JOB` itself can be unavailable on a deployment with no job registry
|
|
configured, which is a deployment condition rather than something you can work
|
|
around from SQL.
|
|
</Note>
|
|
|
|
## What to read next {#next}
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="Query and job" icon="hourglass-half" href="/basics/jobs">
|
|
The handle these statements are the SQL view of.
|
|
</Card>
|
|
<Card title="Background jobs" icon="gears" href="/maintenance/background-jobs">
|
|
Job types you did not start yourself.
|
|
</Card>
|
|
</CardGroup>
|