home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
The World of Computer Software
/
World_Of_Computer_Software-02-387-Vol-3of3.iso
/
o
/
oraunl.zip
/
ORAUNLD.DOC
< prev
next >
Wrap
Text File
|
1992-02-15
|
29KB
|
861 lines
OraUnload
Oracle table dump facility
Developed by R.A. McGowan
Published by RamSoft Solutions
637 Wyckoff Avenue
Suite 313
Wyckoff, NJ 07481
Copyright 1992
All rights reserved
Version 0.90ß
(BETA VERSION Feb 14, 1992)
Oracle is a registered trademark of Oracle Corporation
PLEASE REFER TO ORAUNLD.NEW
FOR DETAILS OF RECENT PROGRAM CHANGES.
Table of Contents
-----------------------------------------------------------------
Product License Agreement. . . . . . . . . . . . . . . . . . . .1
Introduction . . . . . . . . . . . . . . . . . . . . . . . . . .3
Summary of features. . . . . . . . . . . . . . . . . . . . . . .4
Usage. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5
Error messages . . . . . . . . . . . . . . . . . . . . . . . . .7
Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . .8
What to expect in future releases. . . . . . . . . . . . . . . .9
What you get when you register . . . . . . . . . . . . . . . . 10
Registration . . . . . . . . . . . . . . . . . . . . . . . . . 11
Thanks . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
PRODUCT LICENSE AGREEMENT
This program is not free! You are hereby licensed to use this
program for a trial period of 30 days free of charge. If, after
30 days, you decide that you would like to continue using Ora-
Unload, you must complete the registration form found later in
this document and return it to the author with the required
registration fee enclosed.
OraUnload is copyrighted under US law and international treaty
provisions. You agree that your use of OraUnload is subject to
these laws, which prohibit unauthorized copying or duplication of
the software, documentation, and other materials.
While you are evaluating OraUnload you may use it on as many
computers as are required to perform your evaluation. Your
30-day evaluation period begins when you first install OraUnload
on one or more computers for evaluation purposes. Once the
evaluation period is over and you purchase the program, your use
is subject to the following restrictions:
Individual Copies: You agree not to install and use an
individual Registered Copy of OraUnload on more than one
computer at a time. However, we agree to an exception to
this rule if you meet the conditions described in the rest
of this paragraph. You may install your individual copy
simultaneously on one computer at work, one computer at
home, and one portable computer, if all these computers are
used primarily by the same individual, and there is NO
POSSIBILITY that the computers will be in use at the same
time except while you are actively transferring files be-
tween them. If OraUnload was purchased by your employer you
agree to get your employer's explicit permission before
installing OraUnload on multiple systems as described in
this paragraph.
Multi-System Licenses and Network Use: You agree to pur-
chase multiple individual copies or a multi-system license
before using OraUnload simultaneously on more than one
computer. When you purchase a multi-system license you
agree not to use the OraUnload on more computers than the
number included in your license, as shown on your invoice or
other documents from us. You may install the OraUnload on
computers attached to a network, or remove it from one
computer and install it on a different one, provided there
is NO POSSIBILITY that your copy will be installed or used
on more computers than it is licensed for. If you have a
network, you don't need to include every computer attached
to the network in your license, but you must include every
computer on which the OraUnload is installed or used, re-
gardless of whether the user of the computer happens to know
that OraUnload is in use on their system. If you have
OraUnload 1.0 User Documentation 1
single computers which allow multiple users to use OraUnload
simultaneously, you must count each keyboard or terminal
separately when determining how many computers are using
OraUnload.
Please feel free to distribute unregistered copies of OraUnload
to your friends and local BBSs as long as all the files in this
archive are included and unmodified.
Shareware distributors may distribute this program as long as the
author has been notified, in writing, prior to any distribution.
The per disk charge may not exceed $10 and the shareware distrib-
utor will not change the license fee for the end use of Ora-
Unload. End users are no exempt from registering OraUnload at
the normal registration fee.
RamSoft Solutions has attempted to build reasonable safeguards
into OraUnload, but if you do not use it properly you may destroy
files or cause other damage to your computer software and data.
You assume full responsibility for the selection and use of
OraUnload to achieve your intended results.
IN NO EVENT SHALL WE BE LIABLE FOR ANY INCIDENTAL,
CONSEQUENTIAL, OR PUNITIVE DAMAGES WHATSOEVER ARISING
OUT OF USE OF THE PROGRAM OR YOUR RELATIONSHIP WITH US,
INCLUDING WITHOUT LIMITATION ANY OR ALL DAMAGES FOR
LOSS OF PROFITS, BUSINESS INTERRUPTION, LOSS OF INFOR-
MATION OR ANY PECUNIARY LOSS, EVEN IF WE HAVE BEEN AD-
VISED OF THE POSSIBILITY OF SUCH DAMAGES.
OraUnload 1.0 User Documentation 2
Introduction
-----------------------------------------------------------------
OraUnload is intended as a "companion" utility to Oracle Corpor-
ation's SQL*Loader utility. Where SQL*Loader provides the
ability to fill Oracle tables from data contained in external
operating system files, OraUnload facilitates the process of
extracting data from Oracle tables to external files.
OraUnload, like many utility programs, was born of necessity
during the course of normal business operations. During a recent
project it was necessary to convert a small but significant
amount of demonstration data from Oracle to Gupta's SQLBase. As
far as I could tell, Oracle Corporation provided only their
Export facility, and the limited powers of the SQL*Plus program
for data extraction (someone please correct me if I am wrong, it
will save me a lot of wasted time). Gupta provides import
capabilities for comma-delimited ASCII, 123, or dBASE files.
Using SQL*Plus to create comma-delimited ASCII files seemed to be
the only answer, but when I started preparing SQL*Plus scripts to
convert over 100 tables, I quickly threw my arms up in exaspera-
tion. Thus was OraUnload born.
To ease my exasperation I crafted a program that unloaded a table
to comma-delimited ASCII. The extracted data loaded into SQLBase
perfectly! I later found this utility to be useful in creating
files to use in word processor mail merge facilities because
WordPerfect provides a conversion utility that will turn comma-
delimited ASCII to WP mail merge data. Afterwards I added fixed
field and dBASE III file extractions, and have subsequently
released the product. Since the program has not been thoroughly
tested under many conditions it has been marked as a Beta re-
lease.
I hope you find the program useful, and please send some feed-
back!
Bob McGowan
OraUnload 1.0 User Documentation 3
Summary of Features
-----------------------------------------------------------------
Summary of features for version 0.90ß (Feb. 14, 1992)
- Extracts data from Oracle tables to DOS files.
- Command line operation suitable for batch processing
- Creates comma-delimited, fixed field, or dBASE III files
- Protected mode operation provides access to more memory,
allowing the extraction of tables with many columns
Proposed features for version 1.00 (expected release April 1992)
- All reported bugs squashed (I hope)
- No password echo
Proposed features for version 1.10 (no release date yet)
- Ability to specify multiple tables to extract
- Script file execution similar to SQL*Loader
- Better support for LONG and LONG RAW columns
Proposed features for version 2.00 (no release date yet)
- More file formats (depending on user feedback)
- Ability to specify an SQL statement with joins to use for
extraction rather than unloading a single table at a time
RamSoft Solutions values user feedback. If you don't see a
feature that you think is essential, write a letter and let us
know. If your suggestion is used in a subsequent release you
will receive a free registered copy of OraUnload 1.0, with all
the requisite special pricing on future upgrades. Users that
submit bug reports for items not already corrected shall receive
the same benefits.
OraUnload 1.0 User Documentation 4
Usage
-----------------------------------------------------------------
The syntax for using OraUnload is:
ORAUNLD [argument=value] [...]
or
ORANULD [value] [...]
where "ORAUNLD" is the name of the program, "argument" is a
keyword that is recognized by the program, and "value" is a value
to be used for processing that particular keyword. Argu-
ment/value pairs can appear in any order on the command line, or
values can be supplied without arguments if they appear in the
order specified below. No spaces should separate the argument,
the equals ("=") sign, and the value. This command line format
is similar to Oracle's format for many of it's utilities, includ-
ing SQL*Loader.
The recognized arguments are, in the proper order:
userid This is the Oracle userid and password that is
necessary to connect to the database. If it is
omitted the program will prompt you for it. The
value passed can be a userid, a userid/password,
or a userid/password@server_name combination. See
your Oracle manuals for more information on this
subject.
Default: none
Required: no - will prompt
*Note: in Beta version 0.90ß the password will
echo on input if it is not provided on the command
line. This will be remedied by the time that the
production version 1.00 is released.
table The name of the table to unload. This must be a
table to which the userid specified in the previ-
ous argument has SELECT access granted. A view
can also be specified.
Default: none
Required: yes
file The name of the output file to create. This must
be a standard DOS file name, i.e. eight charac-
ters, dot, three characters. There are no default
file extensions, so remember to specify ".dbf"
OraUnload 1.0 User Documentation 5
when creating a dBASE III file. A fully qualified
DOS drive/path/filename can be specified.
Default: none
Required: yes
format The file format to create. The valid values are
"comma" for comma-delimited ASCII files, "fixed"
for fixed-field ASCII files, and "dbase" for dBASE
III format files. Comma-delimited files are for-
matted with each row followed by a carriage re-
turn/line feed (CRLF) pair and each column sepa-
rated by a comma. Character data is enclosed in
double quotes (") and numeric data is unenclosed
and appears in text format. Fixed field ASCII
files are also formatted with a CRLF following
each row, but the columns are not separated by a
delimiter nor enclosed in quotes. They are justi-
fied by the column widths specified in the Oracle
database, with character fields left-justified and
numeric fields right-justified as text.
Default: comma
Required: no - default processing as above
header Boolean to include a header line in comma-delimit-
ed files that shows the column order in the file.
Valid values are "yes" or "no". I originally
included this feature to verify proper operation
and was loathe to remove it when releasing this
product, so I included this keyword to turn the
header inclusion off. If user demand is great I
may remove the feature, or change the default
processing to "no".
Default: yes
Required: no - default processing as above.
Please note that this program is for use in Oracle's protected
mode, and therefore requires the Oracle Protected Mode Executive
(SQLPME) to be installed. See you Oracle installation manual for
particulars on SQLPME.
OraUnload 1.0 User Documentation 6
Error Messages
-----------------------------------------------------------------
Error connecting to Oracle
- The program had a problem connecting to the Oracle data-
base using the specified userid/password. An Oracle error
number and message will be displayed. Consult the Oracle
error messages manual for more information on the displayed
error.
No file name specified
- A file name must be specified on the OraUnload command
line. Use the "file" keyword or place the file name in the
correct position on the command line. See the "Usage"
section for more information.
Error creating output file [filename]
- The program had a problem opening a new file with the
specified file name. The file name should conform to DOS
conventions. If the program is being used on a network,
check to see if the current user has correct access rights.
No table name specified
- An Oracle table name accessible to the user must be speci-
fied on the OraUnload command line. Use the "table" keyword
or place the table name in the correct position on the
command line. See the "Usage" section for more information.
Error allocating select list
Out of memory for select list
- The program had a problem allocating enough memory to
retrieve data from the specified table. Make sure that you
have enough extended memory in your machine to accommodate
the table you are unloading. Check for a DYNAMIC_MEMORY
parameter in your CONFIG.ORA file.
Error preparing statement
Error declaring data cursor
Error opening data cursor
Error describing select list variables
Error closing data cursor
- These errors are the result of a problem communicating
with Oracle and will be accompanied by an Oracle error
number and message. Consult the Oracle error messages
manual for more information on the displayed error.
Error creating dBASE file
- The program had a problem creating the dBASE header and
field descriptions. See the file creation problem above.
OraUnload 1.0 User Documentation 7
Support
-----------------------------------------------------------------
OraUnload was written by R.A. McGowan of RamSoft Solutions.
Contact me at:
(201) 847-0743 Voice
(201) 729-2602 Chuck's Attempt BBS
70674, 3222 CompuServe
or write to:
RamSoft Solutions
637 Wyckoff Avenue
Suite 313
Wyckoff, NJ 07481
OraUnload 1.0 User Documentation 8
What to expect in future releases
-----------------------------------------------------------------
OraUnload in its current incarnation serves a limited purpose.
The program can only unload one table at a time, and it includes
all rows in the table. You can't specify select lists or joins.
These are items tht are being addressed for future releases of
OraUnload.
OraUnload runs only on the PC platform, though Oracle is present
on many. Although OraUnload is written in portable C, RamSoft
Solutions does not have access to all the hardware and operating
systems supported by Oracle. Users that would like to see Oracle
on other operating systems please contact RamSoft Solutions (see
the section title "Support" for methods of contact.
A script file system is needed to add maximum power and flexibil-
ity to OraUnload. You will be able to specify the columns you
want to unload from a table, and their output lengths and for-
mats. RamSoft Solutions will strive to make the script file
format similar to SQL*Loader's control file format to ease the
user learning curve.
If user demand warrants, more file formats will be added. Other
formats already slated for future releases include WordPerfect
mail merge and Lotus 123 formats. If you need a particular file
format a customized version of OraUnload can be created. Contact
RamSoft Solutions for details.
RamSoft Solutions has two other PC utilities for Oracle that are
currently under development. One is CTLMake, a full screen
program that aids in the creation of SQL*Loader control scripts
for fixed field ASCII data formats. Anyone loading fixed field
data by counting columns and creating scripts by hand will love
this utility. The other utility is OraView, an Oracle table
browser. This is a full screen application that will allow
"point and shoot" selection of tables from a user's catalog,
display table structure, and browse tables in an onscreen window,
with a full range of navigational controls.
OraUnload 1.0 User Documentation 9
What you get when you register
-----------------------------------------------------------------
The primary reward for registering OraUnload is peace of mind!
You will know that you have abided by the terms of the enclosed
license agreement and have fostered the spread of the distribu-
tion channel known as Shareware. You will have taken a stand for
free enterprise and the American way of life!
But that's not all! Registering your copy of OraUnload will
include you on our list of customers entitled to pre-release
announcements about our software and special pricing on upgrades
of OraUnload and other RamSoft Solutions' products.
When you register OraUnload, you will receive a disk containing a
registered copy of OraUnload, with a serial number for you to use
when ordering upgrades. Only registered users are eligible for
end-user support, whether via voice, written letter or e-mail.
Unregistered users can write or leave a message on CompuServe,
and their requests will be answered as time permits.
OraUnload 1.0 User Documentation 10
Registration
-----------------------------------------------------------------
This program is not free! You are hereby licensed to use this
program for a trial period of 30 days free of charge. If, after
30 days, you decide that you would like to continue using Ora-
Unload, you must complete the registration form found on the next
page in this document and return it to the author with the
required registration fee enclosed.
Each registration is valid for use on a single CPU or on a single
BBS system, as described in the License Agreement.
The cost to register OraUnload is $75 U.S. which includes a disk
containing the program and a serial number. You may license
multiple copies of OraUnload with discounts as follows:
1 - 10 copies no discount
11 - 20 copies 10% discount
21 - 50 copies 15% discount
51 - 100 copies 20% discount
101 - 200 copies 30% discount
201+ copies 40% discount
All prices and discounts are subject to change without notice.
OraUnload 1.0 User Documentation 11
OraUnload Registration Form
Qty Item US Price
_______ OraUnload registration, including @ $75 ea $_______
program disk, manual, and serial
number.
Subtotal $_______
-Discount $(_____)
TOTAL $_______
Remit to:
RamSoft Solutions
637 Wyckoff Avenue
Suite 313
Wyckoff, NJ 07481
Name ________________________________________________________
Company ________________________________________________________
Address ________________________________________________________
________________________________________________________
________________________________________________________
Phone Voice_______________________ Fax _____________________
Comments ________________________________________________________
OraUnload 1.0 User Documentation 12
Thanks
-----------------------------------------------------------------
As with any product, OraUnload could not have been completed
without herculean efforts from many people. I would like to
thank all of them, and single out the following people for
special praise:
Laura McGowan
- my wife, without whose undying devotion and ludicrous
patience during countless all-nighters this project would
not have come to fruition.
Ted Bogusta
- my friend and marketing advisor, who agreed that this was
a viable idea in the first place.
Oracle Corp.
- for providing a C API in their product, and for not in-
cluding a utility like this one.
The Boston Beer Company
- for making Samuel Adams, the finest beer anywhere, without
which I would have never been able to reduce the stress
involved in bringing OraUnload to market.
This program is dedicated to the memory of Harry Summer.
OraUnload 1.0 User Documentation 13