mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-09 16:18:30 +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
61 lines
1.2 KiB
Plaintext
61 lines
1.2 KiB
Plaintext
---
|
||
title: SingleStore Search Tool
|
||
description: The `SingleStoreSearchTool` safely executes SELECT/SHOW queries on SingleStore with pooling.
|
||
icon: circle
|
||
mode: "wide"
|
||
---
|
||
|
||
# `SingleStoreSearchTool`
|
||
|
||
## Description
|
||
|
||
Execute read‑only queries (`SELECT`/`SHOW`) against SingleStore with connection pooling and input validation.
|
||
|
||
## Installation
|
||
|
||
```shell
|
||
uv add crewai-tools[singlestore]
|
||
```
|
||
|
||
## Environment Variables
|
||
|
||
Variables like `SINGLESTOREDB_HOST`, `SINGLESTOREDB_USER`, `SINGLESTOREDB_PASSWORD`, etc., can be used, or `SINGLESTOREDB_URL` as a single DSN.
|
||
|
||
Generate the API key from the SingleStore dashboard, [docs here](https://docs.singlestore.com/cloud/reference/management-api/#generate-an-api-key).
|
||
|
||
## Example
|
||
|
||
```python Code
|
||
from crewai import Agent, Task, Crew
|
||
from crewai_tools import SingleStoreSearchTool
|
||
|
||
tool = SingleStoreSearchTool(
|
||
tables=["products"],
|
||
host="host",
|
||
user="user",
|
||
password="pass",
|
||
database="db",
|
||
)
|
||
|
||
agent = Agent(
|
||
role="Analyst",
|
||
goal="Query SingleStore",
|
||
tools=[tool],
|
||
verbose=True,
|
||
)
|
||
|
||
task = Task(
|
||
description="List 5 products",
|
||
expected_output="5 rows as JSON/text",
|
||
agent=agent,
|
||
)
|
||
|
||
crew = Crew(
|
||
agents=[agent],
|
||
tasks=[task],
|
||
verbose=True,
|
||
)
|
||
|
||
result = crew.kickoff()
|
||
```
|