README
     Progress(R) DataDirect(R) 
     Progress(R) DataDirect(R) for JDBC(TM) for Jira(TM) Driver
     Release 6.0.0 
     July 2019


***********************************************************************
Copyright (C) 2019 Progress Software Corporation and/or its 
subsidiaries or affiliates. All Rights Reserved. 
***********************************************************************


CONTENTS

Requirements
Installation Directory
Release 6.0.0 Features
Notes, Known Problems, and Restrictions
Documentation
Installed Files


     Requirements

The driver requires a Java Virtual Machine (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_60

* UNIX/Linux:
  /opt/Progress/DataDirect/JDBC_60
  Note: For UNIX/Linux, if you do not have access to "/opt", your user's home
  directory will take the place of this directory.


    Release 6.0.0 Features 

The Progress DataDirect for JDBC for Jira (Jira driver) is a driver that 
supports SQL read-only access for JDBC applications to Atlassian Jira. To 
support SQL access to Jira services, the driver creates a relational map of the 
Jira data model and translates SQL statements to Jira REST API requests. In 
addition, the driver employs a SQL engine component that provides support to 
SQL constructs unavailable to Jira services. This functionality offers a number
of advantages, including support for reporting data and metadata in a form JDBC
applications are ready to use. 

* Supports SQL read-only access to Atlassian Jira endpoints.

* Supports all JDBC Core functions.

* Supports the core SQL-92 grammar.

* Supports standard JSON data types

* Supports Jira custom fields, including many fields added 
  through third-party plug-ins 

* Supports the handling of large result sets with paging and the
  FetchSize and WSFetchSize connection properties.  
  
* Supports SSL data encryption. 
  


	Notes, Known Problems, and Restrictions

The following are notes, known problems, and restrictions with release 6.0.0 of
the driver.

Aggregates for Date/Time Data Types
-----------------------------------
The MIN and MAX aggregates for the Date/Time data types my return incorrect
values. 

JTA Support
-----------
JDBC distributed transactions through JTA are not supported.

System.exit() method and Process Termination
--------------------------------------------
The System.exit() method ensures that all registered shutdown hooks are run.
Applications terminate faster when System.exit(0) is used. When applications
omit the System.exit() call, the termination process may linger for about 10
seconds before exiting.

Executing DataDirect Shell Script
---------------------------------
For UNIX/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.
  
* When attempting to create an updatable, scroll-sensitive result set for a
  query that contains an expression as one of the columns, the driver cannot
  satisfy the scroll-sensitive request. The driver downgrades the type of the
  result returned to scroll-insensitive.
  
* The DataDirect for JDBC drivers support retrieval of output parameters from a
  stored procedure before all result sets and/or update counts have been 
  completely processed. When CallableStatement.getXXX is called, result sets 
  and update counts that have not yet been processed by the application are 
  discarded to make the output parameter data available. Warnings are generated
  when results are discarded.

* The preferred method for executing a stored procedure that generates result
  sets and update counts is using CallableStatement.execute(). If multiple
  results are generated using executeUpdate, the first update count is returned.
  Any result sets prior to the first update count are discarded. If multiple
  results are generated using executeQuery, the first result set is returned.
  Any update counts prior to the first result set are discarded. Warnings are
  generated when result sets or update counts are discarded.  
  
* 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 JIRA DRIVER USER'S GUIDE 
---------------------------------------------------
The user's guide is available as an HTML help system and as a PDF.

* The HTML help system and PDF are installed in the JiraHelp subdirectory
  of your product installation directory.

* The HTML help system and the PDF are also available on this Progress
  DataDirect documentation web page:
  https://www.progress.com/documentation/datadirect-connectors


     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
   - PROGRESS_DATADIRECT_JDBC_JIRA_6.0.0_INSTALL.iam.zip
   - PROGRESS_DATADIRECT_JDBC_COMMON_6.0.0_INSTALL.iam.zip
   - PROGRESS_DATADIRECT_JDBC_DOCUMENTATION_6.0.0_INSTALL.iam.zip

*  Non-Windows:
   - PROGRESS_DATADIRECT_JDBC_INSTALL.jar
   - PROGRESS_DATADIRECT_JDBC_JIRA_6.0.0_INSTALL.iam.zip
   - PROGRESS_DATADIRECT_JDBC_COMMON_6.0.0_INSTALL.iam.zip
   - PROGRESS_DATADIRECT_JDBC_DOCUMENTATION_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


INSTALL_DIR/Examples/Connector/:
--------------------------------
ConnectorSample.ear        J2EE Application Enterprise Archive file containing
                           the ConnectorSample application 

connectorsample.htm        USING DATADIRECT CONNECT FOR JDBC RESOURCE ADAPTERS
                           document

graphics/*.*               Images referenced by the USING DATADIRECT CONNECT FOR
                           JDBC RESOURCE ADAPTERS document

src/ConnectorSample.jsp    Source for the JavaServer Page used to access the
                           ConnectorSample application

src/connectorsample/ConnectorSample.java     
                           Java source file defining the remote interface for
                           the ConnectorSample EJB

src/connectorsample/ConnectorSampleBean.java  
                           Java source file defining the home interface for the
                           ConnectorSample EJB

src/connectorsample/ConnectorSampleHome.java  
                           Java source file containing the implementation for
                           the ConnectorSample EJB


INSTALL_DIR/Examples/JNDI/:
---------------------------
JNDI_FILESYSTEM_Example.java
                           Example Java(TM) source file

JNDI_LDAP_Example.java     Example Java source file


INSTALL_DIR/Examples/JiraSamples/:
------------------------------------
buildsamples.bat           Batch file to build the Jira driver 
                           example

buildsamples.sh            Shell script to build the Jira driver 
                           example
 
ddlogging.properties       Logging properties file

runjiraconnectsample.bat
                           Batch file to run the Jira driver 
                           example

runjiraconnectsample.sh
                           Shell script to run the Jira driver
                           example

bin/com/ddtek/jdbc/samples/JiraConnectSample.class
                           Java example class

bin/com/ddtek/jdbc/samples/SampleException.class
                           Java example class

src/com/ddtek/jdbc/samples/JiraConnectSample.java
                           Java source example


INSTALL_DIR/Help/: 
------------------
JiraHelp/index.html         Driver HTML help system entry file

JiraHelp/jirajdbcug.pdf     User's guide PDF file

JiraHelp/*                  Support files and folders for the driver 
                            help system


INSTALL_DIR/install/: 
---------------------
.psc_dd_inst_reg.xml       Support file for the installation logs

logs/*.*                   Log file generated upon installation


INSTALL_DIR/jre/:
-----------------
*.*                        Files associated with the Jira driver 


INSTALL_DIR/lib/:
-----------------
jira.jar                   Jira Driver and DataSource 
                           classes


INSTALL_DIR/NOTICES/:
---------------------
JDBC for Jira 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 Jira 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/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_60.exe      Windows uninstaller

Uninstall_JDBC_60.lax      Support file for the Windows uninstaller

uninstaller.jar            Java uninstaller

jira/*.*                   Support files for the uninstaller

resource/*.*               Resource files for the Windows uninstaller


July 2019
============
End of README