mirror of
https://github.com/googleapis/genai-toolbox.git
synced 2026-01-08 23:18:04 -05:00
Add support for Trino distributed SQL query engine with complete implementation including sources, tools, documentation, and tests. ## Summary - Add Trino source implementation with multiple authentication methods - Create trino-execute-sql tool for arbitrary SQL execution - Create trino-sql tool for parameterized queries - Add comprehensive documentation ~~and prebuilt configurations~~ - Include unit tests for all components ## Features ### Authentication Support - Basic authentication (username/password) - JWT token authentication - Kerberos authentication - SSL/TLS connections ### Tools - **trino-execute-sql**: Execute arbitrary SQL queries - **trino-sql**: Execute parameterized SQL with prepared statements - Prebuilt tools for common operations (list catalogs, schemas, tables, etc.) ### Cross-Catalog Queries - Support for federated queries across multiple data sources - Query Hive, PostgreSQL, MySQL, and other connectors in single queries - Leverage Trino's distributed query engine capabilities ## Test Plan - [x] Unit tests pass for source DSN generation - [x] Unit tests pass for tool parameter validation - [x] Project builds successfully with new dependencies - [x] Documentation includes comprehensive examples Ref #880 --------- Co-authored-by: Yuan Teoh <yuanteoh@google.com> Co-authored-by: Yuan Teoh <45984206+Yuan325@users.noreply.github.com>
203 lines
5.9 KiB
Go
203 lines
5.9 KiB
Go
// Copyright 2025 Google LLC
|
|
//
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package trinosql
|
|
|
|
import (
|
|
"context"
|
|
"database/sql"
|
|
"fmt"
|
|
|
|
yaml "github.com/goccy/go-yaml"
|
|
"github.com/googleapis/genai-toolbox/internal/sources"
|
|
"github.com/googleapis/genai-toolbox/internal/sources/trino"
|
|
"github.com/googleapis/genai-toolbox/internal/tools"
|
|
)
|
|
|
|
const kind string = "trino-sql"
|
|
|
|
func init() {
|
|
if !tools.Register(kind, newConfig) {
|
|
panic(fmt.Sprintf("tool kind %q already registered", kind))
|
|
}
|
|
}
|
|
|
|
func newConfig(ctx context.Context, name string, decoder *yaml.Decoder) (tools.ToolConfig, error) {
|
|
actual := Config{Name: name}
|
|
if err := decoder.DecodeContext(ctx, &actual); err != nil {
|
|
return nil, err
|
|
}
|
|
return actual, nil
|
|
}
|
|
|
|
type compatibleSource interface {
|
|
TrinoDB() *sql.DB
|
|
}
|
|
|
|
// validate compatible sources are still compatible
|
|
var _ compatibleSource = &trino.Source{}
|
|
|
|
var compatibleSources = [...]string{trino.SourceKind}
|
|
|
|
type Config struct {
|
|
Name string `yaml:"name" validate:"required"`
|
|
Kind string `yaml:"kind" validate:"required"`
|
|
Source string `yaml:"source" validate:"required"`
|
|
Description string `yaml:"description" validate:"required"`
|
|
Statement string `yaml:"statement" validate:"required"`
|
|
AuthRequired []string `yaml:"authRequired"`
|
|
Parameters tools.Parameters `yaml:"parameters"`
|
|
TemplateParameters tools.Parameters `yaml:"templateParameters"`
|
|
}
|
|
|
|
// validate interface
|
|
var _ tools.ToolConfig = Config{}
|
|
|
|
func (cfg Config) ToolConfigKind() string {
|
|
return kind
|
|
}
|
|
|
|
func (cfg Config) Initialize(srcs map[string]sources.Source) (tools.Tool, error) {
|
|
// verify source exists
|
|
rawS, ok := srcs[cfg.Source]
|
|
if !ok {
|
|
return nil, fmt.Errorf("no source named %q configured", cfg.Source)
|
|
}
|
|
|
|
// verify the source is compatible
|
|
s, ok := rawS.(compatibleSource)
|
|
if !ok {
|
|
return nil, fmt.Errorf("invalid source for %q tool: source kind must be one of %q", kind, compatibleSources)
|
|
}
|
|
|
|
allParameters, paramManifest, paramMcpManifest, err := tools.ProcessParameters(cfg.TemplateParameters, cfg.Parameters)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("unable to process parameters: %w", err)
|
|
}
|
|
|
|
mcpManifest := tools.McpManifest{
|
|
Name: cfg.Name,
|
|
Description: cfg.Description,
|
|
InputSchema: paramMcpManifest,
|
|
}
|
|
|
|
// finish tool setup
|
|
t := Tool{
|
|
Name: cfg.Name,
|
|
Kind: kind,
|
|
Parameters: cfg.Parameters,
|
|
TemplateParameters: cfg.TemplateParameters,
|
|
AllParams: allParameters,
|
|
Statement: cfg.Statement,
|
|
AuthRequired: cfg.AuthRequired,
|
|
Db: s.TrinoDB(),
|
|
manifest: tools.Manifest{Description: cfg.Description, Parameters: paramManifest, AuthRequired: cfg.AuthRequired},
|
|
mcpManifest: mcpManifest,
|
|
}
|
|
return t, nil
|
|
}
|
|
|
|
// validate interface
|
|
var _ tools.Tool = Tool{}
|
|
|
|
type Tool struct {
|
|
Name string `yaml:"name"`
|
|
Kind string `yaml:"kind"`
|
|
AuthRequired []string `yaml:"authRequired"`
|
|
Parameters tools.Parameters `yaml:"parameters"`
|
|
TemplateParameters tools.Parameters `yaml:"templateParameters"`
|
|
AllParams tools.Parameters `yaml:"allParams"`
|
|
|
|
Statement string
|
|
Db *sql.DB
|
|
manifest tools.Manifest
|
|
mcpManifest tools.McpManifest
|
|
}
|
|
|
|
func (t Tool) Invoke(ctx context.Context, params tools.ParamValues, accessToken tools.AccessToken) (any, error) {
|
|
paramsMap := params.AsMap()
|
|
newStatement, err := tools.ResolveTemplateParams(t.TemplateParameters, t.Statement, paramsMap)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("unable to extract template params %w", err)
|
|
}
|
|
newParams, err := tools.GetParams(t.Parameters, paramsMap)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("unable to extract standard params %w", err)
|
|
}
|
|
sliceParams := newParams.AsSlice()
|
|
results, err := t.Db.QueryContext(ctx, newStatement, sliceParams...)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("unable to execute query: %w", err)
|
|
}
|
|
defer results.Close()
|
|
|
|
cols, err := results.Columns()
|
|
if err != nil {
|
|
return nil, fmt.Errorf("unable to retrieve column names: %w", err)
|
|
}
|
|
|
|
// create an array of values for each column, which can be re-used to scan each row
|
|
rawValues := make([]any, len(cols))
|
|
values := make([]any, len(cols))
|
|
for i := range rawValues {
|
|
values[i] = &rawValues[i]
|
|
}
|
|
|
|
var out []any
|
|
for results.Next() {
|
|
err := results.Scan(values...)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("unable to parse row: %w", err)
|
|
}
|
|
vMap := make(map[string]any)
|
|
for i, name := range cols {
|
|
val := rawValues[i]
|
|
if val == nil {
|
|
vMap[name] = nil
|
|
continue
|
|
}
|
|
|
|
// Convert byte arrays to strings for text fields
|
|
if b, ok := val.([]byte); ok {
|
|
vMap[name] = string(b)
|
|
} else {
|
|
vMap[name] = val
|
|
}
|
|
}
|
|
out = append(out, vMap)
|
|
}
|
|
|
|
if err := results.Err(); err != nil {
|
|
return nil, fmt.Errorf("errors encountered during row iteration: %w", err)
|
|
}
|
|
|
|
return out, nil
|
|
}
|
|
|
|
func (t Tool) ParseParams(data map[string]any, claims map[string]map[string]any) (tools.ParamValues, error) {
|
|
return tools.ParseParams(t.AllParams, data, claims)
|
|
}
|
|
|
|
func (t Tool) Manifest() tools.Manifest {
|
|
return t.manifest
|
|
}
|
|
|
|
func (t Tool) McpManifest() tools.McpManifest {
|
|
return t.mcpManifest
|
|
}
|
|
|
|
func (t Tool) Authorized(verifiedAuthServices []string) bool {
|
|
return tools.IsAuthorized(t.AuthRequired, verifiedAuthServices)
|
|
}
|