Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
150 changes: 145 additions & 5 deletions docs/ai_builder/integrations/databricks.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,41 @@ rx.el.div(
)
```

3 - Generate a **Personal Access Token** (**DATABRICKS_TOKEN**):

3 - Get your **DATABRICKS_CATALOG** and **DATABRICKS_SCHEMA**:
- Click the SQL Editor from the sidebar.
- Choose the **DATABRICKS_CATALOG** and **DATABRICKS_SCHEMA** from the dropdowns as shown below.


```python eval
rx.el.div(
image_zoom(
rx.image(
src="/ai_builder/integrations/databricks_integration_4.webp",
class_name="p-2 rounded-md h-auto",
border=f"0.81px solid {rx.color('slate', 5)}",
),
class_name="rounded-md overflow-hidden",
),
class_name="w-full flex flex-col rounded-md cursor-pointer",
)
```

```python eval
rx.box(height="2rem")
```

4 - Obtain your authentication credentials:

There are two methods to authenticate your app with Databricks: using a **Personal Access Token** or via **OAuth**. Choose one of the methods below to obtain the necessary credentials.


---md tabs

--tab Personal Access Token
## Generate a Personal Access Token (DATABRICKS_TOKEN)


- Click on your profile icon → **Settings**.
- Click **Developer**.
- Click **Manage** in Access Tokens.
Expand Down Expand Up @@ -86,16 +120,21 @@ rx.el.div(
)
```

4 - Get your **DATABRICKS_CATALOG** and **DATABRICKS_SCHEMA**:
- Click the SQL Editor from the sidebar.
- Choose the **DATABRICKS_CATALOG** and **DATABRICKS_SCHEMA** from the dropdowns as shown below.



--
--tab OAuth
## Use OAuth (DATABRICKS_CLIENT_ID and DATABRICKS_CLIENT_SECRET)

- Open the dropdown in the top right corner and select **Manage Account**.


```python eval
rx.el.div(
image_zoom(
rx.image(
src="/ai_builder/integrations/databricks_integration_4.webp",
src="/ai_builder/integrations/databricks_integration_oauth_1.webp",
class_name="p-2 rounded-md h-auto",
border=f"0.81px solid {rx.color('slate', 5)}",
),
Expand All @@ -105,6 +144,107 @@ rx.el.div(
)
```

- Select `Users and Groups`

```python eval
rx.el.div(
image_zoom(
rx.image(
src="/ai_builder/integrations/databricks_integration_oauth_2.webp",
class_name="p-2 rounded-md h-auto",
border=f"0.81px solid {rx.color('slate', 5)}",
),
class_name="rounded-md overflow-hidden",
),
class_name="w-full flex flex-col rounded-md cursor-pointer",
)
```

- Select the `Service Principals` tab and click `Add Service Principal`.

```python eval
rx.el.div(
image_zoom(
rx.image(
src="/ai_builder/integrations/databricks_integration_oauth_3.webp",
class_name="p-2 rounded-md h-auto",
border=f"0.81px solid {rx.color('slate', 5)}",
),
class_name="rounded-md overflow-hidden",
),
class_name="w-full flex flex-col rounded-md cursor-pointer",
)
```

- Fill in the details and click `Add Service Principal`.

```python eval
rx.el.div(
image_zoom(
rx.image(
src="/ai_builder/integrations/databricks_integration_oauth_4.webp",
class_name="p-2 rounded-md h-auto",
border=f"0.81px solid {rx.color('slate', 5)}",
),
class_name="rounded-md overflow-hidden",
),
class_name="w-full flex flex-col rounded-md cursor-pointer",
)
```

- Click the `Credentials and Secrets` tab and click `Generate Secret`.


```python eval
rx.el.div(
image_zoom(
rx.image(
src="/ai_builder/integrations/databricks_integration_oauth_5.webp",
class_name="p-2 rounded-md h-auto",
border=f"0.81px solid {rx.color('slate', 5)}",
),
class_name="rounded-md overflow-hidden",
),
class_name="w-full flex flex-col rounded-md cursor-pointer",
)
```

- Set a lifetime for the secrets and click `Generate`.

```python eval
rx.el.div(
image_zoom(
rx.image(
src="/ai_builder/integrations/databricks_integration_oauth_6.webp",
class_name="p-2 rounded-md h-auto",
border=f"0.81px solid {rx.color('slate', 5)}",
),
class_name="rounded-md overflow-hidden",
),
class_name="w-full flex flex-col rounded-md cursor-pointer",
)
```

- Copy the generated **DATABRICKS_CLIENT_ID** and **DATABRICKS_CLIENT_SECRET**.

```python eval
rx.el.div(
image_zoom(
rx.image(
src="/ai_builder/integrations/databricks_integration_oauth_7.webp",
class_name="p-2 rounded-md h-auto",
border=f"0.81px solid {rx.color('slate', 5)}",
),
class_name="rounded-md overflow-hidden",
),
class_name="w-full flex flex-col rounded-md cursor-pointer",
)
```

--

---



## Step 2: Configure the Integration in Your App
Expand Down