GitHub JDBC 6.0.0
- Last Updated: May 8, 2026
- 7 minute read
- OpenAccess SDK
- Documentation
README
Progress(R) DataDirect(R)
Progress(R) DataDirect(R) for JDBC(TM) for GitHub(TM) Driver
Release 6.0.0
February 2026
***********************************************************************
Copyright (C) 2026 Progress Software Corporation and/or its
subsidiaries or affiliates. All Rights Reserved.
***********************************************************************
CONTENTS
Post-GA Product Announcements
Requirements
Installation Directory
Data Source and Platform Support
Changes Since 6.0.0 GA
Release 6.0.0 Features
Progress DataDirect GitHub Configuration Manager
Notes, Known Problems, and Restrictions
Documentation
Installed Files
Post-GA Product Announcements
The readme files will no longer be updated with product announcements and new
features after the General Availability (GA) of the product. For the latest
updates and enhancements, please refer to the release notes
(https://www.progress.com/datadirect-connectors/whats-new).
Requirements
* A supported Java Virtual Machine (JVM) must be defined on your system path.
* The installer program requires a JVM that is Java SE 11 or higher, including
Oracle JDK, OpenJDK, and IBM SDK (Java) distributions.
* The driver requires a JVM that is Java SE 8 or higher, including Oracle JDK,
OpenJDK, and IBM SDK (Java) distributions.
Installation Directory
The default installation directory for the driver is:
* Windows:
C:\Program Files\Progress\DataDirect\JDBC
* UNIX/Linux:
/opt/Progress/DataDirect/JDBC
Note: For UNIX/Linux, if you do not have access to "/opt", your user's home
directory will take the place of this directory.
Data Source and Platform Support
For the latest data source and platform support information, refer to the
Product Compatibility Guide:
https://docs.progress.com/bundle/datadirect-product-compatibility/resource/
datadirect-product-compatibility.pdf
Changes Since 6.0.0 GA
CVE-2022-41853 - Use of Externally-Controlled Input to Select Classes or Code
('Unsafe Reflection')
-----------------------------------------------------------------------------
Several Progress DataDirect JDBC drivers utilized a version of HyperSQL
Database that was vulnerable to remote code execution described in
CVE-2022-41853. All impacted drivers have been patched to fix this
vulnerability. For details on impacted drivers and fixed versions, refer to
the following KB article:
https://community.progress.com/s/article/DataDirect-JDBC-Critical-Security-
Bulletin-November-2022-CVE-2022-41853
Enhancements
------------
* The driver has been enhanced to use proxy server settings defined in the JVM
system properties by default. If no proxy settings are defined in the
connection string or data source, the driver will attempt to use the values
of the http.proxyHost and http.proxyPort JVM system properties to connect to
the database.
* The driver has been enhanced to support the Bearer token authentication.
See "Bearer token authentication" in the "Notes, Known Problems, and
Restrictions" section for details.
Changed Behavior
----------------
* The installer program now requires you to install a JRE that is Java SE 11 or
higher before running the installer. In earlier versions, the JRE used by the
installer program was included in the product. However, to avoid potential
security vulnerabilities, the installer program no longer includes a JRE.
Instead, the installer program uses the JRE in your environment to allow for
the most secure version of a JRE to be used.
Note: This change does not affect the JVM requirements for the driver. For the latest
driver requirements, refer to the Product Compatibility Guide:
https://docs.progress.com/bundle/datadirect-product-compatibility/resource/
datadirect-product-compatibility.pdf
* The default value of the AuthenticationMethod connection property has
been changed to BearerToken.
Release 6.0.0 Features
The Progress DataDirect for JDBC for GitHub (GitHub driver) supports SQL
read-only access for JDBC applications to GitHub services. The driver provides
access to data in GitHub Enterprize and GitHub Cloud, which can be pulled into a
data visualization tool to get important insights into engineering operations.
In addition, the driver employs a SQL engine component that provides support to
SQL constructs to provide the most comprehensive SQL support and JDBC
standard-based connectivity to BI or ETL tools. To support SQL access to GitHub
services, the driver creates a relational map of the GitHub data model and
translates SQL statements to GitHub REST API requests. In addition, the driver:
* Supports SQL read-only access to GitHub endpoints
* Supports all JDBC Core functions
* Supports the core SQL-92 grammar
* Supports GitHub data types through data type inference
* Supports the handling of large result sets with paging and the
FetchSize connection property
* Supports Basic and OAuth 2.0 authentication
* Supports SSL data encryption
* Includes the Progress DataDirect GitHub Configuration Manager for
quick configuration and testing of your driver. This tool allows you to:
- Generate and edit connection URLs
- Test connect connection URLs
- Execute SQL commands for testing
- Fetch OAuth tokens
- Access connection property descriptions and the full product
documentation
Progress DataDirect GitHub Configuration Manager
The driver includes a browser-based configuration tool, the Progress DataDirect
GitHub Configuration Manager, that allows you to generate and test connection
URLs that you can use with your application. You can launch the Configuration
Manager by double-clicking on the driver jar file or, from a command line,
you can navigate to the directory containing the driver jar file; then, execute
the following command:
java -jar github.jar
The GitHub Configuration Manager will open in your default web browser. For more
information, refer to the user's guide for your driver.
Notes, Known Problems, and Restrictions
The following are notes, known problems, and restrictions with release 6.0.0 of
the driver.
Bearer token authentication
---------------------------
To configure the driver to use bearer token authentication:
* Set the ServerName connection property to specify the base URL
of the GitHub instance to which you want to issue requests.
For example, https://github.<enterprise>.com.
* Set the SecurityToken connection property to specify the
personal access token assigned to you.
Note: The SecurityToken connection property is not required to be
stored in the connection string. It can also be passed separately
by the application.
The following example shows the connection information required
to establish a connection using bearer token authentication.
Connection conn = DriverManager.getConnection
("jdbc:datadirect:github:ServerName=github.<enterprise>.com;
SecurityToken=12a3=bCD/EfGh4Ijk+Lgd8g-44tk3c527831;");
Two-factor Authentication
-------------------------
The driver does not support two-factor authentication.
Child Tables with Mandatory Filters
-----------------------------------
If you execute a query on a child table that has mandatory filters, the driver
will return an error message that indicates corresponding parent columns.
Invalid Client Secret in the GitHub Configuration Manager
----------------------------------------------------------
In the GitHub Configuration Manager, if you enter an invalid client secret
value while fetching the OAuth tokens, the driver will not return an error
message.
Aggregates for Date/Time Data Types
-----------------------------------
The MIN and MAX aggregates for the Date/Time data types may return incorrect
values.
JTA Support
-----------
JDBC distributed transactions through JTA are not supported.
Executing DataDirect Shell Script
---------------------------------
For Linux users: If you receive an error message when executing any
DataDirect for JDBC shell script, make sure that the file has EXECUTE
permission. To do this, use the chmod command. For example, to grant EXECUTE
permission to the testforjdbc.sh file, change to the directory containing
testforjdbc.sh and enter: chmod +x testforjdbc.sh
JDBC Methods
------------
The following notes on JDBC methods apply generally to Progress DataDirect for
JDBC drivers. Additional information on driver support for the JDBC API can be
found in the "JDBC Support" section of the product user's guide.
* The DataDirect for JDBC drivers allow PreparedStatement.setXXX methods and
ResultSet.getXXX methods on Blob/Clob data types, in addition to the
functionality described in the JDBC specification. The supported
conversions typically are the same as those for LONGVARBINARY/LONGVARCHAR,
except where limited by database support.
* The ResultSet methods getTimestamp(), getDate(), and getTime() return
references to mutable objects. If the object reference returned from any of
these methods is modified, re-fetching the column using the same method
returns the modified value. The value is only modified in memory; the
database value is not modified.
Documentation
PROGRESS DATADIRECT FOR JDBC FOR GITHUB DOCUMENTATION SET
---------------------------------------------------------
The driver documentation set is available from the Progress Information Hub:
https://docs.progress.com/category/datadirect-github
You can access the online help system directly in either of the following ways.
* Via the HTML redirect in the installation Help directory
* By selecting Help from the menu in the Configuration Manager
Installed Files
When you extract the contents of the installation download package to your
installer directory, you will notice the following files that are required to
install the driver:
* Windows:
- PROGRESS_DATADIRECT_JDBC_INSTALL.exe
- DriverModules
- PROGRESS_DATADIRECT_JDBC_GITHUB_6.0.0_INSTALL.iam.zip
- PROGRESS_DATADIRECT_JDBC_COMMON_6.0.0_INSTALL.iam.zip
* Non-Windows:
- PROGRESS_DATADIRECT_JDBC_INSTALL.jar
- DriverModules
- PROGRESS_DATADIRECT_JDBC_GITHUB_6.0.0_INSTALL.iam.zip
- PROGRESS_DATADIRECT_JDBC_COMMON_6.0.0_INSTALL.iam.zip
When you install the driver, the installer creates the following directories and
files in the product installation directory in the default installation
directory or in an installation directory you specify, represented by
INSTALL_DIR.
INSTALL_DIR/:
-------------
LicenseTool.jar Product license file manager
ddprocinfo.exe Windows executable to start the Processor Information
Utility
ddprocinfo UNIX/Linux script to start the Processor Information
Utility
fixes.txt Information on resolved issues for Progress
DataDirect for JDBC drivers
INSTALL_DIR/Examples/Bulk/:
---------------------------
Load From File/bulkLoadFileDemo.java
Java source example for bulk loading from a CSV file
Load From File/load.txt Sample data for the example
Streaming/bulkLoadStreamingDemo.java
Java source example for bulk loading from a result
set
Threaded Streaming/bulkLoadThreadedStreamingDemo.java
Java source example for multi-threaded bulk loading
from a result set
Threaded Streaming/README.txt
Instructions on how to use the thread.properties file
Threaded Streaming/thread.properties
Properties file for the example
INSTALL_DIR/Examples/JNDI/:
---------------------------
JNDI_FILESYSTEM_Example.java
Example Java(TM) source file
JNDI_LDAP_Example.java Example Java source file
INSTALL_DIR/help/:
------------------
*.html HTML redirects to driver help systems
INSTALL_DIR/install/:
---------------------
.psc_dd_inst_reg.xml Support file for the installation logs
logs/*.* Log file generated upon installation
INSTALL_DIR/lib/:
-----------------
JDBCDriverLogin.conf Kerberos configuration file used to specify the JAAS
login module
INSTALL_DIR/lib/60/:
--------------------
github.jar GitHub Driver and DataSource classes
INSTALL_DIR/NOTICES/:
---------------------
JDBC for GitHub v6.0 notices.txt
Third party agreement information
INSTALL_DIR/pool manager/:
--------------------------
pool.jar All DataDirect Connection Pool Manager classes
INSTALL_DIR/READMES/:
---------------------
JDBC for GitHub v6.0 readme.txt
This file
INSTALL_DIR/testforjdbc/:
-------------------------
Config.txt Configuration file for DataDirect Test
ddlogging.properties Logging properties file
testforjdbc.bat Batch file to start DataDirect Test
testforjdbc.sh Shell script to start DataDirect Test
lib/testforjdbc.jar DataDirect Test classes
INSTALL_DIR/jdbcisql/:
----------------------
jdbcisql.bat Batch file to start JDBC iSQL
jdbcisql.ini Configuration file for JDBC iSQL
jdbcisql.jar Java program to start JDBC iSQL
jdbcisql.sh Shell script to start JDBC iSQL
INSTALL_DIR/uninstall/:
-----------------------
.com.zerog.registry.xml Support file for the uninstaller
.psc_dd_uninst_reg.xml Support file for the uninstaller
InstallScript.iap_xml Support file for the uninstaller
installvariables.properties
Support file for the Windows uninstaller
Uninstall_JDBC.exe Windows uninstaller
Uninstall_JDBC.lax Support file for the Windows uninstaller
uninstaller.jar Java uninstaller
github/*.* Support files for the uninstaller
resource/*.* Resource files for the Windows uninstaller
February 2026
================
End of README