SSIS Components for MySQL

Build 20.0.7745

Connection Properties

The connection properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection settings for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.
Allow User VariablesWhen set to True, user variables (prefixed by an @) can be used in SQL queries.
Auth SchemeThe scheme used for authentication. Accepted entries are Password, AzureAD, AzurePassword, AzureMSI.
Azure TenantThe Microsoft Online tenant being used to access data. If not specified, your default tentant will be used.
Browsable SchemasThis property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
CharactersetThe default client character set used by the provider. For example, 'utf8'.
DatabaseThe name of the MySQL database.
DomainThe name of the domain for a Windows (NTLM) security login.
Firewall PasswordA password used to authenticate to a proxy-based firewall.
Firewall PortThe TCP port for a proxy-based firewall.
Firewall ServerThe name or IP address of a proxy-based firewall.
Firewall TypeThe protocol used by a proxy-based firewall.
Firewall UserThe user name to use to authenticate with a proxy-based firewall.
Initiate OAuthSet this property to initiate the process to obtain or refresh the OAuth access token when you connect.
Integrated SecurityWhether or not to authenticate with Windows authentication.
Integrated UserThe user that is authenticating to the Windows.
LocationA path to the directory that contains the schema files defining tables, views, and stored procedures.
LogfileA filepath which designates the name and location of the log file.
Log ModulesCore modules to be included in the log file.
Max Log File CountA string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.
Max Log File SizeA string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end.
Max RowsLimits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
NTLM VersionThe NTLM version.
OAuth Access TokenThe access token for connecting using OAuth.
OAuth Client IdThe client ID assigned when you register your application with an OAuth authorization server.
OAuth Client SecretThe client secret assigned when you register your application with an OAuth authorization server.
OAuth Expires InThe lifetime in seconds of the OAuth AccessToken.
OAuth Settings LocationThe location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.
OAuth Token TimestampThe Unix epoch timestamp in milliseconds when the current Access Token was created.
OAuth VerifierThe verifier code returned from the OAuth authorization URL.
OtherThese hidden properties are used only in specific use cases.
PasswordThe password used to authenticate the user.
PortThe port of the MySQL server. Supports cluster servers, for example: '3306, 3307', the number of the port should match with Servers.
Proxy Auth SchemeThe authentication type to use to authenticate to the ProxyServer proxy.
Proxy Auto DetectThis indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
Proxy ExceptionsA semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .
Proxy PasswordA password to be used to authenticate to the ProxyServer proxy.
Proxy PortThe TCP port the ProxyServer proxy is running on.
Proxy ServerThe hostname or IP address of a proxy to route HTTP traffic through.
Proxy SSL TypeThe SSL type to use when connecting to the ProxyServer proxy.
Proxy UserA user name to be used to authenticate to the ProxyServer proxy.
Query PassthroughThis option passes the query to the MySQL server as is.
ReadonlyYou can use this property to enforce read-only access to MySQL from the provider.
RTKThe runtime key used for licensing.
ServerThe host name or IP address of the server. Supports cluster servers, for example '192.168.0.1,192.168.0.2'.
SSH Auth ModeThe authentication method to be used to log on to an SFTP server.
SSH Client CertThe SSH client certificate store for SSH Client Authentication.
SSH Client Cert PasswordThe password for the SSH client certificate.
SSH Client Cert SubjectThe subject of the SSH client certificate.
SSH Client Cert TypeThe type of key store containing the SSH client certificate.
SSH PasswordThe SSH password.
SSH PortThe SSH port.
SSH ServerThe SSH server.
SSH Server FingerprintThe SSH server fingerprint.
SSH UserThe SSH user.
SSL Client CertThe TLS/SSL client certificate store for SSL Client Authentication (2-way SSL).
SSL Client Cert PasswordThe password for the TLS/SSL client certificate.
SSL Client Cert SubjectThe subject of the TLS/SSL client certificate.
SSL Client Cert TypeThe type of key store containing the TLS/SSL client certificate.
SSL Server CertThe certificate to be accepted from the server when connecting using TLS/SSL.
TablesThis property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
TimeoutThe value in seconds until the connection timeout error is thrown.
UserThe MySQL user account used to authenticate.
Use SSHUse SSH.
Use SSLThis field sets whether SSL is enabled.
VerbosityThe verbosity level that determines the amount of detail included in the log file.
ViewsRestricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Zero Dates To NullWhether or not to return Date and DateTime values consisting of all zeros as NULL.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 20.0.7745