An example of a bundle that creates Lakebase database instance and catalog

Author: anton-107

knowledge_base/database_with_catalog/README.md

@@ -0,0 +1,27 @@
+# OLTP database instance with a catalog
+
+This example demonstrates how to define an OLTP database instance and a database catalog in a Databricks Asset Bundle.
+
+It includes and deploys an example database instance and a catalog. When the instance is making changes to the database, the changes are reflected in Unity Catalog.
+
+For more information about Databricks database instances, see the [documentation](https://docs.databricks.com/aws/en/oltp/).
+
+## Prerequisites
+
+* Databricks CLI v0.265.0 or above
+
+## Usage
+
+Modify `databricks.yml`:
+* Update the `host` field under `workspace` to the Databricks workspace to deploy to
+
+Run `databricks bundle deploy` to deploy the bundle.
+
+Run the following queries to populate your database with sample data:
+
+- `databricks psql my-instance -- -d my_database -c "CREATE TABLE IF NOT EXISTS hello_world (id SERIAL PRIMARY KEY, message TEXT, number INTEGER, created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP);"`
+- `databricks psql my-instance -- -d my_database -c "INSERT INTO hello_world (message, number) SELECT 'Hello World #' || generate_series, generate_series FROM generate_series(1, 100);"`
+- `databricks psql my-instance -- -d my_database -c "SELECT * FROM hello_world;"`
+
+Open your catalog in Databricks Workspace to explore generated data in Unity Catalog: `databricks bundle open my_catalog`
+Navigate to `public` schema, then to `hello_world` table, then to "Sample data"

knowledge_base/database_with_catalog/databricks.yml

@@ -0,0 +1,31 @@
+bundle:
+  name: database-catalog-example
+
+# workspace:
+#   host: https://myworkspace.cloud.databricks.com
+
+resources:
+  database_instances:
+    my_instance:
+      name: my-instance
+      capacity: CU_1
+  database_catalogs:
+    my_catalog:
+      database_instance_name: ${resources.database_instances.my_instance.name}
+      name: example_catalog
+      database_name: my_database
+      create_database_if_not_exists: true
+
+
+# Defines the targets for this bundle.
+# Targets allow you to deploy the same bundle to different Databricks workspaces.
+targets:
+  prod: { 
+    # No overrides
+  }
+  dev:
+    # This target is for development purposes.
+    # It defaults to the current Databricks workspace.
+    default: true
+    mode: development
+