JDBC Driver for Zendesk

Build 20.0.7587

Configuration File

You can save configuration settings for MySQL and TDS remoting in a config file. The file must be structured in the INI file format. Specify this file with the -f command-line option. The config file can have the following sections:

[mysqld]

In the mysqld section, use the following properties to configure the MySQL daemon:

NameDescription
portThe port number to use to listen for TCP/IP connections. The default port is 3306.
max-connectionsThe maximum number of allowed TCP/IP connections. 25 is the default.
session-timeoutThe session timeout time in seconds. The default timeout is 20 seconds.
logfileThe full path of the log file.
verbosityThe verbosity of the log. 1 is informational. Levels up to 5 add the following subsequent details: (2) HTTP headers, (3) the HTTP body, (4) transport-level communication including SSL, and (5) interface commands and other data source communication.
logrotationschemeThe interval at which to truncate the logs. The options are 1 (daily in the format [MyFileName]_2016_3_21.txt), 2 (weekly in the format [MyFileName]_Week_5.txt, where 5 is the fifth week in the year), and 3 (monthly in the format [MyFileName]_2016_3_21.txt).

The default is 2.

ssl-certThe path to the SSL certificate.
ssl-subjectThe subject of the SSL certificate.
ssl-passwordThe password of the SSL certificate.

[tdsd]

In the tdsd section, use the following properties to configure the TDS daemon:

NameDescription
portThe port number to use to listen for TCP/IP connections. The default port is 3306.
max-connectionsThe maximum number of allowed TCP/IP connections. 25 is the default.
session-timeoutThe session timeout time in seconds. The default timeout is 20 seconds.
logfileThe full path of the log file.
verbosityThe verbosity of the log. 1 is informational. Levels up to 5 add the following subsequent details: (2) HTTP headers, (3) the HTTP body, (4) transport-level communication including SSL, and (5) interface commands and other data source communication.
logrotationschemeThe interval at which to truncate the logs. The options are 1 (daily in the format [MyFileName]_2016_3_21.txt), 2 (weekly in the format [MyFileName]_Week_5.txt, where 5 is the fifth week in the year), and 3 (monthly in the format [MyFileName]_2016_3_21.txt).
ssl-certThe path to the SSL certificate.
ssl-subjectThe subject of the SSL certificate.
ssl-passwordThe password of the SSL certificate.

[databases]

In the databases section, define keys that map the MySQL database or the SQL Server catalog to Zendesk connection strings. Clients connect to the MySQL database or the SQL Server catalog defined here. To connect to Zendesk, the driver uses the connection string that corresponds to this key.

[databases]
Zendesk = "URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;"

[users]

In the users section, define the usernames and passwords of the users of the server. If the acl section is not defined, all users have access to all databases.

[mysql_vars]

In the mysql_vars section, define system variables for the MySQL server. The standard variables are supported. Below are several examples:

NameDescription
version_commentThis value is hard-coded as CData JDBC Driver for Zendesk (MySQL Remoting).
character_set_clientThe character_set used in statements sent by the client.

[acl]

In the acl section, allow users to access Zendesk databases. Databases must be defined in the databases section. Users must be defined in the users section. Use commas to separate users authorized to access the specified database.

Example Config File

Below is an example config file. The example includes all properties required to configure the server. It also shows how to configure access control for several users and Zendesk instances.

[mysqld]
port = 3306
max-connections = 25
session-timeout = 20
logfile = ZendeskRemotingLog.txt
verbosity = 2
ssl-cert = "CData.JDBC.Zendesk.Remoting.pfx"
ssl-subject = <subject>
ssl-password = <password>

[tdsd]
port = 1433
maxc = 20
session-timeout = 20
logfile = ZendeskRemotingLog.txt
verbosity = 2
ssl-cert = "CData.JDBC.Zendesk.Remoting.pfx"
ssl-subject = <subject>
ssl-password = <password>

[databases]
Zendesk = "URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;"
Zendesk_ReadOnly = "URL=https://subdomain.zendesk.com;User=my@email.com;Password=test123;ReadOnly=True"

[users]
root = <password>
test = <password>

[mysql_vars]
version_comment =  "CData JDBC Driver for Zendesk (MySQL Remoting)"

[acl]
Zendesk = root
Zendesk_ReadOnly = root, test

You can further restrict the allowed options by passing in options on the command line. See CLI Options for more information.

Copyright (c) 2020 CData Software, Inc. - All rights reserved.
Build 20.0.7587