feat: fastapi readme

Author: DoyleDev

fastapi/.env.example

@@ -5,9 +5,6 @@ LAKEBASE_CATALOG_NAME=<LAKEBASE_CATALOG_NAME> # Name of the Lakebase catalog
 SYNCHED_TABLE_STORAGE_CATALOG=<SYNCED_TABLE_CATALOG> # Catalog where you have permissions to create tables. Used to store metadata from the lakebase synced table pipeline.
 SYNCHED_TABLE_STORAGE_SCHEMA=<SYNCED_TABLE_SCHEMA> # Schema where you have permissions to create tables. Used to store metadata from the lakebase synced table pipeline.
 DATABRICKS_DATABASE_PORT=5432
-DATABRICKS_HOST=<DATABRICKS_HOST> # e.g., https://adb-1234567890123456.7.azuredatabricks.net
-DATABRICKS_TOKEN=<PAT_TOKEN> # e.g., dapi
-DATABRICKS_USER_NAME=<YOUR_USER_NAME> # e.g., [email protected]
 
 # Database Connection Pool Settings
 DB_POOL_SIZE=5

fastapi/README.md

@@ -12,6 +12,8 @@ The sample application provides the following API endpoints:
 #### API v1
 - `/api/v1/healthcheck` - Returns a response to validate the health of the application
 - `/api/v1/table` - Query data from Databricks tables
+- `/api/v1/resources/create-lakebase-resources` - Create Lakebase resources
+- `/api/v1/resources/delete-lakebase-resources` - Delete Lakebase resources
 - `/api/v1/orders/count` - Get total order count from Lakebase (PostgreSQL) database
 - `/api/v1/orders/sample` - Get sample order keys for testing
 - `/api/v1/orders/pages` - Get orders with traditional page-based pagination
@@ -35,10 +37,42 @@ pip install -r requirements.txt
 # Set environment variables (if not using .env file)
 export DATABRICKS_WAREHOUSE_ID=your-warehouse-id
 
+# If using a .env file: 
+cp .env.example .env 
+# Fill in .env fields
+
 # Run the application
 uvicorn app:app --reload
 ```
 
+## Running the Lakebase Example
+
+❗️**Important**: Following these steps will deploy a Lakebase instance and synced table pipeline in your Databricks workspace that will incur costs.
+
+### 1. Create Lakebase Resources
+With the app running and your `.env` file configured:
+1. Navigate to http://localhost:8000/docs (Swagger UI)
+2. Find the `/api/v1/resources/create-lakebase-resources` endpoint
+3. Click **Try it out**
+4. Set `create_resources` to `true` (confirming you understand the costs)
+5. Configure other fields as needed
+6. Click **Execute**
+7. Wait for resource creation (takes several minutes)
+
+### 2. Validate and Test
+Once resources are created:
+1. Check the Databricks UI for: database instance, database, catalog, and `orders_synced` table
+2. Restart your local app: `uvicorn app:app --reload`
+3. Return to http://localhost:8000/docs - you should now see the `/orders` endpoints available
+
+### 3. Clean Up Resources
+To avoid ongoing costs:
+1. Navigate to `/api/v1/resources/delete-lakebase-resources` endpoint
+2. Set `confirm_deletion` to `true`
+3. Click **Execute**
+
+    
+
 ## Running Tests
 
 ```bash
@@ -68,13 +102,14 @@ The application uses environment variables for configuration:
 - `DATABRICKS_TOKEN` - (Optional) The Databricks access token
 
 ### Lakebase PostgreSQL Database (for orders management)
-- `DATABRICKS_DATABASE_INSTANCE` - The name of the Databricks database instance
-- `DATABRICKS_DATABASE_NAME` - The Lakebase PostgreSQL database name
+- `LAKEBASE_INSTANCE_NAME` - The name of an existing Databricks database instance or the name of a new instance
+- `LAKEBASE_DATABASE_NAME` - The Lakebase PostgreSQL database name
+- `LAKEBASE_CATALOG_NAME` - The name of the Lakebase catalog
+- `SYNCHED_TABLE_STORAGE_CATALOG` - Catalog where you have permissions to create tables. Used to store metadata from the lakebase synced table pipeline.
+- `SYNCHED_TABLE_STORAGE_SCHEMA` - Schema where you have permissions to create tables. Used to store metadata from the lakebase synced table pipeline.
 - `DATABRICKS_DATABASE_PORT` - (Optional) Database port (default: 5432)
-- `DEFAULT_POSTGRES_SCHEMA` - (Optional) Database schema (default: public)
-- `DEFAULT_POSTGRES_TABLE` - (Optional) Orders table name (default: orders_synced)
 - `DB_POOL_SIZE` - (Optional) Connection pool size (default: 5)
 - `DB_MAX_OVERFLOW` - (Optional) Max pool overflow (default: 10)
-- `DB_POOL_TIMEOUT` - (Optional) Pool timeout in seconds (default: 30)
-- `DB_COMMAND_TIMEOUT` - (Optional) Command timeout in seconds (default: 10)
+- `DB_POOL_TIMEOUT` - (Optional) Pool timeout in seconds (default: 10)
+- `DB_COMMAND_TIMEOUT` - (Optional) Command timeout in seconds (default: 30)
 - `DB_POOL_RECYCLE_INTERVAL` - (Optional) Connection recycle interval in seconds (default: 3600)

fastapi/requirements.txt

@@ -6,7 +6,7 @@ pytest>=7.4.0
 pytest-mock>=3.10.0
 pytest-asyncio>=0.21.0
 httpx>=0.24.1
-databricks-sdk>=0.8.0
+databricks-sdk>=0.61.0
 databricks-sql-connector==4.0.2
 pandas>=2.0.0
 annotated-types==0.7.0