mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-02-11 15:45:06 -05:00
293c1d6889
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>
81 lines
2.4 KiB
Markdown
81 lines
2.4 KiB
Markdown
---
|
|
title: "SQLite"
|
|
linkTitle: "SQLite"
|
|
type: docs
|
|
weight: 1
|
|
description: >
|
|
SQLite is a C-language library that implements a small, fast, self-contained,
|
|
high-reliability, full-featured, SQL database engine.
|
|
---
|
|
|
|
## About
|
|
|
|
[SQLite](https://sqlite.org/) is a software library that provides a relational
|
|
database management system. The lite in SQLite means lightweight in terms of
|
|
setup, database administration, and required resources.
|
|
|
|
SQLite has the following notable characteristics:
|
|
|
|
- Self-contained with no external dependencies
|
|
- Serverless - the SQLite library accesses its storage files directly
|
|
- Single database file that can be easily copied or moved
|
|
- Zero-configuration - no setup or administration needed
|
|
- Transactional with ACID properties
|
|
|
|
## Available Tools
|
|
|
|
- [`sqlite-sql`](../tools/sqlite/sqlite-sql.md)
|
|
Run SQL queries against a local SQLite database.
|
|
|
|
- [`sqlite-execute-sql`](../tools/sqlite/sqlite-execute-sql.md)
|
|
Run parameterized SQL statements in SQlite.
|
|
|
|
### Pre-built Configurations
|
|
|
|
- [SQLite using MCP](../../how-to/connect-ide/sqlite_mcp.md)
|
|
Connect your IDE to SQlite using Toolbox.
|
|
|
|
## Requirements
|
|
|
|
### Database File
|
|
|
|
You need a SQLite database file. This can be:
|
|
|
|
- An existing database file
|
|
- A path where a new database file should be created
|
|
- `:memory:` for an in-memory database
|
|
|
|
## Example
|
|
|
|
```yaml
|
|
kind: sources
|
|
name: my-sqlite-db
|
|
type: "sqlite"
|
|
database: "/path/to/database.db"
|
|
```
|
|
|
|
For an in-memory database:
|
|
|
|
```yaml
|
|
kind: sources
|
|
name: my-sqlite-memory-db
|
|
type: "sqlite"
|
|
database: ":memory:"
|
|
```
|
|
|
|
## Reference
|
|
|
|
### Configuration Fields
|
|
|
|
| **field** | **type** | **required** | **description** |
|
|
|-----------|:--------:|:------------:|---------------------------------------------------------------------------------------------------------------------|
|
|
| type | string | true | Must be "sqlite". |
|
|
| database | string | true | Path to SQLite database file, or ":memory:" for an in-memory database. |
|
|
|
|
### Connection Properties
|
|
|
|
SQLite connections are configured with these defaults for optimal performance:
|
|
|
|
- `MaxOpenConns`: 1 (SQLite only supports one writer at a time)
|
|
- `MaxIdleConns`: 1
|