mirror of
https://github.com/lancedb/lancedb.git
synced 2026-10-12 14:52:26 +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>
85 lines
2.9 KiB
Plaintext
85 lines
2.9 KiB
Plaintext
---
|
|
title: REST API Reference
|
|
sidebarTitle: "Overview"
|
|
description: "API reference for LanceDB"
|
|
|
|
---
|
|
|
|
[Lance REST Namespace](https://lance.org/format/namespace/) spec
|
|
is an OpenAPI protocol that enables reading, writing and managing Lance tables by connecting
|
|
those metadata services or building a custom metadata server in a standardized way.
|
|
|
|
LanceDB OSS allows you to interface with Lance tables via the REST Namespace.
|
|
LanceDB Enterprise provides an extended REST API with
|
|
additional endpoints for managing tables and data.
|
|
If you have specific needs or questions about the Enterprise REST API Namespace,
|
|
please [contact us](mailto:support@lancedb.com).
|
|
|
|
## Authentication {#authentication}
|
|
|
|
<Badge color="red">Enterprise</Badge>
|
|
|
|
All HTTP requests to LanceDB APIs must contain an <u>x-api-key</u> header that specifies a valid API key and
|
|
must be encoded as JSON or Arrow RPC.
|
|
|
|
To authenticate to the Enterprise REST API, you need the endpoint for your deployment and a valid API key for that deployment.
|
|
|
|
### Get your Enterprise credentials {#get-your-enterprise-credentials}
|
|
|
|
1. Obtain the following values from your LanceDB administrator or the LanceDB team that provisioned your Enterprise deployment:
|
|
- an API key
|
|
- your Enterprise REST endpoint
|
|
- your database name, if your deployment uses a private endpoint or `host_override`
|
|
|
|
2. Export those values in your terminal:
|
|
|
|
```bash
|
|
export LANCEDB_API_KEY="<your-api-key>"
|
|
export LANCEDB_URI="https://your-enterprise-endpoint.com"
|
|
export LANCEDB_DATABASE="your-database-name"
|
|
```
|
|
|
|
3. If your Enterprise deployment is private, connect through the private network endpoint provided for your deployment. For example, Azure Private Link deployments commonly use a private IP or an internal DNS name as the endpoint.
|
|
|
|
### Verify authentication {#verify-authentication}
|
|
|
|
4. Check that you can reach the deployment and list tables:
|
|
|
|
```bash
|
|
curl -X GET "$LANCEDB_URI/v1/management/table" \
|
|
-H "Content-Type: application/json" \
|
|
-H "x-api-key: $LANCEDB_API_KEY" \
|
|
-H "x-lancedb-database: $LANCEDB_DATABASE"
|
|
```
|
|
|
|
If your deployment endpoint already includes the database host name, you can omit the `x-lancedb-database` header.
|
|
|
|
5. Create a table to confirm write access. Let's call it `words`.
|
|
|
|
```bash
|
|
curl -X POST "$LANCEDB_URI/v1/tables/words" \
|
|
-H "Content-Type: application/vnd.apache.arrow.stream" \
|
|
-H "x-api-key: $LANCEDB_API_KEY" \
|
|
-H "x-lancedb-database: $LANCEDB_DATABASE"
|
|
```
|
|
|
|
6. Check that the table has been created:
|
|
|
|
```bash
|
|
curl -X GET "$LANCEDB_URI/v1/management/table" \
|
|
-H "Content-Type: application/json" \
|
|
-H "x-api-key: $LANCEDB_API_KEY" \
|
|
-H "x-lancedb-database: $LANCEDB_DATABASE"
|
|
```
|
|
|
|
That's it -- you're connected! Now, you can start adding data and querying it.
|
|
You can visit the tutorial section to build your own applications with LanceDB.
|
|
|
|
<Card
|
|
title="Tutorials"
|
|
icon="book"
|
|
href="/tutorials/"
|
|
>
|
|
Check out our tutorials on building various applications with LanceDB.
|
|
</Card>
|