Easysoft Data Access for ISAM
=============================
Please read this carefully BEFORE installing.

These instructions show how to install on UNIX platforms.

Requirements
============

The installation script has a minimal set of requirements:

o Bourne shell in /bin/sh (if your Bourne shell is not located there you
  may need to edit the first line of the install file).

o Various commonly used UNIX commands such as:

  grep, awk, test, cut, ps, sed, cat, wc, uname, tr, find, echo, sum

  If you are missing any of these commands they can generally be
  obtained from the Free Software Foundation.

o Depending on the platform, you will need up to 15Mb of disk space
  free for the installed programs and up to 15Mb temporary space of the
  installation files themselves.

The installation process
========================

Untar the tar distribution file. On some platforms this is gzipped or
compressed. 
This should create a directory called "eda-isam-p.q.r.os" 
(where p.q.r is the version and os is the operating system name) 
containing some further tar files, some checksum files, this INSTALL file 
and an installation script ("install"). 

Change into the created directory and run the install program with ./install.

You will need approximately 20Mb of disk space to install.

Throughout the installation you may be asked to supply the answer to
some questions. In each case the default will be displayed in square
brackets and you need only press <return> to take the default.  If
there are alternative responses these will be shown in round brackets;
to pick one of these type them and press <return>.

Once the installation has checked you have the necessary shell tools
it will autodetect the operating system and check the encapsulated tar
package(s) by comparing them with a checksum file (do not worry if the
md5 checksum is not found as some platforms do not come with
md5sum). If this fails you will be given the opportunity to abort the
installation.

You will next be prompted for an installation path. All files are
installed in a subdirectory of your specified path called "easysoft"
e.g. if you pick the default of /usr/local, the software will be installed
in /usr/local/easysoft and below. 

Depending on your platform there may be more than one configuration 
(e.g. for Linux there may be a version built with glibc and one built 
with libc5).  These configurations are sometimes stored as tar files 
within the main gzipped tar file you downloaded from the Easysoft web page 
or copied off a CD distribution. In this case during the installation you 
will be asked to pick the configuration that best suits your system.

The selected configuration tar file will then be untarred in a
subdirectory of your specified install path called "easysoft". 

odbc.ini
========
This section gives a brief explanation of the settings for a Data Access
for ISAM datasource within the odbc.ini (usually /etc/odbc.ini).

# Server based datasource the name specified between [] is the Client                                             
# Target DSN value, see datasource.txt.                                                                           

[SAMPLE_ISAM]                                                                                                         

# Driver name within unixODBC driver manager                                                                      
driver = EASYSOFT_ISAM

# Temporary directory for ODBC-SQI SQL Engine (recordset's)
rs_path = /tmp                                                                                                    

# Temporary directory for ODBC-SQI SQL Engine (binary long objects)
blob_path = /tmp                                                                                                  

# Temporary directory for ODBC-SQI SQL Engine (used for sort files)
sort_path = /tmp                                                                                                  

# Amount of space to allocate for memory based sort buffers (in k bytes)                                          
sort_mem_size = 256                                                                                               

# Directory where schema files are stored (views, tableprivileges etc...)                                         
schema_path = <install_path>/easysoft/isam/demo/schema/

# Default data directory to be checked if file cannot be found and where new
# files will be created (if CREATE TABLE is used)
data_path = <install_path>/easysoft/isam/demo/data/

# Number of SQI's this datasource uses                                                                            
sqicount = 1                                                                                                      

# Connection string for SQI
target_string1 = Data Access for ISAM

# Required SQI-ISAM Driver
target_driver1 = /usr/local/easysoft/isam/lib/libesdisam_sqi.so

#                                                                                                                 
# These values are not set by default but may be enabled when required                                            
#                                                                                                                 

# prefix for log file name used in conjunction with logging setting                                     
logfile = /tmp/disam

# enables logging for specific elements (see logging.txt)
logging = 3                                                                                                       

# time in seconds files in cache are held open
cache_expiry = 30 (default)
                                                                                                                  
# specifies maximum amount of data files to cache open                                                            
cache_maxopen = 30 (default)

# allows user id to be defaulted from datasource                                                                  
default_uid = {user}                                                                                              

# allows password to be defaulted from datasource                                                                 
default_pwd = {password}                                                                                          

# allows ISAM transactions to be enabled (see transaction.txt)
transactions = 1 (default 0)

# transaction log file name (see transactions.txt)
transaction_log = /usr/local/easysoft/isam/demo/data/trans.log

# allows any file permission of created files to be set
umask = 0666

# turn off the SQI-ISAM drivers ability to walk down the data
# portion of fixed record length isam files directly. 
# this could cause significant performance lose
no_filescan = 0 (default)

# allows all meta data calls to become case insensitive, this can
# have a performance degradation on schema's with a large number
# of entries
case_insensitive = 0 (default)

# number of re-attempts at reading locked record before failing
lock_retries = 10 (default)

# number of 1000 millisecond intervals to wait between retries
lock_interval = 1000 (default)

# enabling this option will cause the SQI-ISAM Driver to wait for the 
# record to become free (could wait for ever)
lock_wait = 0 (default)

# setting this option to 0 disables the checks performed on non-nullable
# columns and datatypes on insert. 
null_insert_check = 1 (default)

# setting this option to 0 disables the checks performed on non-nullable
# columns and datatypes on update
null_update_check = 1 (default)

*** WARNING ***

Setting the following setting can effect the functionality of ODBC
applications. Please only use under the advise of the Easysoft Support
Department.

# allows the functionality of the SQLStatistics call to be changed
statistics = <number>

 1 Enables TABLE_STAT to return cardinality
 2 Enables SQL_ENSURE on unique indexes to return cardinality
 4 Enables SQL_ENSURE on non-unique indexes to return cardinality
 8 Enables SQL_QUICK on unique indexes to return cardinality
16 Enables SQL_QUICK on non-unique indexes to return cardinality

to enable multiple entries simply add the values together.
e.g. for table_stat + sql_quick on unique indexes 1 + 8 = 9

by default all of the above settings are set (statistics = 31)




Starting the http administration server
=======================================

Once all components have been installed simply type the following
cd <install_path>/easysoft/isam/bin
./start_http.sh

To stop an http server once running simply type
cd <install_path>/easysoft/isam/bin
./stop_http.sh

