Files
simstudioai--sim/apps/sim/tools/athena/start_query.ts
T
wehub-resource-sync d25d482dc2
CI / Migrate Dev DB (push) Has been skipped
CI / Detect Version (push) Has been cancelled
CI / Migrate DB (push) Has been cancelled
CI / Build Dev ECR (./docker/app.Dockerfile, ECR_APP) (push) Has been cancelled
CI / Build Dev ECR (./docker/db.Dockerfile, ECR_MIGRATIONS) (push) Has been cancelled
CI / Build Dev ECR (./docker/pii.Dockerfile, ECR_PII) (push) Has been cancelled
CI / Build Dev ECR (./docker/realtime.Dockerfile, ECR_REALTIME) (push) Has been cancelled
CI / Deploy Trigger.dev (Dev) (push) Has been cancelled
CI / Build AMD64 (./docker/app.Dockerfile, ECR_APP, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build AMD64 (./docker/db.Dockerfile, ECR_MIGRATIONS, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build AMD64 (./docker/pii.Dockerfile, ECR_PII, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build AMD64 (./docker/realtime.Dockerfile, ECR_REALTIME, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/app.Dockerfile, ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/db.Dockerfile, ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/pii.Dockerfile, ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Build ARM64 (GHCR Only) (./docker/realtime.Dockerfile, ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/migrations) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/pii) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/realtime) (push) Has been cancelled
CI / Create GHCR Manifests (ghcr.io/simstudioai/simstudio) (push) Has been cancelled
CI / Check Docs Changes (push) Has been cancelled
CI / Process Docs (push) Has been cancelled
CI / Create GitHub Release (push) Has been cancelled
CI / Test and Build (push) Has been cancelled
Publish CLI Package / publish-npm (push) Has been cancelled
Publish Python SDK / publish-pypi (push) Has been cancelled
Publish TypeScript SDK / publish-npm (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 13:20:55 +08:00

97 lines
2.7 KiB
TypeScript

import type { AthenaStartQueryParams, AthenaStartQueryResponse } from '@/tools/athena/types'
import type { ToolConfig } from '@/tools/types'
export const startQueryTool: ToolConfig<AthenaStartQueryParams, AthenaStartQueryResponse> = {
id: 'athena_start_query',
name: 'Athena Start Query',
description: 'Start an SQL query execution in AWS Athena',
version: '1.0.0',
params: {
awsRegion: {
type: 'string',
required: true,
visibility: 'user-only',
description: 'AWS region (e.g., us-east-1)',
},
awsAccessKeyId: {
type: 'string',
required: true,
visibility: 'user-only',
description: 'AWS access key ID',
},
awsSecretAccessKey: {
type: 'string',
required: true,
visibility: 'user-only',
description: 'AWS secret access key',
},
queryString: {
type: 'string',
required: true,
visibility: 'user-or-llm',
description: 'SQL query string to execute',
},
database: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Database name within the catalog',
},
catalog: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Data catalog name (default: AwsDataCatalog)',
},
outputLocation: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'S3 output location for query results (e.g., s3://bucket/path/)',
},
workGroup: {
type: 'string',
required: false,
visibility: 'user-or-llm',
description: 'Workgroup to execute the query in (default: primary)',
},
},
request: {
url: '/api/tools/athena/start-query',
method: 'POST',
headers: () => ({ 'Content-Type': 'application/json' }),
body: (params) => ({
region: params.awsRegion,
accessKeyId: params.awsAccessKeyId,
secretAccessKey: params.awsSecretAccessKey,
queryString: params.queryString,
...(params.database && { database: params.database }),
...(params.catalog && { catalog: params.catalog }),
...(params.outputLocation && { outputLocation: params.outputLocation }),
...(params.workGroup && { workGroup: params.workGroup }),
}),
},
transformResponse: async (response: Response) => {
const data = await response.json()
if (!response.ok) {
throw new Error(data.error || 'Failed to start Athena query')
}
return {
success: true,
output: {
queryExecutionId: data.output.queryExecutionId,
},
}
},
outputs: {
queryExecutionId: {
type: 'string',
description: 'Unique ID of the started query execution',
},
},
}