README
     Progress(R) DataDirect(R)
     Progress(R) DataDirect(R) Autonomous REST Connector for ODBC

     Linux Platforms(32- and 64-bit) 

     Release 8.0.0 
     April 29, 2019


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

This README file contains information for Progress(R) DataDirect(R)  
Autonomous REST Connector(R) for ODBC. 

This README file contains information not included in the PROGRESS
DATADIRECT(R) AUTONOMOUS REST CONNECTOR(R) FOR ODBC DRIVER USER'S GUIDE 
AND REFERENCE.


CONTENTS

Driver Requirements
Installation Directory
Changes Since 8.0.0 GA 
Release 8.0.0 Features
Configuring Data Sources
Notes, Known Problems, and Restrictions
Driver WorkAround Options
Documentation 
Installed Files for 32-bit Drivers
Installed Files for 64-bit Drivers


	Driver Requirements

The driver requires a Java Virtual Machine (JVM): Java SE or OpenJDK, version 8
or higher. Also, you must set the library path environment variable of your 
operating system to the directory containing your JVM's libjvm.so file and that
directory's parent directory. 

	   
    Installation Directory 
	   
* The default installation directory for the 32-bit driver is:

  /opt/Progress/DataDirect/ODBC

* The default installation directory for the 64-bit driver is:

  /opt/Progress/DataDirect/ODBC_64Bit
  
  
    Changes Since 8.0.0 GA
	  
Enhancements
------------
* The driver has been enhanced to support OAuth 2.0 authentication.  


    Release 8.0.0 Features  

The driver supports SQL read-only access to REST API data sources that
express payloads using the JSON format. To support SQL access to REST API data
sources, the driver creates a relational map of the JSON data model and 
translates SQL statements provided by the application to native queries and Web
service calls. In addition, the driver supports multiple simultaneous sessions.

Features:
	
* The driver supports SQL read-only access to REST API endpoints that return 
  JSON payloads. 

* The driver supports all ODBC Core and Level 1 functions and some Level 1 and 
  Level 2 features. 
  
* The driver supports standard JSON data types and additional data types 
  through data type inference.

* The driver supports using internal memory or a configurable REST file to 
  define REST responses and relational mapping. 

* The driver heuristically maps data types, eliminating the need to define 
  native data types in most scenarios.

* The driver supports basic, HTTP-header based, URL-Parameter based and no 
  authentication.  

* The driver supports the handling of large result sets with configurable 
  paging and the FetchSize and WSFetchSize connection options. 
  
 
    Configuring Data Sources

Data sources are stored in the system information file (typically, 
odbc.ini). For details on configuring this file, see the PROGRESS DATADIRECT
AUTONOMOUS REST CONNECTOR FOR ODBC DRIVER USER'S GUIDE AND REFERENCE.
 
 
    Notes, Known Problems, and Restrictions 

The following are notes, known problems, and restrictions for the 
8.0 release of the driver:

Out-of-memory Errors
--------------------
The driver has been designed to handle large result sets that result. However,
out-of-memory errors can still occur. The following items outline how to reduce
the likelihood of out-of-memory errors for your environment.

* Reduce FetchSize to reduce demands on memory. By lowering the maximum number
  of rows as specified by FetchSize, you lower the number of rows the driver is
  required to process before returning data to the application. Thus, you 
  reduce demands on memory and decrease the likelihood of out-of-memory errors.

* Decrease ResultMemorySize until results are successfully returned. Intermediate
  results larger than the value specified will be written to disk as opposed to
  held in memory. When configured correctly, this avoids memory limitations by
  not relying on memory to process larger intermediate results. Be aware that
  while writing to disk reduces the risk of out-of-memory errors, it also
  negatively impacts performance. For optimal performance, decrease this value
  only to a size necessary to avoid errors. By default, ResultMemorySize is set
  to -1, which sets the maximum size of intermediate results held in memory to 
  a percentage of the max Java heap size. If you received errors using the 
  default configuration, use the max Java heap size divided by 4 as a starting
  point when tuning this option.

* Increase the JVM heap size. By increasing the max Java heap size, you increase
  the amount of data the driver can accumulate in memory and avoid 
  out-of-memory errors.

ODBC Development on Linux Platforms
-----------------------------------
All of the Release 8.0 Core Components (header files, etc.) needed for 
development of ODBC applications on Linux are installed into the /include
directory created by the product installer.

Please read the notices.txt file in the installation directory for 
licensing information regarding the ODBC Core Components. Contact your 
Progress DataDirect representative if you have any questions.

Developers using programming languages other than C++:
The DataDirect ODBC Driver Manager is a C++ shared library. The ODBC 
Driver Manager can be used with any language that supports loading a 
C++ shared library; however, if you are using a programming language 
other than C++, you must take additional steps to ensure that the C++ 
libraries are initialized properly when loaded. If you are not using 
C++, consult your compiler documentation for instructions on using C++ 
shared libraries with your application.
  
LANG Environment Setting on Linux Platforms
-------------------------------------------
A default installation of the product on Linux assumes that 
the value of the LANG environment setting is en_US. If your locale is
not set to en_US, the drivers may not return error messages properly. 
In this case, you must create a symbolic link in the 
/locale directory that has the same value as the LANG 
environment setting. This link must point to the 
/locale/en_US directory.
 
SQLColAttribute(s)
------------------
The column attributes 1001 and 1002, which were assigned as DataDirect- 
specific attributes, were inadvertently used as system attributes by
the Microsoft 3.0 ODBC implementation. Applications using those 
attributes must now use 1901 and 1902, respectively.
 
SQLDriverConnect
----------------
SQLDriverConnect using options other than SQL_DRIVER_NOPROMPT is 
supported only on systems that include the Motif libraries 
libivmback.so or libddmback.so and vscnctdlg.so.
 
SQL_C_NUMERIC
-------------
Because of inconsistencies in the ODBC specification, users attempting 
to use SQL_C_NUMERIC parameters must set the precision and scale values 
of the corresponding structure and the descriptor fields in the 
Application Parameter Descriptor.
 

    Driver WorkAround Options

Progress DataDirect has included non-standard connection options
(workarounds) for the Autonomous REST Connector that enable you to
take full advantage of packaged ODBC-enabled applications 
requiring non-standard or extendedbehavior.
Refer to the chapter "WorkAround Options" in THE PROGRESS DATADIRECT
AUTONOMOUS REST CONNECTOR FOR ODBC USER'S GUIDE AND REFERENCE for a 
description of these options.

      
     Documentation

THE PROGRESS DATADIRECT AUTNOMOUS REST CONNECTOR FOR ODBC
USER'S GUIDE AND REFERENCE
---------------------------------------------------------	 
The User's Guide and Reference is provided in PDF and HTML versions. Both 
versions are installed in the AutoRESTHelp subdirectory of your product 
installation directory. You can access the HTML help by opening the index.html
file. The PDF version, which you can view using Adobe Reader, can be viewed by 
opening the autorestodbcuser.pdf file.

NOTE: To download Adobe Reader, visit the Adobe Web site at 
http://www.adobe.com.

  
    Installed Files for the 32-bit Driver
	 
This file list assumes a full installation of the 32-bit driver and 
documentation. 

The installer copies the following files and subdirectories to the 
product installation directory, by default:

/opt/Progress/DataDirect/ODBC:

//:
----------------
odbc.csh                         Setup script for C shell
odbc.ini                         Sample odbc.ini file
odbcinst.ini                     Sample odbcinst.ini file
odbc.sh                          Setup script for Bourne shell
IVODBC.LIC                       DataDirect license file
fixes.txt                        List of fixes since last release
license.txt                      End User License Agreement

/bin/:
------
ivtestlib                        Test application to check that required 
                                 libraries are present and loadable

/help/:
------- 
autorest_connect.txt             Help text for the driver 
                                 SQLDriverConnect dialog 

/help/AutoRESTHelp/:
-------------------
index.html                       HTML help system entry file
autorestodbcuser.pdf             PDF copy of the User's Guide and Reference
*.*                              Support folders for the HTML help system

/include/:
----------
odbcinst.h                       Include files
qesqlext.h
sql.h
sqlext.h
sqltypes.h
sqlucode.h
sqlunx.h

/java/lib/:
----------
autorest.jar                     Java components of the driver

/lib/:
------
ivautorest28.so                  DataDirect Autonomous REST Connector  
ivtrc28.so                       Progress DataDirect trace library
libddcurl28.so                   Library used for HTTP connections 
libivicu28.so                    Unicode conversion tables  
libivmbackw.so                   SQLDriverConnect Motif library 
libivssl28.so	                 SSL support file (1.0.2n)
libodbc.so                       ODBC Driver Manager 
libodbcinst.so                   ODBC Installer
odbccurs.so                      ODBC Cursor library 
vscnctdlg.so                     ODBC library for Motif operations

/OpenSSL/latest/:
-----------------
libivssl28.so                    SSL support file (OpenSSL library 
                                 version 1.0.2n) 

/locale/en_US/LC_MESSAGES/:
--------------------------
ivmbackw.mo                      Motif library message file
ivmbackw.po                      Motif library message source
ivautorest28.mo                  Autonomous REST Connector message file
ivautonrest28.po                 Autonomous REST Connector message file source
odbc.m                           ODBC Driver Manager message file
odbc.po                          ODBC Driver Manager message source

/NOTICES/:
----------
ODBC for Autonomous REST Connector  
v8.0 notices.txt                 Third-party vendor license agreements	

/READMES/:
----------
ODBC for Autonomous REST Connector 
v8.0 readme.txt	                 This file

/samples/bulk/:
---------------
bulk                             Bulk application
bulk.c                           Bulk example source
bulk.mak                         Bulk example make file
bulk.txt                         Bulk example description
ddlogging.properties             Log configuration file for the Autonomous 
                                 REST Connector 

/samples/bulkstrm/:
---------------
bulk.cpp                         Bulk streaming example source
bulk.hpp                         Bulk streaming example header
bulkstrm                         Bulk streaming example application
bulkstrm.txt                     Bulk streaming example description
main.cpp                         Bulk streaming example source
msgprintf.hpp                    Bulk streaming example header
streambulk.mak                   Bulk streaming example make file
ddlogging.properties             Log configuration file for the 
                                 Autonomous REST Connector

/samples/example/:								  
------------------						  
example                          Example application
example.c                        Example source
example.h                        Example header
example.mak                      Example make file
example.txt                      Example description
ddlogging.properties             Log configuration file for the 
                                 Autonomous REST Connector 
/tools/:
ddextu                           License Extender utility
ddprocinfo                       Processor Information utility

/uninstall/:
------------
*.*                              Files used to uninstall the product
							

    Installed Files for the 64-bit Driver
	 
This file list assumes a full installation of the 64-bit driver and 
documentation. 

The installer copies the following files and subdirectories to the 
product installation directory, by default:

/opt/Progress/DataDirect/ODBC_64Bit:


//:
-------------
odbc.csh                         Setup script for C shell
odbc.ini                         Sample odbc.ini file
odbcinst.ini                     Sample odbcinst.ini file
odbc.sh                          Setup script for Bourne shell
DDODBC.LIC                       DataDirect license file
fixes.txt                        List of fixes since last release
license.txt                      End User License Agreement

/bin/:
------
ddtestlib                        Test application to check that required 
                                 libraries are present and loadable

/help/:
------- 
autorest_connect.txt             Help text for the driver 
                                 SQLDriverConnect dialog 

/help/AutoRESTHelp/:
--------------------
index.html                       HTML help system entry file
autorestodbcuser.pdf             PDF copy of the User's Guide and Reference
*.*                              Support folders for the HTML help system

/include/:
----------
odbcinst.h                       Include files
qesqlext.h
sql.h
sqlext.h
sqltypes.h
sqlucode.h
sqlunx.h

/java/lib/:
----------
autorest.jar                     Java components of the driver

/lib/:
------
ddautorest28.so                  DataDirect Driver for Autonomous 
                                 REST Connector 
ddtrc28.so                       Progress DataDirect trace library
libddcurl28.so                   Library used for HTTP connections  
libddicu28.so                    Unicode conversion tables  
libddmbackw.so                   SQLDriverConnect Motif library 
libddssl28.so	                 SSL support file (1.0.2n)
libodbc.so                       ODBC Driver Manager 
libodbcinst.so                   ODBC Installer 
odbccurs.so                      ODBC Cursor library 
vscnctdlg.so                     ODBC library for Motif operations

/OpenSSL/latest/:
----------------
libddssl28.so                    SSL support file (OpenSSL library 
                                 version 1.0.2n) 

/locale/en_US/LC_MESSAGES/:
--------------------------
ddmbackw.mo                      Motif library message file
ddmbackw.po                      Motif library message source
ddautorest28.mo                  Autonomous REST Connector message file
ddautorest28.po                  Autonomous REST Connector message file source
odbc.m                           ODBC Driver Manager message file
odbc.po                          ODBC Driver Manager message source

/NOTICES/:
----------
ODBC for Autonomous REST Connector 
v8.0 notices.txt                 Third-party vendor license agreements	

/READMES/:
----------
ODBC for Autonomous REST Connector  
v8.0 readme.txt	                 This file

/samples/bulk/:
---------------
bulk                             Bulk application
bulk.c                           Bulk example source
bulk.mak                         Bulk example make file
bulk.txt                         Bulk example description
ddlogging.properties             Log configuration file for the Autonomous
                                 REST Connector

/samples/bulkstrm/:
-------------------
bulk.cpp                         Bulk streaming example source
bulk.hpp                         Bulk streaming example header
bulkstrm                         Bulk streaming example application
bulkstrm.txt                     Bulk streaming example description
main.cpp                         Bulk streaming example source
msgprintf.hpp                    Bulk streaming example header
streambulk.mak                   Bulk streaming example make file
ddlogging.properties             Log configuration file for the 
                                 Autonomous REST Connector 

/samples/example/:
-------------------
example                          Example application
example.c                        Example source
example.h                        Example header
example.mak                      Example make file
example.txt                      Example description
ddlogging.properties             Log configuration file for the
                                 Autonomous REST Connector 
/tools/:
--------
ddextu                           License Extender utility
ddprocinfo                       Processor Information utility

/uninstall/:
------------
*.*                              Files used to uninstall the product

  
  
~~~~~~~~~~~~~~
April 29, 2019
End of README.TXT