{
  "ab_internal": {
    "isEnterprise": false,
    "ql": 400,
    "requireVersionIncrementsInPullRequests": true,
    "sl": 300
  },
  "allowedHosts": {
    "hosts": [
      "${host}",
      "${tunnel_method.tunnel_host}"
    ]
  },
  "connectorBuildOptions": {
    "baseImage": "docker.io/airbyte/java-connector-base:2.0.4@sha256:5f343797cfcf021ca98ba9bdf5970ef66cbf6222d8cc17b0d61d13860a5bcc2b"
  },
  "connectorIPCOptions": {
    "dataChannel": {
      "supportedSerialization": [
        "JSONL",
        "PROTOBUF"
      ],
      "supportedTransport": [
        "SOCKET",
        "STDIO"
      ],
      "version": "0.0.2"
    }
  },
  "connectorTestSuitesOptions": [
    {
      "suite": "acceptanceTests",
      "testSecrets": [
        {
          "fileName": "ssh-key-repl-config.json",
          "name": "SECRET_SOURCE-MYSQL_SSH-KEY-REPL__CREDS",
          "secretStore": {
            "alias": "airbyte-connector-testing-secret-store",
            "type": "GSM"
          }
        },
        {
          "fileName": "ssh-key-config.json",
          "name": "SECRET_SOURCE-MYSQL_SSH-KEY__CREDS",
          "secretStore": {
            "alias": "airbyte-connector-testing-secret-store",
            "type": "GSM"
          }
        },
        {
          "fileName": "ssh-pwd-repl-config.json",
          "name": "SECRET_SOURCE-MYSQL_SSH-PWD-REPL__CREDS",
          "secretStore": {
            "alias": "airbyte-connector-testing-secret-store",
            "type": "GSM"
          }
        },
        {
          "fileName": "ssh-pwd-config.json",
          "name": "SECRET_SOURCE-MYSQL_SSH-PWD__CREDS",
          "secretStore": {
            "alias": "airbyte-connector-testing-secret-store",
            "type": "GSM"
          }
        },
        {
          "fileName": "performance-config.json",
          "name": "SECRET_SOURCE_MYSQL_PERFORMANCE_TEST_CREDS",
          "secretStore": {
            "alias": "airbyte-connector-testing-secret-store",
            "type": "GSM"
          }
        },
        {
          "fileName": "cat-config.json",
          "name": "SECRET_SOURCE_MYSQL_ACCEPTANCE_TEST_CREDS",
          "secretStore": {
            "alias": "airbyte-connector-testing-secret-store",
            "type": "GSM"
          }
        },
        {
          "fileName": "cat-config-cdc.json",
          "name": "SECRET_SOURCE_MYSQL_ACCEPTANCE_TEST_CDC_CREDS",
          "secretStore": {
            "alias": "airbyte-connector-testing-secret-store",
            "type": "GSM"
          }
        }
      ]
    }
  ],
  "custom": false,
  "dockerImageTag": "3.53.2-preview.59c53ff",
  "dockerRepository": "airbyte/source-mysql",
  "documentationUrl": "https://docs.airbyte.com/integrations/sources/mysql",
  "externalDocumentationUrls": [
    {
      "title": "MySQL documentation",
      "type": "api_reference",
      "url": "https://dev.mysql.com/doc/"
    },
    {
      "title": "MySQL Release Notes",
      "type": "api_release_history",
      "url": "https://dev.mysql.com/doc/relnotes/mysql/en/"
    },
    {
      "title": "MySQL authentication",
      "type": "authentication_guide",
      "url": "https://dev.mysql.com/doc/refman/8.0/en/access-control.html"
    }
  ],
  "generated": {
    "git": {
      "commit_author": "Yarden Carmeli",
      "commit_author_email": "yardencarmeli@gmail.com",
      "commit_sha": "88af584cc7eab4ba075cfcca1b6e7e69dcf2507a",
      "commit_timestamp": "2026-07-29T16:26:12+03:00"
    },
    "sbomUrl": "https://connectors.airbyte.com/files/sbom/airbyte/source-mysql/3.53.2-preview.59c53ff.spdx.json",
    "source_file_info": {
      "metadata_bucket_name": "prod-airbyte-cloud-connector-metadata-service",
      "metadata_file_path": "metadata/airbyte/source-mysql/3.53.2-preview.59c53ff/metadata.yaml",
      "metadata_last_modified": "2026-07-29T13:50:01.580711+00:00",
      "registry_entry_generated_at": "2026-07-29T13:50:01.580711+00:00"
    }
  },
  "githubIssueLabel": "source-mysql",
  "icon": "mysql.svg",
  "iconUrl": "https://connectors.airbyte.com/files/metadata/airbyte/source-mysql/latest/icon.svg",
  "language": "java",
  "license": "ELv2",
  "maxSecondsBetweenMessages": 7200,
  "name": "MySQL",
  "packageInfo": {},
  "public": true,
  "releaseStage": "alpha",
  "releases": {
    "breakingChanges": {
      "3.0.0": {
        "message": "Add default cursor for cdc",
        "migrationDocumentationUrl": "https://docs.airbyte.com/integrations/sources/mysql-migrations#3.0.0",
        "upgradeDeadline": "2023-08-17"
      }
    },
    "migrationDocumentationUrl": "https://docs.airbyte.com/integrations/sources/mysql-migrations",
    "rolloutConfiguration": {
      "advanceDelayMinutes": 10,
      "enableProgressiveRollout": false,
      "initialPercentage": 0,
      "maxPercentage": 50
    }
  },
  "sourceDefinitionId": "435bb9a5-7887-4809-aa58-28c27df0d7ad",
  "sourceType": "database",
  "spec": {
    "connectionSpecification": {
      "$schema": "http://json-schema.org/draft-07/schema#",
      "additionalProperties": true,
      "properties": {
        "check_privileges": {
          "default": true,
          "description": "When this feature is enabled, during schema discovery the connector will query each table or view individually to check access privileges and inaccessible tables, views, or columns therein will be removed. In large schemas, this might cause schema discovery to take too long, in which case it might be advisable to disable this feature.",
          "order": 13,
          "title": "Check Table and Column Access Privileges",
          "type": "boolean"
        },
        "checkpoint_target_interval_seconds": {
          "default": 300,
          "description": "How often (in seconds) a stream should checkpoint, when possible.",
          "order": 12,
          "title": "Checkpoint Target Time Interval",
          "type": "integer"
        },
        "concurrency": {
          "airbyte_hidden": true,
          "default": 1,
          "description": "Maximum number of concurrent queries to the database.",
          "order": 13,
          "title": "Concurrency",
          "type": "integer"
        },
        "database": {
          "always_show": true,
          "description": "The database name.",
          "order": 6,
          "title": "Database",
          "type": "string"
        },
        "host": {
          "description": "Hostname of the database.",
          "order": 1,
          "title": "Host",
          "type": "string"
        },
        "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).",
          "order": 8,
          "title": "JDBC URL Params",
          "type": "string"
        },
        "max_db_connections": {
          "description": "Maximum number of concurrent queries to the database. Leave empty to let Airbyte optimize performance.",
          "order": 13,
          "title": "Max Concurrent Queries to Database",
          "type": "integer"
        },
        "password": {
          "airbyte_secret": true,
          "always_show": true,
          "description": "The password associated with the username.",
          "order": 5,
          "title": "Password",
          "type": "string"
        },
        "port": {
          "default": 3306,
          "description": "Port of the database.",
          "maximum": 65536,
          "minimum": 0,
          "order": 2,
          "title": "Port",
          "type": "integer"
        },
        "replication_method": {
          "description": "Configures how data is extracted from the database.",
          "display_type": "radio",
          "oneOf": [
            {
              "additionalProperties": true,
              "description": "Incrementally detects new inserts and updates using the <a href=\"https://docs.airbyte.com/understanding-airbyte/connections/incremental-append/#user-defined-cursor\">cursor column</a> chosen when configuring a connection (e.g. created_at, updated_at).",
              "properties": {
                "method": {
                  "default": "STANDARD",
                  "enum": [
                    "STANDARD"
                  ],
                  "type": "string"
                }
              },
              "required": [
                "method"
              ],
              "title": "Scan Changes with User Defined Cursor",
              "type": "object"
            },
            {
              "additionalProperties": true,
              "description": "<i>Recommended</i> - Incrementally reads new inserts, updates, and deletes using MySQL's <a href=\"https://docs.airbyte.com/integrations/sources/mysql#change-data-capture-cdc\"> change data capture feature</a>. This must be enabled on your database.",
              "properties": {
                "initial_load_timeout_hours": {
                  "always_show": true,
                  "default": 8,
                  "description": "The amount of time an initial load is allowed to continue for before catching up on CDC logs.",
                  "max": 24,
                  "min": 4,
                  "order": 3,
                  "title": "Initial Load Timeout in Hours (Advanced)",
                  "type": "integer"
                },
                "invalid_cdc_cursor_position_behavior": {
                  "always_show": true,
                  "default": "Fail sync",
                  "description": "Determines whether Airbyte should fail or re-sync data in case of an stale/invalid cursor value in the mined logs. If 'Fail sync' is chosen, a user will have to manually reset the connection before being able to continue syncing data. If 'Re-sync data' is chosen, Airbyte will automatically trigger a refresh but could lead to higher cloud costs and data loss.",
                  "enum": [
                    "Fail sync",
                    "Re-sync data"
                  ],
                  "order": 2,
                  "title": "Invalid CDC Position Behavior (Advanced)",
                  "type": "string"
                },
                "method": {
                  "default": "CDC",
                  "enum": [
                    "CDC"
                  ],
                  "type": "string"
                },
                "server_timezone": {
                  "always_show": true,
                  "description": "Enter the configured MySQL server timezone. This should only be done if the configured timezone in your MySQL instance does not conform to IANNA standard.",
                  "order": 1,
                  "title": "Configured server timezone for the MySQL source (Advanced)",
                  "type": "string"
                }
              },
              "required": [
                "method"
              ],
              "title": "Read Changes using Change Data Capture (CDC)",
              "type": "object"
            }
          ],
          "order": 11,
          "title": "Update Method",
          "type": "object"
        },
        "ssl_mode": {
          "default": "required",
          "description": "The encryption method which is used when communicating with the database.",
          "oneOf": [
            {
              "additionalProperties": true,
              "description": "To allow unencrypted communication only when the source doesn't support encryption.",
              "properties": {
                "mode": {
                  "default": "preferred",
                  "enum": [
                    "preferred"
                  ],
                  "type": "string"
                }
              },
              "required": [
                "mode"
              ],
              "title": "preferred",
              "type": "object"
            },
            {
              "additionalProperties": true,
              "description": "To always require encryption. Note: The connection will fail if the source doesn't support encryption.",
              "properties": {
                "mode": {
                  "default": "required",
                  "enum": [
                    "required"
                  ],
                  "type": "string"
                }
              },
              "required": [
                "mode"
              ],
              "title": "required",
              "type": "object"
            },
            {
              "additionalProperties": true,
              "description": "To always require encryption and verify that the source has a valid SSL certificate.",
              "properties": {
                "ca_certificate": {
                  "airbyte_secret": true,
                  "description": "CA certificate",
                  "multiline": true,
                  "title": "CA certificate",
                  "type": "string"
                },
                "client_certificate": {
                  "airbyte_secret": true,
                  "description": "Client certificate (this is not a required field, but if you want to use it, you will need to add the Client key as well)",
                  "multiline": true,
                  "title": "Client certificate File",
                  "type": "string"
                },
                "client_key": {
                  "airbyte_secret": true,
                  "description": "Client key (this is not a required field, but if you want to use it, you will need to add the Client certificate as well)",
                  "multiline": true,
                  "title": "Client Key",
                  "type": "string"
                },
                "client_key_password": {
                  "airbyte_secret": true,
                  "description": "Password for keystorage. This field is optional. If you do not add it - the password will be generated automatically.",
                  "multiline": true,
                  "title": "Client key password",
                  "type": "string"
                },
                "mode": {
                  "default": "verify_ca",
                  "enum": [
                    "verify_ca"
                  ],
                  "type": "string"
                }
              },
              "required": [
                "mode",
                "ca_certificate"
              ],
              "title": "verify_ca",
              "type": "object"
            },
            {
              "additionalProperties": true,
              "description": "To always require encryption and verify that the source has a valid SSL certificate.",
              "properties": {
                "ca_certificate": {
                  "airbyte_secret": true,
                  "description": "CA certificate",
                  "multiline": true,
                  "title": "CA certificate",
                  "type": "string"
                },
                "client_certificate": {
                  "airbyte_secret": true,
                  "description": "Client certificate (this is not a required field, but if you want to use it, you will need to add the Client key as well)",
                  "multiline": true,
                  "title": "Client certificate File",
                  "type": "string"
                },
                "client_key": {
                  "airbyte_secret": true,
                  "description": "Client key (this is not a required field, but if you want to use it, you will need to add the Client certificate as well)",
                  "multiline": true,
                  "title": "Client Key",
                  "type": "string"
                },
                "client_key_password": {
                  "airbyte_secret": true,
                  "description": "Password for keystorage. This field is optional. If you do not add it - the password will be generated automatically.",
                  "multiline": true,
                  "title": "Client key password",
                  "type": "string"
                },
                "mode": {
                  "default": "verify_identity",
                  "enum": [
                    "verify_identity"
                  ],
                  "type": "string"
                }
              },
              "required": [
                "mode",
                "ca_certificate"
              ],
              "title": "verify_identity",
              "type": "object"
            }
          ],
          "order": 9,
          "title": "Encryption",
          "type": "object"
        },
        "table_filters": {
          "description": "Optional filters to include only specific tables from the specified database.",
          "items": {
            "additionalProperties": true,
            "description": "Inclusion filter configuration for table selection per database.",
            "properties": {
              "database_name": {
                "always_show": true,
                "description": "The name of the database to apply this filter to. Should match the database defined in the \"Database\" field above.",
                "order": 1,
                "title": "Database Name",
                "type": "string"
              },
              "table_name_patterns": {
                "always_show": true,
                "description": "List of table name patterns to include. Should be a SQL LIKE pattern.",
                "items": {
                  "type": "string"
                },
                "minItems": 1,
                "order": 2,
                "title": "Table Filter Patterns",
                "type": "array"
              }
            },
            "required": [
              "database_name",
              "table_name_patterns"
            ],
            "title": "Table Filter",
            "type": "object"
          },
          "order": 7,
          "title": "Table Filters",
          "type": "array"
        },
        "treat_tinyint1_as_integer": {
          "default": false,
          "description": "When enabled, TINYINT(1) columns are emitted as integers instead of booleans.",
          "order": 14,
          "title": "Treat TINYINT(1) Columns as Integers",
          "type": "boolean"
        },
        "tunnel_method": {
          "description": "Whether to initiate an SSH tunnel before connecting to the database, and if so, which kind of authentication to use.",
          "oneOf": [
            {
              "additionalProperties": true,
              "description": "No ssh tunnel needed to connect to database",
              "properties": {
                "tunnel_method": {
                  "default": "NO_TUNNEL",
                  "enum": [
                    "NO_TUNNEL"
                  ],
                  "type": "string"
                }
              },
              "required": [
                "tunnel_method"
              ],
              "title": "No Tunnel",
              "type": "object"
            },
            {
              "additionalProperties": true,
              "description": "Connect through a jump server tunnel host using username and ssh key",
              "properties": {
                "ssh_key": {
                  "airbyte_secret": true,
                  "description": "OS-level user account ssh key credentials in RSA PEM format ( created with ssh-keygen -t rsa -m PEM -f myuser_rsa )",
                  "multiline": true,
                  "order": 4,
                  "title": "SSH Private Key",
                  "type": "string"
                },
                "tunnel_host": {
                  "description": "Hostname of the jump server host that allows inbound ssh tunnel.",
                  "order": 1,
                  "title": "SSH Tunnel Jump Server Host",
                  "type": "string"
                },
                "tunnel_method": {
                  "default": "SSH_KEY_AUTH",
                  "enum": [
                    "SSH_KEY_AUTH"
                  ],
                  "type": "string"
                },
                "tunnel_port": {
                  "default": 22,
                  "description": "Port on the proxy/jump server that accepts inbound ssh connections.",
                  "maximum": 65536,
                  "minimum": 0,
                  "order": 2,
                  "title": "SSH Connection Port",
                  "type": "integer"
                },
                "tunnel_user": {
                  "description": "OS-level username for logging into the jump server host",
                  "order": 3,
                  "title": "SSH Login Username",
                  "type": "string"
                }
              },
              "required": [
                "tunnel_method",
                "tunnel_host",
                "tunnel_port",
                "tunnel_user",
                "ssh_key"
              ],
              "title": "SSH Key Authentication",
              "type": "object"
            },
            {
              "additionalProperties": true,
              "description": "Connect through a jump server tunnel host using username and password authentication",
              "properties": {
                "tunnel_host": {
                  "description": "Hostname of the jump server host that allows inbound ssh tunnel.",
                  "order": 1,
                  "title": "SSH Tunnel Jump Server Host",
                  "type": "string"
                },
                "tunnel_method": {
                  "default": "SSH_PASSWORD_AUTH",
                  "enum": [
                    "SSH_PASSWORD_AUTH"
                  ],
                  "type": "string"
                },
                "tunnel_port": {
                  "default": 22,
                  "description": "Port on the proxy/jump server that accepts inbound ssh connections.",
                  "maximum": 65536,
                  "minimum": 0,
                  "order": 2,
                  "title": "SSH Connection Port",
                  "type": "integer"
                },
                "tunnel_user": {
                  "description": "OS-level username for logging into the jump server host",
                  "order": 3,
                  "title": "SSH Login Username",
                  "type": "string"
                },
                "tunnel_user_password": {
                  "airbyte_secret": true,
                  "description": "OS-level password for logging into the jump server host",
                  "order": 4,
                  "title": "Password",
                  "type": "string"
                }
              },
              "required": [
                "tunnel_method",
                "tunnel_host",
                "tunnel_port",
                "tunnel_user",
                "tunnel_user_password"
              ],
              "title": "Password Authentication",
              "type": "object"
            }
          ],
          "order": 10,
          "title": "SSH Tunnel Method",
          "type": "object"
        },
        "username": {
          "description": "The username which is used to access the database.",
          "order": 4,
          "title": "User",
          "type": "string"
        }
      },
      "required": [
        "host",
        "port",
        "database",
        "username",
        "replication_method"
      ],
      "title": "MySQL Source Spec",
      "type": "object"
    },
    "documentationUrl": "https://docs.airbyte.com/integrations/sources/mysql",
    "supported_destination_sync_modes": [],
    "supportsDBT": false,
    "supportsNormalization": false
  },
  "supportLevel": "certified",
  "supportsDataActivation": false,
  "supportsFileTransfer": false,
  "tags": [
    "language:java"
  ],
  "tombstone": false
}
