mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-09 08:08:32 +00:00
bf9e0423f2
Some checks failed
* WIP: v1 docs (#3626) (cherry picked from commit d46e20fa09bcd2f5916282f5553ddeb7183bd92c) * docs: parity for all translations * docs: full name of acronym AMP * docs: fix lingering unused code * docs: expand contextual options in docs.json * docs: add contextual action to request feature on GitHub * chore: tidy docs formatting
80 lines
1.8 KiB
Plaintext
80 lines
1.8 KiB
Plaintext
---
|
||
title: Databricks SQL Query Tool
|
||
description: The `DatabricksQueryTool` executes SQL queries against Databricks workspace tables.
|
||
icon: trowel-bricks
|
||
mode: "wide"
|
||
---
|
||
|
||
# `DatabricksQueryTool`
|
||
|
||
## Description
|
||
|
||
Run SQL against Databricks workspace tables with either CLI profile or direct host/token authentication.
|
||
|
||
## Installation
|
||
|
||
```shell
|
||
uv add crewai-tools[databricks-sdk]
|
||
```
|
||
|
||
## Environment Variables
|
||
|
||
- `DATABRICKS_CONFIG_PROFILE` or (`DATABRICKS_HOST` + `DATABRICKS_TOKEN`)
|
||
|
||
Create a personal access token and find host details in the Databricks workspace under User Settings → Developer.
|
||
Docs: https://docs.databricks.com/en/dev-tools/auth/pat.html
|
||
|
||
## Example
|
||
|
||
```python Code
|
||
from crewai import Agent, Task, Crew
|
||
from crewai_tools import DatabricksQueryTool
|
||
|
||
tool = DatabricksQueryTool(
|
||
default_catalog="main",
|
||
default_schema="default",
|
||
)
|
||
|
||
agent = Agent(
|
||
role="Data Analyst",
|
||
goal="Query Databricks",
|
||
tools=[tool],
|
||
verbose=True,
|
||
)
|
||
|
||
task = Task(
|
||
description="SELECT * FROM my_table LIMIT 10",
|
||
expected_output="10 rows",
|
||
agent=agent,
|
||
)
|
||
|
||
crew = Crew(
|
||
agents=[agent],
|
||
tasks=[task],
|
||
verbose=True,
|
||
)
|
||
result = crew.kickoff()
|
||
|
||
print(result)
|
||
```
|
||
|
||
## Parameters
|
||
|
||
- `query` (required): SQL query to execute
|
||
- `catalog` (optional): Override default catalog
|
||
- `db_schema` (optional): Override default schema
|
||
- `warehouse_id` (optional): Override default SQL warehouse
|
||
- `row_limit` (optional): Maximum rows to return (default: 1000)
|
||
|
||
## Defaults on initialization
|
||
|
||
- `default_catalog`
|
||
- `default_schema`
|
||
- `default_warehouse_id`
|
||
|
||
### Error handling & tips
|
||
|
||
- Authentication errors: verify `DATABRICKS_HOST` begins with `https://` and token is valid.
|
||
- Permissions: ensure your SQL warehouse and schema are accessible by your token.
|
||
- Limits: long‑running queries should be avoided in agent loops; add filters/limits.
|