mirror of
https://github.com/lancedb/lancedb.git
synced 2026-11-18 08:34:00 +00:00
Use “LanceDB Enterprise” throughout the staged website guides, SDK reference sources, generated API pages, and user-facing SDK messages. A separate branded “LanceDB Distributed” name adds terminology without clarifying behavior; describe where operations run directly. - Update `docs/web`, including the architecture diagram title and alt text. Use Enterprise in headings, table labels, and prose; simplify redundant product/execution-model wording and name the product only once in the diagram alt text. - Update Python docstrings and the Python/Java reference pages, TypeScript comments and native declaration comments, and Rust API documentation. Regenerate the TypeScript reference, including 24 replacements across six pages. - Update SDK warnings/errors and existing test expectations to match, along with contributor guidance and Vale rules. Remove the obsolete rule distinguishing Enterprise from Distributed. - Keep lowercase “distributed” for technical descriptions. API identifiers, anchors, asset paths, and execution behavior are unchanged. No branded-name exceptions are proposed. Validation: - Python and Node native builds succeeded; focused Python tests passed (36 passed, 4 skipped), and focused Node tests passed (14). - TypeDoc generation and the complete MkDocs reference build passed. MkDocs retains an existing unresolved `lancedb.functions.SecretReference` cross-reference. - Rust formatting, Node lint/format, changed-file Python lint/format, 32 Vale tests, and whitespace checks passed. Repository-wide Python lint has 48 existing findings in six untouched files. - Combined documentation assembly passed. Mintlify validation and link/anchor/redirect checks previously passed for both site builds; no code snippets changed. Companion PRs: [saved editions, terminology guide, and shared rules](https://github.com/lancedb/docs/pull/413), [Enterprise overview and writing rules](https://github.com/lancedb/sophon/pull/9511). --------- Co-authored-by: Brendan Clement <brendan.clement@lancedb.com>
93 lines
4.3 KiB
Plaintext
93 lines
4.3 KiB
Plaintext
---
|
|
title: "SDKs"
|
|
sidebarTitle: "SDKs"
|
|
description: "Choose a LanceDB SDK and find the API reference for your language."
|
|
icon: code-compare
|
|
keywords: ["python", "typescript", "rust", "java", "sdk", "rest", "api reference"]
|
|
---
|
|
|
|
Use a LanceDB SDK to create tables, add data, build indexes and run searches
|
|
from your application. Python, TypeScript and Rust work with both LanceDB
|
|
Embedded and LanceDB Enterprise. LanceDB Embedded runs in your application's
|
|
process; your data can live on local disk or in object storage. In LanceDB
|
|
Enterprise, query execution, indexing and maintenance run on the service,
|
|
outside your application.
|
|
|
|
The [quickstart](/quickstart) includes installation instructions and complete
|
|
examples in all three languages. For connection settings, see
|
|
[Connect to LanceDB](/basics/catalog).
|
|
|
|
## Official SDKs {#supported-sdks}
|
|
|
|
| SDK | API reference |
|
|
| --- | --- |
|
|
| Python | [Python reference](https://lancedb.github.io/lancedb/python/python/) |
|
|
| TypeScript | [TypeScript reference](https://lancedb.github.io/lancedb/js/) |
|
|
| Rust | [Rust reference](https://docs.rs/lancedb/latest/lancedb/index.html) |
|
|
|
|
Guides show the available language examples together. Use the API reference for
|
|
method signatures and options; SDKs do not expose every feature through the same
|
|
methods. In Rust, enable the `remote` feature to connect to Enterprise.
|
|
|
|
For SQL joins, aggregations and window functions, use
|
|
[SQL](/basics/sql). Python provides a SQL client, and applications in other
|
|
languages can use a Flight SQL client. TypeScript's table query API does not
|
|
provide a SQL execution method.
|
|
|
|
## Lance Namespace SDKs {#lance-namespace-sdks}
|
|
|
|
LanceDB Enterprise's catalog and table operations follow
|
|
[Lance Namespace](https://lance.org/format/namespace), an open specification
|
|
for describing access to tables in a multimodal lakehouse, including its REST
|
|
Namespace Spec. LanceDB Enterprise exposes this as an HTTP API for catalog and
|
|
table operations -- the [REST API reference](/api-reference/rest) describes
|
|
its endpoints and request formats. Use it when integrating a language or tool
|
|
without a LanceDB SDK; for SQL queries, connect through
|
|
[Flight SQL](/basics/sql) instead. Any client that implements a Lance
|
|
Namespace REST client can integrate with LanceDB this way, not only the
|
|
official SDKs above.
|
|
|
|
| Language | Package | Used by |
|
|
| --- | --- | --- |
|
|
| Java | `org.lance:lance-namespace-core` | Spark, Flink, Kafka, Trino, Presto; also LanceDB's Java client |
|
|
| Python | `lance-namespace` | Core interface and connect functionality |
|
|
| Rust | `lance-namespace` | Core interface, in [lance-format/lance](https://github.com/lance-format/lance) |
|
|
|
|
LanceDB's Java client builds on this Lance Namespace Java core: table creation,
|
|
listing and most other catalog operations go through the generated
|
|
`LanceNamespace` interface talking to Enterprise's REST Namespace endpoint.
|
|
The [real time engine](/tables/realtime-engine) is the one area with its own,
|
|
LanceDB-specific Java client on top, since RTE's LSM write path is not part of
|
|
the Lance Namespace specification.
|
|
|
|
See [lance.org/format/namespace](https://lance.org/format/namespace) for the
|
|
full spec and its other catalog implementations (Directory, Apache Polaris,
|
|
Unity Catalog, Apache Hive Metastore, Apache Iceberg REST Catalog, and more).
|
|
|
|
## Community SDKs {#community-sdks}
|
|
|
|
These clients are maintained by the community. Check each project's supported
|
|
features, installation instructions and releases before choosing one.
|
|
|
|
| Language | Project |
|
|
| --- | --- |
|
|
| Go | [lancedb-go](https://pkg.go.dev/github.com/lancedb/lancedb-go/pkg/lancedb) |
|
|
| Ruby | [Lancelot](https://github.com/scientist-labs/lancelot) |
|
|
| Swift | [LanceDbSwiftKit](https://github.com/RyanLisse/LanceDbSwiftKit) |
|
|
| R | [lancedb](https://github.com/CathalByrneGit/lancedb) |
|
|
| Flutter | [flutter_lancedb](https://github.com/Alexcn/flutter_lancedb) |
|
|
|
|
## Related guides {#next}
|
|
|
|
<CardGroup cols={2}>
|
|
<Card title="SQL" icon="table-list" href="/basics/sql">
|
|
Query Enterprise tables with SQL from Python or a Flight SQL client.
|
|
</Card>
|
|
<Card title="PyTorch Data Loader" icon="fire" href="/training/data-loading">
|
|
Use LanceDB tables in a DataLoader, including multiple worker processes.
|
|
</Card>
|
|
<Card title="Agentic Skills" icon="robot" href="/basics/agentic-skills">
|
|
Use the LanceDB plugin to help a coding agent work with your data.
|
|
</Card>
|
|
</CardGroup>
|