atlas-lakebase

Atlas for Databricks Lakebase

What is specific to Databricks Lakebase when Atlas manages the schema. Lakebase is managed PostgreSQL, and Atlas connects to it with the postgres driver: the atlas-postgres skill covers the schema work (URL scope, the dev database, roles and grants, objects, lint, and tests), and the atlas skill covers the workflows. This skill covers connecting to Lakebase and the objects Lakebase manages. Guide: https://atlasgo.io/guides/postgres/databricks-lakebase.

Requires

The atlas and atlas-postgres skills, installed next to this one. Read ../atlas-postgres/SKILL.md and ../atlas/SKILL.md before you start, and follow them for everything this skill does not cover: this skill only adds what differs on Lakebase. If one is missing, download https://atlasgo.io/skills//SKILL.md to ../<skill>/SKILL.md, and each reference file listed in its Files section to ../<skill>/references/<name>.

Rules

1. Check the login first with atlas whoami. If it shows no login, ask the user to run atlas login: the databricks_lakebase_token data source needs it. A user without an account can start a free trial with atlas login. An Atlas release older than the data source fails every env in the file with missing data source handler for "databricks_lakebase_token": run atlas version, and install the latest release.

2. Connect with a token from the data source. endpoint is the endpoint path, and the URL user is the Postgres role of the identity the token is issued to: the email of a Databricks user, or the application ID of a service principal. urluserinfo sets both and escapes the @:

   locals {
     host = "ep-example.database.us-west-2.cloud.databricks.com"
     user = "[email protected]"
   }
   
   data "databricks_lakebase_token" "db" {
     endpoint = "projects/my-app/branches/production/endpoints/primary"
   }
   
   env "lakebase" {
     url = urluserinfo(
       "postgres://${local.host}:5432/databricks_postgres?sslmode=require&search_path=public",
       local.user,
       data.databricks_lakebase_token.db,
     )
     dev = "docker://postgres/17/dev?search_path=public"
     // Functions that Lakebase manages in "public" (Rule 5).
     exclude = [
       "grant_usage_on_new_schema[type=function]",
       "grant_all_on_new_sequences[type=function]",
       "grant_select_on_new_objects[type=function]",
     ]
     schema {
       src = "file://schema.sql"
     }
   }