mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-01-07 23:28:30 +00:00
1a1bb0ca3d
* docs(cli): document device-code login and config reset guidance; renumber sections * docs(cli): fix duplicate numbering (renumber Login/API Keys/Configuration sections) * docs: Fix webhook documentation to include meta dict in all webhook payloads - Add note explaining that meta objects from kickoff requests are included in all webhook payloads - Update webhook examples to show proper payload structure including meta field - Fix webhook examples to match actual API implementation - Apply changes to English, Korean, and Portuguese documentation Resolves the documentation gap where meta dict passing to webhooks was not documented despite being implemented in the API. * WIP: CrewAI docs theme, changelog, GEO, localization * docs(cli): fix merge markers; ensure mode: "wide"; convert ASCII tables to Markdown (en/pt-BR/ko) * docs: add group icons across locales; split Automation/Integrations; update tools overviews and links
63 lines
1.3 KiB
Plaintext
63 lines
1.3 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()
|
||
```
|
||
|
||
|