logo

Documentation

SQL Migration Agent

The SQL Migration Agent is a specialized component designed to facilitate database migrations between different database systems while maintaining data integrity and structure.

SQL Migration Agent Component

SQL Migration Agent interface and configuration options

Configuration Parameters

Required Parameters

  • Source Database URI: Connection string for the source database
  • Destination Database URI: Connection string for the target database
  • OpenAI API Key: API key for language model assistance
  • Destination Database Type: Target database system type

Output Format

{
  "migrationId": string,
  "status": "success" | "failed",
  "results": {
    "tablesProcessed": number,
    "rowsMigrated": number,
    "errors": array,
    "metadata": {
      "startTime": string,
      "endTime": string,
      "duration": string
    }
  }
}

Example Usage

const sqlMigrationAgent = new SQLMigrationAgent({
  sourceDbUri: "postgresql://user:pass@source-host:5432/db",
  destDbUri: "mysql://user:pass@dest-host:3306/db",
  openAiKey: "your-api-key",
  destDbType: "mysql",
});

const migrationResult = await sqlMigrationAgent.migrate({
  tables: ["users", "products", "orders"],
  options: {
    batchSize: 1000,
    validateData: true
  }
});

Best Practices

  • Always backup source and destination databases
  • Test migration with sample data first
  • Use appropriate batch sizes for large datasets
  • Implement proper error handling
  • Validate data integrity after migration