Documentation

Teradata SQL Agent

The Teradata SQL Agent is a specialized component designed to interact with Teradata databases, execute SQL queries, and manage data operations efficiently.

Teradata SQL Agent Component

Teradata SQL Agent interface and configuration options

Configuration Parameters

Required Parameters

  • Language Model: The language model to use
  • Host: Teradata server host address
  • Username: Database user credentials
  • Password: Database user password
  • Database: Target database name
  • Question: SQL query or natural language question

Output Format

{
  "queryId": string,
  "status": "success" | "error",
  "results": {
    "data": array,
    "rowCount": number,
    "executionTime": string,
    "metadata": {
      "columns": array,
      "types": array
    }
  },
  "queryResponse": {
    "sql": string,
    "explanation": string
  }
}

Example Usage

const teradataSqlAgent = new TeradataSQLAgent({
  languageModel: "gpt-4",
  host: "teradata.example.com",
  username: "db_user",
  password: "secure_password",
  database: "sales_db",
});

const result = await teradataSqlAgent.execute({
  question: "What were the total sales by region in Q1 2024?",
  options: {
    maxRows: 1000,
    timeout: 30000
  }
});

Best Practices

  • Use parameterized queries for security
  • Implement query timeout handling
  • Monitor query performance
  • Handle large result sets appropriately
  • Implement proper error handling