mirror of
https://github.com/lancedb/lancedb.git
synced 2026-11-13 14:16:54 +00:00
Brendan ClementandClaude Opus 5.5
ca343a5c06
## Summary Fixes the problems a page-by-page review of the docs found before launch, after checking each one against the current source and, where noted, the code. The matching fixes for the dataset and Geneva pages, which live in `lancedb/docs`, are in lancedb/docs#402. **Tables** - `integrations/embedding/cohere`: each input-type description was split across two table rows and wrapped in literal quotes (`"`search_document`"`). Now one row per type. - `integrations/embedding/gemini`: removes the same stray quotes from the task-type table. - `integrations/ai/langchain`: the MMR search table's `kwargs` row was missing a cell, so its description sat under Type. - Six reranker pages (answerdotai, cohere, colbert, jina, openai, voyageai): closes the backtick before `_relevance_score`. - `indexing/vector-index`: finishes a cell cut off at "with scalar". - `sql/dql/dedupe`: labels the empty header cell in the resolution table. **Corrections** - `curation/sampling`: sampling works in LanceDB Embedded through the Python SDK, so the page is available in both, with the SQL sections marked Enterprise. - `feature-engineering/index`, `add-computed-column`: automatic refresh is on by default for each computed column and takes effect once a deployment enables its scheduler. `refresh-column` already said so; these two implied it was off. - `indexing/scalar-index`, `indexing/index`: `LABEL_LIST` accelerates `array_has_all`/`array_has_any`; `array_contains_*` doesn't exist. Also merges scalar-index's two "nested fields" sections into one. - `integrations/embedding/ibm`: lists the four current models from `CURRENT_MODELS` (it listed a deprecated one) and explains that the default stays a legacy ID so existing tables reload with their model. - `integrations/reranking/openai`: the class is `OpenaiReranker`, not `OpenAI()`. - `integrations/ai/synthetic-data-kit`: the CLI is `synthetic-data-kit` throughout, each step runs one command, each step passes the file it writes to the next, and `save-as` uses `-f`/`-o`. - `integrations/data/dlt`: `secrets.toml` defines `api_token`, which the pipeline reads, and the run command runs the file the page creates. - `search/vector-search`: the multivector walkthrough connected to Enterprise in step 1 and a local path in step 2. It now runs locally throughout, with a note on connecting to Enterprise, and is renamed so it doesn't read as a duplicate of the short section above. **Structure and wording** - `integrations/embedding/nvidia`: adds headings, and drops test-suite details aimed at contributors. - `integrations/ai/genkit`: makes the retrieval test a real heading and describes the query step. - `integrations/data/voxel51`: replaces a raw MkDocs `!!! note` with a `<Note>`. - `sql/ddl/table`, `sql/ddl/job`: "Errors and limits" is a real heading, not bold text. - `curation/windowing`: sidebar title matches the curation overview ("Rank and Deduplicate"). - `deployment/storage`, `basics/agentic-skills`: fixes a garbled sentence and a stale reference to the quickstart. **Checked:** no new Vale alerts on the changed pages. Assembled together with lancedb/docs#402, the site passes `mint validate` and `mint broken-links --check-anchors --check-redirects`. Every changed page was reviewed in a local preview. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
92 lines
2.4 KiB
Plaintext
92 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"]
|
|
availability:
|
|
embedded: unavailable
|
|
enterprise: available
|
|
---
|
|
|
|
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-column) reports
|
|
fewer filled rows than you expected.
|
|
|
|
### Errors and limits {#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 an Enterprise cluster 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>
|