Unity Catalog Schema Connector

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/neo4j-labs/neocarta/llms.txt

Use this file to discover all available pages before exploring further.

​

What It Ingests

​

Limitations

• No REFERENCES edges — the open Unity Catalog API exposes no primary/foreign-key constraint metadata. is_primary_key and is_foreign_key are left null on all columns.
• No glossary or tags — the open REST API has no tag or glossary concept. Glossary support is a planned follow-up sourced from INFORMATION_SCHEMA.
• No value sampling — no Value nodes or HAS_VALUE edges are produced.
• Views are not a distinct node type — both tables and views become Table nodes.
• Client-side schema filtering — the schemas argument filters after listing all schemas; it does not push the filter to the server.

​

Import

from neocarta.connectors.unity_catalog import UnityCatalogSchemaConnector

​

Parameters

​

ingest() Parameters

​

Code Example

import os
from dotenv import load_dotenv
from neo4j import GraphDatabase
from neocarta.connectors.unity_catalog import UnityCatalogSchemaConnector

load_dotenv()

neo4j_driver = GraphDatabase.driver(
    uri=os.getenv("NEO4J_URI"),
    auth=(os.getenv("NEO4J_USERNAME"), os.getenv("NEO4J_PASSWORD")),
)
neo4j_database = os.getenv("NEO4J_DATABASE", "neo4j")

# The connector owns its HTTP client; use it as a context manager to release
# the connection pool on exit.
with UnityCatalogSchemaConnector(
    base_url=os.getenv("UC_SERVER_URL", "http://localhost:8080/api/2.1/unity-catalog"),
    token=os.getenv("UC_TOKEN"),   # None for a local OSS server
    neo4j_driver=neo4j_driver,
    database_name=neo4j_database,
) as connector:
    connector.ingest(
        catalog="unity",
        schemas=["default"],  # optional — omit to ingest all schemas
    )

neo4j_driver.close()
print("Connector completed successfully!")

​

CLI

pip install "neocarta[cli]"

neocarta unity-catalog schema \
  --base-url "http://localhost:8080/api/2.1/unity-catalog" \
  --catalog unity

​

Environment Variables

​

Source Setup

1. Run or point at a Unity Catalog server exposing the open REST API. For local testing, the open-source distribution provides a bin/start-uc-server script that listens on http://localhost:8080 with no authentication.
2. If the server enforces auth, obtain a bearer token and pass it via token= (sent as Authorization: Bearer <token>).
3. Identify the catalog name to ingest (and optionally the schemas to restrict to).