com.lancedb

Class LanceDbNamespaceClientBuilder

java.lang.Object

com.lancedb.LanceDbNamespaceClientBuilder

public class LanceDbNamespaceClientBuilder
extends Object

Util class to help construct a LanceNamespace for LanceDB.

For LanceDB Cloud, use the simplified builder API:

 import org.lance.namespace.LanceNamespace;

 // If your DB url is db://example-db, then your database here is example-db
 LanceNamespace namespaceClient = LanceDbNamespaceClientBuilder.newBuilder()
     .apiKey("your_lancedb_cloud_api_key")
     .database("your_database_name")
     .build();
 

For LanceDB Enterprise deployments, use your custom endpoint:

 LanceNamespace namespaceClient = LanceDbNamespaceClientBuilder.newBuilder()
     .apiKey("your_lancedb_enterprise_api_key")
     .database("your_database_name")
     .endpoint("<your_enterprise_endpoint>")
     .build();
 

Method Summary

Modifier and Type	Method and Description
LanceDbNamespaceClientBuilder	apiKey(String apiKey) Set the API key (required).
org.lance.namespace.LanceNamespace	build() Build the LanceNamespace instance.
LanceDbNamespaceClientBuilder	config(String key, String value) Add additional configuration parameters.
LanceDbNamespaceClientBuilder	database(String database) Set the database name (required).
LanceDbNamespaceClientBuilder	endpoint(String endpoint) Set a custom endpoint URL (optional).
static LanceDbNamespaceClientBuilder	newBuilder() Create a new builder instance.
LanceDbNamespaceClientBuilder	region(String region) Set the region for LanceDB Cloud (optional).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

newBuilder

public static LanceDbNamespaceClientBuilder newBuilder()

Create a new builder instance.

Returns:

A new LanceDbNamespaceClientBuilder

apiKey

public LanceDbNamespaceClientBuilder apiKey(String apiKey)

Set the API key (required).

Parameters:

apiKey - The LanceDB API key

Returns:

This builder

database

public LanceDbNamespaceClientBuilder database(String database)

Set the database name (required).

Parameters:

database - The database name

Returns:

This builder

endpoint

public LanceDbNamespaceClientBuilder endpoint(String endpoint)

Set a custom endpoint URL (optional). When set, this overrides the default LanceDB Cloud URL construction. Use this for LanceDB Enterprise deployments.

Parameters:

endpoint - The complete base URL for your LanceDB Enterprise deployment

Returns:

This builder

region

public LanceDbNamespaceClientBuilder region(String region)

Set the region for LanceDB Cloud (optional). Defaults to "us-east-1" if not specified. This is ignored when endpoint is set.

Parameters:

region - The AWS region (e.g., "us-east-1", "eu-west-1")

Returns:

This builder

config

public LanceDbNamespaceClientBuilder config(String key,
                                            String value)

Add additional configuration parameters.

Parameters:

key - The configuration key

value - The configuration value

Returns:

This builder

build

public org.lance.namespace.LanceNamespace build()

Build the LanceNamespace instance.

Returns:

A configured LanceNamespace

Throws:

IllegalStateException - if required parameters are missing