home *** CD-ROM | disk | FTP | other *** search
/ Usenet 1994 January / usenetsourcesnewsgroupsinfomagicjanuary1994.iso / sources / misc / volume30 / oraperl-v2 / part04 / Readme < prev    next >
Encoding:
Text File  |  1992-07-06  |  5.4 KB  |  128 lines
  1. This is an instant-mix package (just add Perl) to create Oraperl,
  2. a version of Perl which is capable of accessing Oracle databases,
  3. and Coraperl, a version of Oraperl which also includes Curses.
  4. To use it, you must have the Oracle Pro*C product and a version of
  5. Perl which supports Usersubs (v3.0.27 or later).
  6.  
  7. Unshar it somewhere convenient, and edit Makefile. You may need
  8. to change the definitions below:
  9.  
  10.     ORACLE_HOME    your Oracle installation directory
  11.     SRC        your Perl source directory (with the usub directory)
  12.     OTHERLIBS    \ 
  13.     CLIBS         |
  14.     OCILIB         +- copy these from $ORACLE_HOME/c/demo/proc.mk
  15.     NETLIBS         |  (or whatever you use to link OCI programs)
  16.     ORALIBS        /
  17.     ALL_ORA_LIBS    summary of Oracle libraries.
  18.             This is the one that the Makefile actually uses
  19.     GLOBINCS    \ 
  20.     LOCINCS         +- copy these from $SRC/usub/Makefile
  21.     LIBS        /
  22.     CURSELIB    your curses library, if you're building Coraperl
  23.     DEBUG        -DDEBUGGING, -DPERL_DEBUGGING or leave blank;
  24.             see the file Debugging for an explanation
  25.     DBUG_O        the debugging library, if debugging is required
  26.     CACHE        default fetch cache size, if you want to change it
  27.     BIND        if defined, do not pad empty bind values
  28.     STRTOUL        \_ system dependent - see Makefile for details
  29.     STR_2MORTAL    /
  30.     TESTDATA    database, username and password for testing Oraperl
  31.  
  32. As well as oraperl, you can also type "make coraperl" to create a version
  33. of Oraperl which incorporates curses. You must first compile curseperl (in
  34. $(SRC)/usub), and leave the curses.o file there. You may need Perl v4.0.19
  35. or later for this to work, as that was the first version to support System V
  36. curses. Typing "make all" will make both oraperl and coraperl.
  37.  
  38. After building oraperl, type "make test" to run some rudimentary tests.
  39. These are anything but exhaustive, but if anything goes wrong, you need
  40. to check it. At present, the tests are just hacked from a couple of the
  41. example scripts; if you have some better tests, please send them to me.
  42.  
  43. After testing oraperl (and optionally building coraperl) type "make install"
  44. to install the binaries and the manual pages. They will be put in the same
  45. directories as you specified for Perl, so the config.sh script must still
  46. exist in your Perl source directory. The sample script example/sql will
  47. also be installed, as it is a useful program in its own right.
  48.  
  49. I've only tested this on an Encore Multimax 520 running UMAX V (Sys Vr3.2),
  50. using whichever version of Perl was current at the time that I completed
  51. each release (covers the range 3.0.34 to 4.0.35, excluding 4.0.33) with
  52. Oracle version 6, as I don't have access to any other system with Pro*C.
  53. However, other people have compiled and used it on a range of different
  54. systems including Convex, Cray, NeXT, Pyramid, Sun and Ultrix, using Oracle
  55. versions 5 and 6. I'd appreciate any comments, bug-reports, improvements, etc.
  56.  
  57. In addition to this README, the package contains the following files:
  58.  
  59. Source Code:
  60.     Makefile    building instructions
  61.     colons.c    counts substitution variables in a statement
  62.     debug.c        translates numeric debugging codes to string
  63.     getcursor.c    functions to deal with the cursor pool
  64.     oracle.mus    function interface description
  65.     orafns.c    oracle interface functions
  66.     orafns.h    common declarations
  67.     patchlevel.h    Oraperl version number and patch level
  68.     strtoul.c    for systems which don't have strtoul(3)
  69.     usersub.c    initialisation routine
  70.  
  71. Fred Fish' Debugging library (in the dbug/ directory):
  72.     Makefile    makefile for the debugging library
  73.     Readme        readme for the debugging library
  74.     dbug.c        library code
  75.     dbug.h        debugging header
  76.     dbug.p        documentation for the debugging library
  77.     dbug.qr        quick reference list
  78.     fact.c        sample program (taken from the manual)
  79.  
  80. Examples (in the examples/ directory):
  81.     Readme        introduction to the examples
  82.     bind.pl        use of ora_bind and ora_fetch for table lookup
  83.     ckdebug.pl    tests to see if debugging is available
  84.     commit.pl    using commit and rollback
  85.     ex.pl        simple example of Oraperl functions
  86.     mkdb.pl        more extensive example, using curses if available
  87.             you can run this with either Oraperl or Coraperl
  88.     oradump.pl    dump an Oracle table into a set of insert statements
  89.     sql        execute an SQL statement from the command line
  90.             (this one is worth installing)
  91.     tabinfo.pl    display the structure of a database table
  92.  
  93. Documentation (in the doc/ directory):
  94.     oraperl.ref    quick reference - glue it into the perl reference guide
  95.     oraperl.1    manual page
  96.  
  97. Testing information (in the testdir/ directory)
  98.     Readme         test information
  99.     Standard-Results correct results for a test run
  100.     commit.pl     test script
  101.     mkdb.pl         test script
  102.  
  103. Miscellaneous:
  104.     Changes        Summary of changes to Oraperl
  105.     Debugging    Details of the built-in debugging routines
  106.     Hints        notes concerning problems which have arisen in the past
  107.     Long        information about LONG and LONGRAW support
  108.     Makefile    builds (c)oraperl and documentation, cleans up
  109.     Row_cache    describes the speed improvements due to caching
  110.     install.pl    Perl script to install Oraperl
  111.     oraperl.ph    definitions of Oraperl error and debugging codes
  112.  
  113. Many thanks to Larry for Perl.
  114.  
  115.     Kevin Stock
  116.     kstock@encore.com
  117.  
  118.  
  119.          IMPORTANT NOTICE - Warranty and Copyright
  120.  
  121. Oraperl is not a product of either Encore Computer Corporation or Oracle
  122. Corporation or any of their subsidiaries. There is no warranty, and no
  123. official support is available.
  124.  
  125. It is Copyright 1991, 1992 Kevin Stock, but may be freely distributed
  126. under the same terms as Perl itself, that is, under the terms of either
  127. the GNU Public License or the Artistic License.
  128.