spec.json

{
  "documentationUrl": "https://docs.airbyte.io/integrations/sources/mysql",
  "connectionSpecification": {
    "$schema": "http://json-schema.org/draft-07/schema#",
    "title": "MySql Source Spec",
    "type": "object",
    "required": ["host", "port", "database", "username", "replication_method"],
    "additionalProperties": false,
    "properties": {
      "host": {
        "description": "The host name of the database.",
        "title": "Host",
        "type": "string",
        "order": 0
      },
      "port": {
        "description": "The port to connect to.",
        "title": "Port",
        "type": "integer",
        "minimum": 0,
        "maximum": 65536,
        "default": 3306,
        "examples": ["3306"],
        "order": 1
      },
      "database": {
        "description": "The database name.",
        "title": "Database",
        "type": "string",
        "order": 2
      },
      "username": {
        "description": "The username which is used to access the database.",
        "title": "Username",
        "type": "string",
        "order": 3
      },
      "password": {
        "description": "The password associated with the username.",
        "title": "Password",
        "type": "string",
        "airbyte_secret": true,
        "order": 4
      },
      "jdbc_url_params": {
        "description": "Additional properties to pass to the JDBC URL string when connecting to the database formatted as 'key=value' pairs separated by the symbol '&'. (example: key1=value1&key2=value2&key3=value3).",
        "title": "JDBC URL Params",
        "type": "string",
        "order": 5
      },
      "ssl": {
        "title": "SSL Connection",
        "description": "Encrypt data using SSL.",
        "type": "boolean",
        "default": true,
        "order": 6
      },
      "replication_method": {
        "type": "string",
        "title": "Replication Method",
        "description": "Replication method which is used for data extraction from the database. STANDARD replication requires no setup on the DB side but will not be able to represent deletions incrementally. CDC uses the Binlog to detect inserts, updates, and deletes. This needs to be configured on the source database itself.",
        "order": 7,
        "default": "STANDARD",
        "enum": ["STANDARD", "CDC"]
      }
    }
  }
}