mirror of
https://github.com/lancedb/lancedb.git
synced 2026-10-13 15:22:30 +00:00
docs: bring the open-source documentation into this repository
The pages describing this code lived in lancedb/docs, a repository with ten stars that neither contributing guide mentioned. A user who hit a wrong page while reading the source had to find a separate, near-invisible repository to fix it. These 102 pages now sit beside the code, and a documentation fix is a pull request in the repository the reader already had open. `docs/web` is a complete Mintlify site: `cd docs/web && mint dev` serves it with no other checkout. Enterprise pages stay private and are merged in when the published site is assembled, so links into them do not resolve here — every open-source page does. `docs/web-tests` holds the tests the code examples are extracted from. They ran against a published wheel before; here they can run against this repository's own SDK, so an example that stops compiling fails the pull request that broke it rather than being noticed later. Both directories sit beside `docs/src` and are invisible to it: mkdocs reads `docs_dir: src`, so the SDK reference builds and deploys exactly as before.
This commit is contained in:
Jack Ye
@@ -0,0 +1,48 @@
|
||||
---
|
||||
title: SDKs and REST API Reference
|
||||
sidebarTitle: "SDKs"
|
||||
description: "SDK and REST API reference for LanceDB Enterprise and OSS."
|
||||
|
||||
---
|
||||
|
||||
For detailed information of the available functions and methods in your preferred language's SDKs,
|
||||
refer to the API documentation linked below.
|
||||
|
||||
If you're looking for a REST API reference, visit the [REST API](/api-reference/rest) page.
|
||||
|
||||
If you're looking for conceptual and practical namespace guidance before diving into method signatures, see
|
||||
[Namespaces and Catalog Model](/namespaces) and [Using Namespaces in SDKs](/namespaces/usage).
|
||||
|
||||
## Supported SDKs {#supported-sdks}
|
||||
|
||||
Python, Typescript and Rust SDKs are officially supported by LanceDB. You can use these SDKs to interact with both LanceDB OSS and Enterprise deployments.
|
||||
|
||||
| Reference | Description |
|
||||
|:--------------|-------------------|
|
||||
| <Icon icon="python" /> [Python](https://lancedb.github.io/lancedb/python/python/) | Full-featured Python client with pandas & numpy integration |
|
||||
| <Icon icon="square-js" /> [Typescript](https://lancedb.github.io/lancedb/js/) | A TypeScript wrapper around the Rust library, built with `napi-rs`
|
||||
| <Icon icon="rust" /> [Rust](https://docs.rs/lancedb/latest/lancedb/index.html) | Native Rust library with persistent-storage and high performance |
|
||||
|
||||
## REST API SDKs {#rest-api-sdks}
|
||||
|
||||
<Badge color="red">Enterprise</Badge>
|
||||
|
||||
REST API-based SDKs provide a convenient way to interact with LanceDB Enterprise deployments using the Lance REST Namespace API.
|
||||
|
||||
| Reference | Description |
|
||||
|:--------------|-------------------|
|
||||
| <Icon icon="java" /> [Java](https://lancedb.github.io/lancedb/java/java/)| REST API Enterprise SDK in Java |
|
||||
|
||||
## Community-driven SDKs {#community-driven-sdks}
|
||||
|
||||
In addition to the officially supported SDKs, the LanceDB community may contribute SDKs in other languages.
|
||||
These SDKs may not have the same level of support or feature parity as the official ones supported by LanceDB, but they can be an option
|
||||
for users working in languages other than those listed above.
|
||||
|
||||
| Reference | Description |
|
||||
|:--------------|-------------------|
|
||||
| <Icon icon="golang" /> [Go](https://pkg.go.dev/github.com/lancedb/lancedb-go/pkg/lancedb) | Community-contributed Go SDK for LanceDB |
|
||||
| <Icon icon="gem" /> [Ruby](https://github.com/scientist-labs/lancelot) | Community-contributed Ruby bindings for LanceDB |
|
||||
| <Icon icon="swift" /> [Swift](https://github.com/RyanLisse/LanceDbSwiftKit) | Community-contributed Swift SDK for LanceDB |
|
||||
| <Icon icon="R" /> [R](https://github.com/CathalByrneGit/lancedb) | Community-contributed R package for LanceDB |
|
||||
| <Icon icon="flutter" /> [Flutter](https://github.com/Alexcn/flutter_lancedb) | Community-contributed Flutter bindings for LanceDB |
|
||||
@@ -0,0 +1,84 @@
|
||||
---
|
||||
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/tables" \
|
||||
-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/tables" \
|
||||
-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>
|
||||
Reference in New Issue
Block a user