.env.example

# Databricks Zerobus Configuration
# Copy this file to .env and fill in your actual values
# 
# DO NOT commit .env to version control - it contains sensitive credentials

# ============================================================================
# Databricks Workspace Configuration
# ============================================================================

# Your Databricks workspace host URL (used for Unity Catalog authentication)
# Find this in your browser when logged into Databricks (the base URL before /o=...)
# Example: https://dbc-a1b2c3d4-e5f6.cloud.databricks.com
DATABRICKS_HOST=https://your-workspace.cloud.databricks.com

# ============================================================================
# Zerobus Endpoint Configuration
# ============================================================================

# Zerobus server endpoint for gRPC streaming ingestion
# Format: https://<workspace-id>.zerobus.<region>.cloud.databricks.com
#
# To find your workspace ID:
#   1. Look at your Databricks workspace URL in the browser
#   2. The workspace ID is the number after ?o=
#   3. Example: If URL is https://...cloud.databricks.com/?o=1234567890123456
#      Your workspace ID is: 1234567890123456
#
# 
# Example: https://1234567890123456.zerobus.us-west-2.cloud.databricks.com
ZEROBUS_ENDPOINT=https://<workspace-id>.zerobus.<region>.cloud.databricks.com

# ============================================================================
# Service Principal OAuth Credentials
# ============================================================================

# Service principal application ID (UUID format)
# Create a service principal in Databricks: Settings > Identity and Access
# This is also called the "Application ID" in the service principal page
DATABRICKS_CLIENT_ID=your-service-principal-application-id

# Service principal client secret
# Generate this when creating the service principal - save it securely as it's shown only once
DATABRICKS_CLIENT_SECRET=your-service-principal-secret

# ============================================================================
# Unity Catalog Table Configuration
# ============================================================================

# Fully qualified Unity Catalog table name in format: catalog.schema.table
# Example: main.default.my_table
#
# Ensure your service principal has the following permissions:
#   GRANT USE CATALOG ON CATALOG <catalog> TO `<service-principal-uuid>`;
#   GRANT USE SCHEMA ON SCHEMA <catalog.schema> TO `<service-principal-uuid>`;
#   GRANT MODIFY, SELECT ON TABLE <catalog.schema.table> TO `<service-principal-uuid>`;
TABLE_NAME=catalog.schema.table

# ============================================================================
# Additional Notes
# ============================================================================
#
# 1. The service principal must be granted permissions on the target table
# 2. The table should be a Delta table in Unity Catalog
# 3. Protocol Buffer schemas should match your table schema exactly (use generate_files tool)
# 
# For more information:
# https://docs.databricks.com/aws/en/ingestion/lakeflow-connect/zerobus-ingest?language=Rust%C2%A0SDK