API Docs

geneva.connect

connect(
    uri: str | Path | None = None,
    *,
    region: str | None = None,
    api_key: Credential | str | None = None,
    host_override: str | None = None,
    storage_options: dict[str, str] | None = None,
    checkpoint: str | CheckpointStore | None = None,
    system_namespace: list[str] | None = None,
    namespace_impl: str | None = None,
    namespace_properties: dict[str, str] | None = None,
    upload_dir: str | None = None,
    **kwargs,
) -> Connection

Create a Geneva Connection to an existing database.

Examples:

import geneva
# Connect to a database in object storage
conn = geneva.connect("s3://my-storage-bucket/my-database")
# Connect using directory namespace
conn = geneva.connect(
    namespace_impl="dir", namespace_properties={"root": "/path"}
)
# Connect using REST namespace
conn = geneva.connect(
    namespace_impl="rest", namespace_properties={"uri": f"http://127.0.0.1:1234"}
)
# Connect with Phalanx remote server and separate upload bucket
conn = geneva.connect(
    uri="db://my_database",
    api_key="my-api-key",
    host_override="https://phalanx.example.com",
    upload_dir="s3://my-upload-bucket/manifests",
)
tbl = conn.open_table("youtube_dataset")

Parameters:

• uri (str | Path | None, default: None ) –

  LanceDB Database URI, or a S3/GCS path. If not provided and namespace_impl is set, defaults to "namespace://".

• region (str | None, default: None ) –

  LanceDB cloud region. Set to None on LanceDB Enterprise

• api_key (Credential | str | None, default: None ) –

  Optional API key for enterprise endpoint

• host_override (str | None, default: None ) –

  Optional host URI for enterprise endpoint

• system_namespace (list[str] | None, default: None ) –

  Namespace for system tables (manifests, clusters, jobs, errors). Defaults to config value if not provided.

• namespace_impl (str | None, default: None ) –

  The namespace implementation to use (e.g., "dir", "rest"). If provided, connects using namespace instead of local database.

• namespace_properties (dict[str, str] | None, default: None ) –

  Configuration properties for the namespace implementation.

• upload_dir (str | None, default: None ) –

  Optional separate bucket/path for manifest uploads. This allows the client to upload manifests to a separate bucket instead of the data bucket where manifests are uploaded by default.

Returns:

• Connection - A LanceDB connection –