From 52294395c664ac937880b57dd5b093b6c8cde2e8 Mon Sep 17 00:00:00 2001
From: prrao87 <35005448+prrao87@users.noreply.github.com>
Date: Mon, 18 May 2026 11:31:07 -0400
Subject: [PATCH] Update connection settings for Enterprise in quickstart
---
docs/quickstart.mdx | 41 ++++++++++++++++++++++--------------
docs/snippets/connection.mdx | 8 -------
docs/tables/index.mdx | 11 ++++++----
tests/py/test_connection.py | 14 ------------
tests/rs/connection.rs | 11 ----------
tests/ts/connection.test.ts | 9 --------
6 files changed, 32 insertions(+), 62 deletions(-)
diff --git a/docs/quickstart.mdx b/docs/quickstart.mdx
index 4f6fc0e..c2ba3d8 100644
--- a/docs/quickstart.mdx
+++ b/docs/quickstart.mdx
@@ -7,15 +7,14 @@ icon: rocket
import {
PyConnect,
PyConnectAsync,
- PyConnectEnterprise,
- PyConnectEnterpriseAsync,
+ PyConnectEnterpriseQuickstart,
PyConnectObjectStorage,
PyConnectObjectStorageAsync,
RsConnect,
- RsConnectEnterprise,
+ RsConnectEnterpriseQuickstart,
RsConnectObjectStorage,
TsConnect,
- TsConnectEnterprise,
+ TsConnectEnterpriseQuickstart,
TsConnectObjectStorage,
} from '/snippets/connection.mdx';
import {
@@ -113,29 +112,39 @@ For credentials, endpoints, and provider-specific options, see
### Connect to LanceDB Enterprise
-If you're using LanceDB Enterprise, you can connect using a `db://` URI,
-along with any necessary credentials. Simply replace the local path with a remote `uri`
-that points to where your data is stored, and you're ready to go.
+If you're using LanceDB Enterprise, you can connect using a `db://` URI along
+with the API key, region, and cluster endpoint you received from the LanceDB
+team. Pass the cluster endpoint via `host_override` so the client routes
+requests to your deployment.
-
- {PyConnectEnterprise}
-
-
-
- {PyConnectEnterpriseAsync}
+
+ { "import lancedb\n\n" }
+ {PyConnectEnterpriseQuickstart}
- {TsConnectEnterprise}
+ { "import * as lancedb from \"@lancedb/lancedb\";\n\n" }
+ {TsConnectEnterpriseQuickstart}
- {RsConnectEnterprise}
+ { "use lancedb::connect;\n\n" }
+ {RsConnectEnterpriseQuickstart}
-To learn more about LanceDB Enterprise, see the [Enterprise documentation](/enterprise).
+
+`host_override` is the full URL of your cluster endpoint, including the scheme
+(`https://`) and a port if your deployment listens on a non-default one
+(e.g. `https://your-enterprise-endpoint.com:443`). If you don't know the
+endpoint, [contact the LanceDB team](mailto:contact@lancedb.com).
+
+
+For a walkthrough on how to use LanceDB Enterprise (including `RemoteTable`
+semantics), see its [quickstart](/enterprise/quickstart). To learn
+more about LanceDB Enterprise overall, see the
+[Enterprise documentation](/enterprise).
## 3. Obtain data and ingest into LanceDB
diff --git a/docs/snippets/connection.mdx b/docs/snippets/connection.mdx
index 2228877..779a374 100644
--- a/docs/snippets/connection.mdx
+++ b/docs/snippets/connection.mdx
@@ -4,10 +4,6 @@ export const PyConnect = "import lancedb\n\nuri = \"ex_lancedb\"\ndb = lancedb.c
export const PyConnectAsync = "import lancedb\n\nuri = \"ex_lancedb\"\nasync_db = await lancedb.connect_async(uri)\n";
-export const PyConnectEnterprise = "uri = \"db://your-database-uri\"\napi_key = \"your-api-key\"\nregion = \"us-east-1\"\n";
-
-export const PyConnectEnterpriseAsync = "uri = \"db://your-database-uri\"\napi_key = \"your-api-key\"\nregion = \"us-east-1\"\n";
-
export const PyConnectEnterpriseQuickstart = "uri = \"db://your-database-uri\"\napi_key = \"your-api-key\"\nregion = \"us-east-1\"\nhost_override = \"https://your-enterprise-endpoint.com\"\n\ndb = lancedb.connect(\n uri=uri,\n api_key=api_key,\n region=region,\n host_override=host_override,\n)\n";
export const PyConnectObjectStorage = "import lancedb\n\nuri = \"s3://your-bucket/path\"\n# You can also use \"gs://your-bucket/path\" or \"az://your-container/path\".\ndb = lancedb.connect(uri)\n";
@@ -20,8 +16,6 @@ export const PyNamespaceTableOps = "import lancedb\n\ndb = lancedb.connect_names
export const TsConnect = "import * as lancedb from \"@lancedb/lancedb\";\n\nasync function connectExample(uri: string) {\n const db = await lancedb.connect(uri);\n return db;\n}\n";
-export const TsConnectEnterprise = "const uri = \"db://your-database-uri\";\nconst apiKey = \"your-api-key\";\nconst region = \"us-east-1\";\n";
-
export const TsConnectEnterpriseQuickstart = "const uri = \"db://your-database-uri\";\nconst apiKey = \"your-api-key\";\nconst region = \"us-east-1\";\nconst hostOverride = \"https://your-enterprise-endpoint.com\";\n\nconst db = await lancedb.connect(uri, {\n apiKey,\n region,\n hostOverride,\n});\n";
export const TsConnectObjectStorage = "async function connectObjectStorageExample() {\n const uri = \"s3://your-bucket/path\";\n // You can also use \"gs://your-bucket/path\" or \"az://your-container/path\".\n const db = await lancedb.connect(uri);\n return db;\n}\n";
@@ -32,8 +26,6 @@ export const TsNamespaceTableOps = "const db = await lancedb.connectNamespace(\"
export const RsConnect = "async fn connect_example(uri: &str) {\n let db = connect(uri).execute().await.unwrap();\n let _ = db;\n}\n";
-export const RsConnectEnterprise = "let uri = \"db://your-database-uri\";\nlet api_key = \"your-api-key\";\nlet region = \"us-east-1\";\n";
-
export const RsConnectEnterpriseQuickstart = "let uri = \"db://your-database-uri\";\nlet api_key = \"your-api-key\";\nlet region = \"us-east-1\";\nlet host_override = \"https://your-enterprise-endpoint.com\";\n";
export const RsConnectObjectStorage = "let uri = \"s3://your-bucket/path\";\n// You can also use \"gs://your-bucket/path\" or \"az://your-container/path\".\n";
diff --git a/docs/tables/index.mdx b/docs/tables/index.mdx
index d449397..eb54017 100644
--- a/docs/tables/index.mdx
+++ b/docs/tables/index.mdx
@@ -6,7 +6,7 @@ icon: "table"
keywords: ["create table", "polars", "pandas", "pyarrow", "dataframe", "nested data"]
---
-import { PyConnect, PyConnectEnterprise, TsConnect, TsConnectEnterprise, RsConnect, RsConnectEnterprise } from '/snippets/connection.mdx';
+import { PyConnect, PyConnectEnterpriseQuickstart, TsConnect, TsConnectEnterpriseQuickstart, RsConnect, RsConnectEnterpriseQuickstart } from '/snippets/connection.mdx';
import {
PyBasicImports,
PyDataLoad,
@@ -183,15 +183,18 @@ that points to where your data is stored, and you're ready to go.
- {PyConnectEnterprise}
+ { "import lancedb\n\n" }
+ {PyConnectEnterpriseQuickstart}
- {TsConnectEnterprise}
+ { "import * as lancedb from \"@lancedb/lancedb\";\n\n" }
+ {TsConnectEnterpriseQuickstart}
- {RsConnectEnterprise}
+ { "use lancedb::connect;\n\n" }
+ {RsConnectEnterpriseQuickstart}
diff --git a/tests/py/test_connection.py b/tests/py/test_connection.py
index 65f3c4f..783ac2d 100644
--- a/tests/py/test_connection.py
+++ b/tests/py/test_connection.py
@@ -28,20 +28,6 @@ async def connect_async_example():
return async_db
-# --8<-- [start:connect_enterprise]
-uri = "db://your-database-uri"
-api_key = "your-api-key"
-region = "us-east-1"
-# --8<-- [end:connect_enterprise]
-
-
-# --8<-- [start:connect_enterprise_async]
-uri = "db://your-database-uri"
-api_key = "your-api-key"
-region = "us-east-1"
-# --8<-- [end:connect_enterprise_async]
-
-
def connect_enterprise_quickstart_config():
import lancedb
diff --git a/tests/rs/connection.rs b/tests/rs/connection.rs
index 952e261..c68bbf8 100644
--- a/tests/rs/connection.rs
+++ b/tests/rs/connection.rs
@@ -19,21 +19,10 @@ async fn main() {
connect_example(uri.to_str().unwrap()).await;
// Keep the enterprise snippet in this file, but don't run it in CI.
- let _ = connect_enterprise_config();
let _ = connect_enterprise_quickstart_config();
let _ = connect_object_storage_config();
}
-fn connect_enterprise_config() -> (String, String, String) {
- // --8<-- [start:connect_enterprise]
- let uri = "db://your-database-uri";
- let api_key = "your-api-key";
- let region = "us-east-1";
- // --8<-- [end:connect_enterprise]
-
- (uri.to_string(), api_key.to_string(), region.to_string())
-}
-
fn connect_enterprise_quickstart_config() -> (String, String, String, String) {
// --8<-- [start:connect_enterprise_quickstart]
let uri = "db://your-database-uri";
diff --git a/tests/ts/connection.test.ts b/tests/ts/connection.test.ts
index 45ed652..f522654 100644
--- a/tests/ts/connection.test.ts
+++ b/tests/ts/connection.test.ts
@@ -20,12 +20,6 @@ test("connect to a local database", async () => {
});
});
-// --8<-- [start:connect_enterprise]
-const uri = "db://your-database-uri";
-const apiKey = "your-api-key";
-const region = "us-east-1";
-// --8<-- [end:connect_enterprise]
-
async function connectEnterpriseQuickstart() {
// --8<-- [start:connect_enterprise_quickstart]
const uri = "db://your-database-uri";
@@ -120,9 +114,6 @@ async function namespaceAdminOpsExample() {
}
void [
- uri,
- apiKey,
- region,
connectObjectStorageExample,
connectEnterpriseQuickstart,
namespaceTableOpsExample,