mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-18 19:05:19 -05:00
This PR introduces a significant update to the Toolbox configuration file format, which is one of the primary **breaking changes** required for the implementation of the Advanced Control Plane. # Summary of Changes The configuration schema has been updated to enforce resource isolation and facilitate atomic, incremental updates. * Resource Isolation: Resource definitions are now separated into individual blocks, using a distinct structure for each resource type (Source, Tool, Toolset, etc.). This improves readability, management, and auditing of configuration files. * Field Name Modification: Internal field names have been modified to align with declarative methodologies. Specifically, the configuration now separates kind (general resource type, e.g., Source) from type (specific implementation, e.g., Postgres). # User Impact Existing tools.yaml configuration files are now in an outdated format. Users must eventually update their files to the new YAML format. # Mitigation & Compatibility Backward compatibility is maintained during this transition to ensure no immediate user action is required for existing files. * Immediate Backward Compatibility: The source code includes a pre-processing layer that automatically detects outdated configuration files (v1 format) and converts them to the new v2 format under the hood. * [COMING SOON] Migration Support: The new toolbox migrate subcommand will be introduced to allow users to automatically convert their old configuration files to the latest format. # Example Example for config file v2: ``` kind: sources name: my-pg-instance type: cloud-sql-postgres project: my-project region: my-region instance: my-instance database: my_db user: my_user password: my_pass --- kind: authServices name: my-google-auth type: google clientId: testing-id --- kind: tools name: example_tool type: postgres-sql source: my-pg-instance description: some description statement: SELECT * FROM SQL_STATEMENT; parameters: - name: country type: string description: some description --- kind: tools name: example_tool_2 type: postgres-sql source: my-pg-instance description: returning the number one statement: SELECT 1; --- kind: toolsets name: example_toolset tools: - example_tool ``` --------- Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Averi Kitsch <akitsch@google.com>
137 lines
3.5 KiB
Markdown
137 lines
3.5 KiB
Markdown
---
|
|
title: "mindsdb-execute-sql"
|
|
type: docs
|
|
weight: 1
|
|
description: >
|
|
A "mindsdb-execute-sql" tool executes a SQL statement against a MindsDB
|
|
federated database.
|
|
aliases:
|
|
- /resources/tools/mindsdb-execute-sql
|
|
---
|
|
|
|
## About
|
|
|
|
A `mindsdb-execute-sql` tool executes a SQL statement against a MindsDB
|
|
federated database. It's compatible with any of the following sources:
|
|
|
|
- [mindsdb](../../sources/mindsdb.md)
|
|
|
|
`mindsdb-execute-sql` takes one input parameter `sql` and runs the SQL
|
|
statement against the `source`. This tool enables you to:
|
|
|
|
- **Query Multiple Datasources**: Execute SQL across hundreds of connected
|
|
datasources
|
|
- **Cross-Datasource Joins**: Perform joins between different databases, APIs,
|
|
and file systems
|
|
- **ML Model Predictions**: Query ML models as virtual tables for real-time
|
|
predictions
|
|
- **Unstructured Data**: Query documents, images, and other unstructured data as
|
|
structured tables
|
|
- **Federated Analytics**: Perform analytics across multiple datasources
|
|
simultaneously
|
|
- **API Translation**: Automatically translate SQL queries into REST APIs,
|
|
GraphQL, and native protocols
|
|
|
|
## Example Queries
|
|
|
|
### Cross-Datasource Analytics
|
|
|
|
```sql
|
|
-- Join Salesforce opportunities with GitHub activity
|
|
SELECT
|
|
s.opportunity_name,
|
|
s.amount,
|
|
g.repository_name,
|
|
COUNT(g.commits) as commit_count
|
|
FROM salesforce.opportunities s
|
|
JOIN github.repositories g ON s.account_id = g.owner_id
|
|
WHERE s.stage = 'Closed Won'
|
|
GROUP BY s.opportunity_name, s.amount, g.repository_name;
|
|
```
|
|
|
|
### Email & Communication Analysis
|
|
|
|
```sql
|
|
-- Analyze email patterns with Slack activity
|
|
SELECT
|
|
e.sender,
|
|
e.subject,
|
|
s.channel_name,
|
|
COUNT(s.messages) as message_count
|
|
FROM gmail.emails e
|
|
JOIN slack.messages s ON e.sender = s.user_name
|
|
WHERE e.date >= '2024-01-01'
|
|
GROUP BY e.sender, e.subject, s.channel_name;
|
|
```
|
|
|
|
### ML Model Predictions
|
|
|
|
```sql
|
|
-- Use ML model to predict customer churn
|
|
SELECT
|
|
customer_id,
|
|
customer_name,
|
|
predicted_churn_probability,
|
|
recommended_action
|
|
FROM customer_churn_model
|
|
WHERE predicted_churn_probability > 0.8;
|
|
```
|
|
|
|
### MongoDB Query
|
|
|
|
```sql
|
|
-- Query MongoDB collections as structured tables
|
|
SELECT
|
|
name,
|
|
email,
|
|
department,
|
|
created_at
|
|
FROM mongodb.users
|
|
WHERE department = 'Engineering'
|
|
ORDER BY created_at DESC;
|
|
```
|
|
|
|
> **Note:** This tool is intended for developer assistant workflows with
|
|
> human-in-the-loop and shouldn't be used for production agents.
|
|
|
|
## Example
|
|
|
|
```yaml
|
|
kind: tools
|
|
name: execute_sql_tool
|
|
type: mindsdb-execute-sql
|
|
source: my-mindsdb-instance
|
|
description: Use this tool to execute SQL statements across multiple datasources and ML models.
|
|
```
|
|
|
|
### Working Configuration Example
|
|
|
|
Here's a working configuration that has been tested:
|
|
|
|
```yaml
|
|
kind: sources
|
|
name: my-pg-source
|
|
type: mindsdb
|
|
host: 127.0.0.1
|
|
port: 47335
|
|
database: files
|
|
user: mindsdb
|
|
---
|
|
kind: tools
|
|
name: mindsdb-execute-sql
|
|
type: mindsdb-execute-sql
|
|
source: my-pg-source
|
|
description: |
|
|
Execute SQL queries directly on MindsDB database.
|
|
Use this tool to run any SQL statement against your MindsDB instance.
|
|
Example: SELECT * FROM my_table LIMIT 10
|
|
```
|
|
|
|
## Reference
|
|
|
|
| **field** | **type** | **required** | **description** |
|
|
|-------------|:--------:|:------------:|----------------------------------------------------|
|
|
| type | string | true | Must be "mindsdb-execute-sql". |
|
|
| source | string | true | Name of the source the SQL should execute on. |
|
|
| description | string | true | Description of the tool that is passed to the LLM. |
|