J on Emmons Shell Scripting for the Oracle Professional

Shell Scripting for the

Oracle Professional
J on Emmons
Oracle Consultant
Author
J on Emmons Shell Scripting for the Oracle Professional
My Background
Undergraduate Computer Science
coursework.
Extensive experience in Solaris and Linux
system administration.
Oracle Database Administration on
versions 8.0 through 10gR2.
As a consultant I must build efficient, low-
to no-maintenance scripts for a variaety of
purposes.
J on Emmons Shell Scripting for the Oracle Professional
Books by J on Emmons
Oracle Shell Scripting: Linux &
Unix Programming for Oracle
On shelves this summer
Pre-order at rampant-books.com
Easy Linux Commands: Working
Examples of Linux Command Syntax
Available Today at Bookstores
and at rampant-books.com
J on Emmons Shell Scripting for the Oracle Professional
LifeAfterCoffee.com
J on Emmons Shell Scripting for the Oracle Professional
WARNING:
There are no one size fits all solutions. You must
evaluate any techniques or solutions based on your
environments and goals
Always test any solution in a non-production
environment before applying it to a production system.
Make sure you completely understand new commands
and techniques before applying them in your
environment.
You have been warned!
J on Emmons Shell Scripting for the Oracle Professional
Topics
When to script
Scripting Basics
The Oracle connection
Some useful tricks
Troubleshooting
Some Scripts
J on Emmons Shell Scripting for the Oracle Professional
When to Script
J on Emmons Shell Scripting for the Oracle Professional
When To Scripts
Shell scripting can be applied to a wide
variety of system and database tasks.
Though called scripting this is
programming, but dont let that scare you.
Be careful of script bloat. Be sensitive to
your coworkers and your possible
replacement.
J on Emmons Shell Scripting for the Oracle Professional
Repeated Tasks
Necessity is the mother of invention. The
first candidates for shell scripts will be
manual tasks which are done on a regular
basis.
Backups
Log monitoring
Check disk space
J on Emmons Shell Scripting for the Oracle Professional
Occasional Tasks
Tasks which are performed rarely enough
that their method, or even their need may
be forgotten.
Periodic business related reports
(monthly/quarterly/yearly)
Offsite backups
Purging old data
J on Emmons Shell Scripting for the Oracle Professional
Complex Manual Tasks
Some tasks must be performed manually
but may be aided by scripting.
Checking for database locks
Killing runaway processes
These tasks may evolve into repeated tasks
J on Emmons Shell Scripting for the Oracle Professional
Helper Scripts
Dont ignore the usefulness of helper
scripts. Perhaps a system administrator
really does need to look over the log for a
system daily, but a script can help by
automatically sending it on to him!
J on Emmons Shell Scripting for the Oracle Professional
Special Tasks
These are tasks which would not be
possible without a programming language.
Storing OS information (performance
stats, disk usage, etc.) into the database
High frequency monitoring (several times
a day or more)
J on Emmons Shell Scripting for the Oracle Professional
Scripting Basics
J on Emmons Shell Scripting for the Oracle Professional
Before You Start Scripting
You will find shell scripting an iterative process, but it is
best to have a good idea of your goals when you start.
What are you trying to accomplish
What are the dependencies
Which dependencies can we check first
Which dependencies cannot be checked
How broad will the effects of this script be
What happens if any step fails
Should the script continue or be halted
What results or output do we want from the script
Who should be notified of the results and how
What cleanup should be done when the script is complete
What if two copies of the script get executed simultaneously
J on Emmons Shell Scripting for the Oracle Professional
Scripting Tools
Any plain text editor will work.
vi (Command line UNIX)
Notepad (Windows)
TextEdit (Mac OSX)
EditPlus (Windows, shareware, $30)
editplus.com
J on Emmons Shell Scripting for the Oracle Professional
The Shell
Shell scripting allows us to use commands
we already use at the command line.
This considerably eases the learning
curve.
We are familiar with the interactive mode of
the shell. Almost anything can be done in
a script which can be done at the
command line.
J on Emmons Shell Scripting for the Oracle Professional
Which Shell to Use
My preference is Bash (bash) because of its
ubiquity and compatibility with Bourne (sh).
Other common shells include:
C shell (csh)
Korn shell (ksh)
Z Shell (zsh)
It is important to pick a shell and stick with it. The
differences between shells are often small but
infuriating.
J on Emmons Shell Scripting for the Oracle Professional
The Anatomy of a Command
gr ep i l ocal host / et c/ host s
Command Option Arguments
Options change the behavior of a command
Arguments control what the command acts upon
J on Emmons Shell Scripting for the Oracle Professional
Variables
Variables are set using the = sign
ORACLE_SI D=oss
Variables and their contents are case sensitive, so
the variable ORACLE_SI D is different from the
variable or acl e_si d.
Shell variables are un-typed and may contain
integers or text.
Numbers with a decimal point will be treated as
text. (e.g. 3. 14)
J on Emmons Shell Scripting for the Oracle Professional
Variable Naming
Variables should have meaningful names
Variable names do not need to be short
All UPPER CASE typically indicates an
environmental variable
Local (script) variables are conventionally
all lowercase
Underscores (_) are best for separating
words in variable names
J on Emmons Shell Scripting for the Oracle Professional
Variable Scope
Variables will be available within the script
(or shell session) which sets them
By exporting variables they can be made
available to subsequently called scripts.
This is why we typically perform an
expor t ORACLE_SI D
after setting the variable.
Exporting is not necessary when variables
will only be used within the current script.
J on Emmons Shell Scripting for the Oracle Professional
Using Variables
The dollar sing ($) is used to retrieve the contents
of a variable.
$ echo $ORACLE_SID
oss
If you are trying to use a variable where it may be
surrounded by other letters you may need to
add curly braces {} around the name.
$ echo ${ORACLE_SID}_sid
oss_si d
J on Emmons Shell Scripting for the Oracle Professional
Comments and Whitespace
Anything appearing after a pound symbol
(#) on a line will be ignored.
Adding comments can aid troubleshooting
and future editing of the script.
Blank lines are ignored when a script is
executed.
Blank lines and other whitespace (tabs,
spaces) can be used to improve script
readability.
J on Emmons Shell Scripting for the Oracle Professional
A basic script
#! / bi n/ bash
echo " The cur r ent dat abase i s $ORACLE_SI D"
echo " The cur r ent r unni ng pr ocesses f or
$ORACLE_SI D ar e"
ps ef | gr ep $ORACLE_SI D
J on Emmons Shell Scripting for the Oracle Professional
A basic script
#! / bi n/ bash
echo " The cur r ent dat abase i s $ORACLE_SI D"
echo " The cur r ent r unni ng pr ocesses f or
$ORACLE_SI D ar e"
ps ef | gr ep $ORACLE_SI D
This first line indicates what
interpreter to use when running
this script
J on Emmons Shell Scripting for the Oracle Professional
A basic script
#! / bi n/ bash
echo " The cur r ent dat abase i s $ORACLE_SI D"
echo " The cur r ent r unni ng pr ocesses f or
$ORACLE_SI D ar e"
ps ef | gr ep $ORACLE_SI D
Whitespace is used to
separate commands to
improve readability.
J on Emmons Shell Scripting for the Oracle Professional
A basic script
#! / bi n/ bash
echo " The cur r ent dat abase i s $ORACLE_SI D"
echo " The cur r ent r unni ng pr ocesses f or
$ORACLE_SI D ar e"
ps ef | gr ep $ORACLE_SI D
Variables referenced here
must have already been
set and exported.
J on Emmons Shell Scripting for the Oracle Professional
A basic script
#! / bi n/ bash
echo " The cur r ent dat abase i s $ORACLE_SI D"
echo " The cur r ent r unni ng pr ocesses f or
$ORACLE_SI D ar e"
ps ef | gr ep $ORACLE_SI D
Note the variable being
used as an argument.
We'll see a lot of this.
J on Emmons Shell Scripting for the Oracle Professional
The Shebang ( #! )
The "shebang" is a special comment. Since
it is a comment it will not be executed
when the script is run. Instead before the
script is run, the shell calling the script will
check for the #! pattern. If found it will
invoke the script using that interpreter.
If no #! is found most shells will use the
current shell to run the script.
J on Emmons Shell Scripting for the Oracle Professional
The Shebang (cont)
Since the shells are installed in different locations
on different systems you may have to alter the
#! line. For example, the bash shell may be in
/ bi n/ bash, / usr / bi n/ bash or
/ usr / l ocal / bi n/ bash.
Setting the shell explicitly like this assures that the
script will be run with the same interpreter
regardless of who executes it (or what their
default shell may be.)
J on Emmons Shell Scripting for the Oracle Professional
Script Naming
Descriptive names are important.
Use full words
Separate words with underscores
Avoid using spaces or other unusual characters
There is no requirement for script names, but
typically they will end in . sh
Talk with others at your site who are doing shell
scripting and try to agree on a convention.
J on Emmons Shell Scripting for the Oracle Professional
Script Permissions
The execute permission must be turned on before
a script can be executed. It can be turned on
for the user (u), group (g) or all users (o) by
using the chmod command.
chmod ugo+x t est _scr i pt . sh
If execute has not been granted you will get an
error like this:
- bash: . / t est _scr i pt . sh: Per mi ssi on deni ed
J on Emmons Shell Scripting for the Oracle Professional
status.sh
#! / bi n/ sh
# Show t he user and host name
echo " Hel l o $USER! "
echo " Wel come t o `host name`"
echo " - - - Cur r ent Di sk Usage - - - "
df - h
# On some syst ems t he - h ( human r eadabl e) opt i on wi l l not wor k wi t h df
# I n t hat case you can use t he - k opt i on t o di spl ay out put i n ki l l obyt es
echo " - - - Cur r ent upt i me, user s and l oad aver ages - - - "
upt i me
echo " - - - Load aver age number s r epr esent t he 1, 5 and 15 mi nut e l oad
aver ages - - - "
echo " - - - Lower number s ar e bet t er f or l oad aver ages - - - "
# These ar e t he f i r st t wo t hi ngs I check when I t hi nk t her e i s a pr obl em
# wi t h a syst em, but I ' msur e you can t hi nk of some ot her t hi ngs t o add
her e
J on Emmons Shell Scripting for the Oracle Professional
status.sh
#! / bi n/ sh
# Show t he user and host name
echo " Hel l o $USER! "
echo " Wel come t o `host name`"
echo " - - - Cur r ent Di sk Usage - - - "
df - h
# On some syst ems t he - h ( human r eadabl e) opt i on wi l l not wor k wi t h df
# I n t hat case you can use t he - k opt i on t o di spl ay out put i n ki l l obyt es
echo " - - - Cur r ent upt i me, user s and l oad aver ages - - - "
upt i me
echo " - - - Load aver age number s r epr esent t he 1, 5 and 15 mi nut e l oad
aver ages - - - "
echo " - - - Lower number s ar e bet t er f or l oad aver ages - - - "
# These ar e t he f i r st t wo t hi ngs I check when I t hi nk t her e i s a pr obl em
# wi t h a syst em, but I ' msur e you can t hi nk of some ot her t hi ngs t o add
her e
This output will help
the user identify what
they are looking at.
This comment explains the
command option used and
how it may need to be
changed on some systems.
J on Emmons Shell Scripting for the Oracle Professional
status.sh Usage
$ . / st at us. sh
Hel l o or acl e!
Wel come t o gl onk
- - - Cur r ent Di sk Usage - - -
Fi l esyst em Si ze Used Avai l Use%Mount ed on
/ dev/ mapper / Vol Gr oup00- LogVol 00
72G 6. 5G 61G 10%/
/ dev/ hda1 99M 9. 8M 84M 11%/ boot
/ dev/ shm 252M 0 252M 0%/ dev/ shm
- - - Cur r ent upt i me, user s and l oad aver ages - - -
19: 17: 41 up 10 days, 6: 02, 2 user s, l oad aver age:
0. 00, 0. 02, 0. 00
- - - Load aver age number s r epr esent t he 1, 5 and 15 mi nut e
l oad aver ages - - -
- - - Lower number s ar e bet t er f or l oad aver ages - - -
This additional output provides
very useful information on the
results we're looking at.
J on Emmons Shell Scripting for the Oracle Professional
Basic Script Setup
Make a plan!
Create a new text file
Specify the interpreter to be used (#! )
Set variables using =
Retrieve variable contents using $
Add {} around variable name if necessary
Use comments (#) and whitespace (blank lines,
spaces and tabs) to improve readability
Grant execute permissions to the appropriate
users with chmod
J on Emmons Shell Scripting for the Oracle Professional
Running Your Script
If the proper execute permissions have
been applied:
. / t est _scr i pt . sh
/ home/ or acl e/ t est _scr i pt . sh
If . is in your $PATH variable
t est _scr i pt . sh
J on Emmons Shell Scripting for the Oracle Professional
Keeping Your Scripts Organized
Work with sysadmins and DBAs to come
up with a convention
Development should be done in an area
away from production scripts
Scripts for a specific database in
/ u01/ app/ or acl e/ admi n/ sid/ scr i pt s
Scripts used on multiple databases in
/ u01/ app/ or acl e/ admi n/ common/ scr i pt s
J on Emmons Shell Scripting for the Oracle Professional
Break
J on Emmons Shell Scripting for the Oracle Professional
Decisions and Loops
J on Emmons Shell Scripting for the Oracle Professional
The if Statement
The simplest flow control statement is the
i f statement.
$ age=29
$ if [ $age -lt 30 ]
> then
> echo "You're still under 30"
> fi
You' r e st i l l under 30
J on Emmons Shell Scripting for the Oracle Professional
The if Statement
The simplest flow control statement is the
i f statement.
$ age=29
$ if [ $age -lt 30 ]
> then
> echo "You're still under 30"
> fi
You' r e st i l l under 30
Note that the end of an if
statement is indicated by
the keyword fi
J on Emmons Shell Scripting for the Oracle Professional
if, elseif and else
#! / bi n/ sh
age=39
i f [ $age - l t 30 ]
t hen
echo " You' r e st i l l under 30"
el i f [ $age - ge 30 - a $age - l e 40 ]
t hen
echo " You' r e i n your 30s"
el se
echo " You' r e 40 or over "
f i
J on Emmons Shell Scripting for the Oracle Professional
if, elseif and else
#! / bi n/ sh
age=39
i f [ $age - l t 30 ]
t hen
echo " You' r e st i l l under 30"
el i f [ $age - ge 30 - a $age - l e 40 ]
t hen
echo " You' r e i n your 30s"
el se
echo " You' r e 40 or over "
f i
Initially this condition is
checked and, if true, the code
in the t hen section executed
J on Emmons Shell Scripting for the Oracle Professional
if, elif and else
#! / bi n/ sh
age=39
i f [ $age - l t 30 ]
t hen
echo " You' r e st i l l under 30"
el i f [ $age - ge 30 - a $age - l e 40 ]
t hen
echo " You' r e i n your 30s"
el se
echo " You' r e 40 or over "
f i
Only if the initial condition has
failed will the elif be
considered
J on Emmons Shell Scripting for the Oracle Professional
if, elif and else
#! / bi n/ sh
age=39
i f [ $age - l t 30 ]
t hen
echo " You' r e st i l l under 30"
el i f [ $age - ge 30 - a $age - l e 40 ]
t hen
echo " You' r e i n your 30s"
el se
echo " You' r e 40 or over "
f i
Finally if the if condition and
all elif conditions have failed
the else, if present, will be
executed
J on Emmons Shell Scripting for the Oracle Professional
if, elif and else
Conditional statements can compare numbers
or text
An i f statement will need to have a t hen and
an f i to indicate the end of the statement
An i f statement can have one or more el i f
statements or may have none
An i f statement may have one el se statement
but may have no el se statement
Only one section of code will be executed
J on Emmons Shell Scripting for the Oracle Professional
Mathematical Comparators
J on Emmons Shell Scripting for the Oracle Professional
String Comparators
J on Emmons Shell Scripting for the Oracle Professional
Comparing Strings
$ if [ $ORACLE_SID = "oss" ]
> then
> echo "Using the sid for the Oracle Shell
Scripting database"
> fi
Usi ng t he si d f or t he Or acl e Shel l Scr i pt i ng
dat abase
J on Emmons Shell Scripting for the Oracle Professional
Checking Variables
$ if [ $ORACLE_SID ]
> then
> echo "ORACLE_SID variable is set to $ORACLE_SID"
> fi
ORACLE_SI D var i abl e i s set t o oss
This statement checks to see if the variable
$ORACLE_SI D has been set.
The statement will fail if the variable has not
been set, or if it is set to a null value.
J on Emmons Shell Scripting for the Oracle Professional
File Comparators
J on Emmons Shell Scripting for the Oracle Professional
Checking Files
$ if [ -e
$ORACLE_HOME/dbs/init$ORACLE_SID.ora ]
> then
> echo "An init file exists for the
database $ORACLE_SID"
> fi
An i ni t f i l e exi st s f or t he dat abase oss
J on Emmons Shell Scripting for the Oracle Professional
Complex Comparisons
J on Emmons Shell Scripting for the Oracle Professional
Checking Multiple Files
$ if [ -e $ORACLE_HOME/dbs/init$ORACLE_SID.ora -a -e \
> $ORACLE_HOME/dbs/spfile$ORACLE_SID.ora ]
> then
> echo "We seem to have both an spfile and an init file"
> fi
We seemt o have bot h an spf i l e and an i ni t f i l e
J on Emmons Shell Scripting for the Oracle Professional
Case Statement
#! / bi n/ sh
case $ORACLE_SI D
i n
oss)
echo " Usi ng t he si d f or t he Or acl e Shel l
Scr i pt i ng dat abase"
; ;
db1)
echo " Usi ng t he def aul t Or acl e dat abase"
; ;
*)
echo " I don' t have a descr i pt i on f or t hi s
dat abase"
; ;
esac
J on Emmons Shell Scripting for the Oracle Professional
Case Statement
#! / bi n/ sh
case $ORACLE_SI D
i n
oss)
echo " Usi ng t he si d f or t he Or acl e Shel l
Scr i pt i ng dat abase"
; ;
db1)
echo " Usi ng t he def aul t Or acl e dat abase"
; ;
*)
echo " I don' t have a descr i pt i on f or t hi s
dat abase"
; ;
esac
The beginning of a case
statement is indicated by the
case keyword. The end is
indicated by case spelled
backwards
J on Emmons Shell Scripting for the Oracle Professional
Case Statement
#! / bi n/ sh
case $ORACLE_SI D
i n
oss)
echo " Usi ng t he si d f or t he Or acl e Shel l
Scr i pt i ng dat abase"
; ;
db1)
echo " Usi ng t he def aul t Or acl e dat abase"
; ;
*)
echo " I don' t have a descr i pt i on f or t hi s
dat abase"
; ;
esac
The input given at the
beginning will be compared to
each value in the list
The asterisk is a
wildcard and will
match any string
The code to be executed for each option is
terminated by a double semicolon.
J on Emmons Shell Scripting for the Oracle Professional
Case Statement
The code following the first matching option will
be executed.
If no match is found the script will continue on
after the esac statement without executing any
code.
Some wildcards and regular expressions can be
used.
A case could be rewritten as a series of el i f
statements but a case is typically more easily
understood.
J on Emmons Shell Scripting for the Oracle Professional
The while Loop
The whi l e loop will repeat a chunk of code as
long as the given condition is true.
#! / bi n/ sh
i =1
whi l e [ $i - l e 10 ]
do
echo " The cur r ent val ue of i i s $i "
i =`expr $i + 1`
done
J on Emmons Shell Scripting for the Oracle Professional
The while Loop
#! / bi n/ sh
i =1
whi l e [ $i - l e 10 ]
do
echo " The cur r ent val ue of i i s $i "
i =`expr $i + 1`
done
Make sure your loop variable is
initialized before the loop starts
Also makes sure that something will
eventually cause the while condition
to fail, otherwise you may end up in
an infinite loop!
J on Emmons Shell Scripting for the Oracle Professional
The for Loop
The for loop allows you to easily parse a set of values.
#! / bi n/ sh
count =0
f or i i n 2 4 6
do
echo " i i s $i "
count =`expr $count + 1`
done
echo " The l oop was execut ed $count t i mes"
J on Emmons Shell Scripting for the Oracle Professional
The for Loop
#! / bi n/ sh
count =0
f or i i n 2 4 6
do
echo " i i s $i "
count =`expr $count + 1`
done
echo " The l oop was execut ed $count
t i mes"
This for loop will be executed three
times, once with i=2, once with i=4
and once with i=6
J on Emmons Shell Scripting for the Oracle Professional
Breaking Out of the Current Loop
The br eak statement will cause the shell to stop executing the current loop
and continue on after its end.
#! / bi n/ sh
f i l es=`l s`
count =0
f or i i n $f i l es
do
count =`expr $count + 1`
i f [ $count - gt 100 ]
t hen
echo " Ther e ar e mor e t han 100 f i l es i n t he cur r ent
di r ect or y"
break
f i
done
J on Emmons Shell Scripting for the Oracle Professional
Prompting for User Input
For scripts which will be run interactively we
can prompt the user to give us input.
The r ead command can be used to set a
variable with a value read from user input.
#! / bi n/ sh
echo " Ent er your name"
r ead name
echo " Hi $name. I hope you l i ke t hi s scr i pt "
J on Emmons Shell Scripting for the Oracle Professional
Prompting for User Input
$ ./welcome.sh
Ent er your name
Jon
Hi J on. I hope you l i ke t hi s scr i pt
Note that the text input will be displayed on the
screen. If you do not want the input displayed
(like when accepting a password) use the - s
option for the r ead command.
J on Emmons Shell Scripting for the Oracle Professional
Using Arguments
Accepting arguments to your script can allow you
to make a script more flexible.
The variables $1, $2, $3 etc. refer to the
arguments given in order.
The variable $@ refers to the complete string of
arguments.
The variable $#will give the number of arguments
given.
J on Emmons Shell Scripting for the Oracle Professional
Using Arguments
i f [ $1 ]
t hen
ORACLE_SI D=$1
ORAENV_ASK=NO
. or aenv
el se
i f [ ! $ORACLE_SI D ]
t hen
echo " Er r or : No ORACLE_SI D set or pr ovi ded as
an ar gument "
exi t 1
f i
f i
J on Emmons Shell Scripting for the Oracle Professional
Using Arguments
i f [ $1 ]
t hen
ORACLE_SI D=$1
ORAENV_ASK=NO
. or aenv
el se
i f [ ! $ORACLE_SI D ]
t hen
echo " Er r or : No ORACLE_SI D set or pr ovi ded as
an ar gument "
exi t 1
f i
f i
Check to see if an argument was given
If it was, we will use it to set the
ORACLE_SID variable then
execute oraenv
J on Emmons Shell Scripting for the Oracle Professional
The Oracle Connection
J on Emmons Shell Scripting for the Oracle Professional
Calling SQL Scripts
from Shell Scripts
SQL*Plus can be called within shell
scripts like any other command.
A username and password can be
provided to avoid being prompted for
them.
A SQL script can be provided as an
argument.
The - S option can be used to suppress
the SQL*Plus banner and prompts.
J on Emmons Shell Scripting for the Oracle Professional
Calling a SQL Script
#! / bi n/ sh
sql pl us - S syst em/ manager @dat abase_st at us. sql
This short script will allow you to easily execute a
SQL script with given permissions
Warning: Calling sqlplus in this manner may
expose your username and password to
others on the system!
Warning: Files which contain usernames
and passwords must be properly secured to
avoid exposing the passwords!
J on Emmons Shell Scripting for the Oracle Professional
Getting Past the
Password Problems
A combination of two methods can be used to get
around the password problems with the
previous method.
Place the password in a variable so it will not
display in a process listing.
Rather than placing the password in the shell
script store it in a separate, secure file.
J on Emmons Shell Scripting for the Oracle Professional
Placing the Password in a Variable
#! / bi n/ sh
syst em_pw=manager
sql pl us - S syst em/ $syst em_pw @dat abase_st at us. sql
When this command is running a process listing
(ps) will show the variable name ($syst em_pw)
instead of the password.
J on Emmons Shell Scripting for the Oracle Professional
Reading the Password from a
Secure File
#! / bi n/ sh
syst em_pw=`cat
/ u01/ app/ or acl e/ admi n/ oss/ pw/ syst em. pw`
sql pl us - S syst em/ $syst em_pw @dat abase_st at us. sql
By reading the password from a text file the script
is no longer required to have the password
embedded in it.
This has the added advantage of providing a
single location where passwords can be
changed for all scripts at once.
J on Emmons Shell Scripting for the Oracle Professional
Securing the Password Files
In order to keep the passwords secure the files
which contain them should have as restrictive
permissions as possible. Using the chmod
command we can grant the owner (typically the
oracle user) read and write permissions and
revoke all permissions for other users.
chmod u=r w, g=, o=
/ u01/ app/ or acl e/ admi n/ oss/ pw/ syst em. pw
J on Emmons Shell Scripting for the Oracle Professional
Using SQL Directly In Shell Scripts
By using file markers we can call SQL
directly from our shell scripts. This can
make scripts easier to move and maintain
as there is only one file to work with.
J on Emmons Shell Scripting for the Oracle Professional
#! / bi n/ sh
sql pl us - S syst em/ manager << EOF
set pagesi ze 0 l i nesi ze 80 f eedback of f
SELECT ' The dat abase ' | | i nst ance_name | |
' has been r unni ng si nce ' | |
t o_char ( st ar t up_t i me, ' HH24: MI MM/ DD/ YYYY' )
FROM v\ $i nst ance;
SELECT ' Ther e ar e ' | | count ( st at us) | |
' dat a f i l es wi t h a st at us of ' | | st at us
FROM dba_dat a_f i l es
GROUP BY st at us
ORDER BY st at us;
exi t ;
EOF
J on Emmons Shell Scripting for the Oracle Professional
Using File Markers
The shell will interpret everything that follows
<< EOF as input to the sqlplus command until it
encounters another EOF on its own line.
Multiple file markers can be used within the
same script but they will need to be unique!
Common file markers are EOF1, EOF2, etc. or
EOA, EOB, EOC etc.
File markers do not have to be all upper-case
but it does make them easier to spot in a script.
Be sure to provide appropriate commits!
J on Emmons Shell Scripting for the Oracle Professional
SQL Script Arguments
SQL scripts can accept arguments just like
shell scripts.
SQL script arguments are stored in the
variables &1, &2, etc.
SELECT user name, account _st at us,
expi r y_dat e
FROM dba_user s WHERE
l ower ( user name) =l ower ( ' &1' ) ;
J on Emmons Shell Scripting for the Oracle Professional
Shell Variables in Embedded SQL
When embedding SQL with file markers variables from the
shell script can be used inline.
#! / bi n/ sh
l ookup=$1
sql pl us - S syst em/ manager << EOF
SELECT user name, account _st at us,
expi r y_dat e
FROM dba_user s WHERE
l ower ( user name) =l ower ( ' $l ookup' ) ;
exi t ;
EOF
J on Emmons Shell Scripting for the Oracle Professional
Getting Information Out of
SQL*Plus
The output of sqlplus can be sent to a file on the system
for further processing.
Output is redirected with the > symbol.
When redirecting both input and output things can get
confusing.
sql pl us - S " / as sysdba" << EOF > $t empf i l e
It is easiest to look at this as two separate statements, the
redirection of input (<< EOF) and the redirection of the
output (> $t empf i l e).
Note that the output is being redirected to the file location
described by the t empf i l e variable.
J on Emmons Shell Scripting for the Oracle Professional
Getting Information Out of
SQL*Plus
#! / bi n/ bash
t empf i l e=/ t mp/ audi t _l ocked_account s_$ORACLE_SI D. t xt
# St ar t sql pl us and check f or l ocked account s
sql pl us - S " / as sysdba" << EOF > $t empf i l e
set pagesi ze
sel ect ' The f ol l owi ng account s wer e f ound t o be unl ocked and shoul d not
be'
f r omdual ;
def i ne exi t _st at us = 0
col umn xs new_val ue exi t _st at us
sel ect user name, account _st at us, 1 as xs f r omdba_user s
wher e account _st at us ! = ' LOCKED'
and user name i n ( ' HR' , ' SCOTT' , ' OUTLN' , ' MDSYS' , ' CTXSYS' ) ;
exi t &exi t _st at us
EOF
# I f t he exi t st at us of sql pl us was not 0 t hen we wi l l send an emai l
i f [ $? ! = 0 ]
t hen
mai l - s " Account s Unl ocked i n $ORACLE_SI D" or acl e < $t empf i l e
f i
J on Emmons Shell Scripting for the Oracle Professional
Manipulating Other Commands
These methods can also be applied with
RMAN for backup and recovery.
File markers can be used to emulate user
input for many (but not all) commands.
J on Emmons Shell Scripting for the Oracle Professional
Break
J on Emmons Shell Scripting for the Oracle Professional
Some Useful Tricks
J on Emmons Shell Scripting for the Oracle Professional
Escape Character
The escape character will prevent the shell from
interpreting the following character as anything
other than text.
Backslash (\ ) is the escape character in the Bash
shell.
Escaping special characters (such as * ' $ ;
and space) can help you get the output you
want and to handle special characters in file
names.
$ echo "The escape character in Bash is \"\\\""
The escape char act er i n Bash i s " \ "
J on Emmons Shell Scripting for the Oracle Professional
Single Quotes
Single quotes will cause all special
characters (except the single quote) to be
ignored.
$ echo 'In single quotes "double quotes",
$ and even ; are all safe'
I n si ngl e quot es " doubl e quot es" , $ and
even ; ar e al l saf e
J on Emmons Shell Scripting for the Oracle Professional
Double Quotes
Double quotes will cause most special
characters to be ignored.
Variables and back quotes will be expanded
and backslashes are interpreted as an
escape character.
$ echo "In double quotes we can use
variables like $ORACLE_SID"
I n doubl e quot es we can use var i abl es l i ke
oss
J on Emmons Shell Scripting for the Oracle Professional
Back Quotes
Text between back quotes (`) is executed as a
command and its output substituted in its place.
This allows us to concatenate command results
with text.
$ echo "The current date and time is
`date`"
The cur r ent dat e and t i me i s Sun May 6
23: 19: 55 EDT 2007
J on Emmons Shell Scripting for the Oracle Professional
Redirecting Output to a File
Output from commands can easily be
sent to a file instead of the display with a
> or >>
The > will replace the given file if it exists
but the >> will concatenate the output on
the end of the given file
Both the standard output and the error
output can be redirected to a file
J on Emmons Shell Scripting for the Oracle Professional
Redirecting Standard Output
$ ls
l og1. l og l og3. l og myf i l e. t xt sampl e. t xt
t ypes_of _uni x. t xt
l og2. l og mar x. t xt out put . t xt t est _scr i pt . sh
$ ls > listing.txt
$ more listing.txt
l i st i ng. t xt
l og1. l og
l og2. l og
l og3. l og
mar x. t xt
myf i l e. t xt
out put . t xt
sampl e. t xt
t est _scr i pt . sh
t ypes_of _uni x. t xt
J on Emmons Shell Scripting for the Oracle Professional
Redirecting Error Output
$ f i nd . / - name " *. t xt " >
t ext _f i l es. t xt 2>er r or s. t xt
While > or >> redirect standard output 2> or
2>> will redirect error output.
Standard or error output can be redirected
to /dev/null (2>/dev/null) to discard the
output
J on Emmons Shell Scripting for the Oracle Professional
Linking Output to Input
The pipe (| ) can be used to link the output
of one command to the input of another.
$ ps -ef | grep oss
or acl e 2684 1 0 14: 02 ? 00: 00: 00 or a_pmon_oss
or acl e 2686 1 0 14: 02 ? 00: 00: 00 or a_psp0_oss
or acl e 2688 1 0 14: 02 ? 00: 00: 00 or a_mman_oss
or acl e 2690 1 0 14: 02 ? 00: 00: 02 or a_dbw0_oss
or acl e 2692 1 0 14: 02 ? 00: 00: 03 or a_l gwr _oss
or acl e 2694 1 0 14: 02 ? 00: 00: 01 or a_ckpt _oss
or acl e 2696 1 0 14: 02 ? 00: 00: 06 or a_smon_oss
or acl e 2698 1 0 14: 02 ? 00: 00: 00 or a_r eco_oss
J on Emmons Shell Scripting for the Oracle Professional
Performing Math in the Shell
The expr command can be used to perform simple math in the
shell.
$ expr 2 + 7
9
$ expr 4 + 3 \* 3
13
$ expr 13 / 2
7
The asterisk is used for multiplication but must be escaped by a
backslash.
Results will be truncated to whole numbers.
J on Emmons Shell Scripting for the Oracle Professional
Sending Email
Sending email is simple!
Use -s to specify a subject line, give an
address as an argument (or list multiple
addresses in quotes and separated by
commas) and redirect a file into the
command.
mai l - s " Al er t l og f r om$ORACLE_SI D `host name`"
or acl e <
/ u01/ app/ or acl e/ admi n/ $ORACLE_SI D/ bdump/ al er t _$ORA
CLE_SI D. l og
J on Emmons Shell Scripting for the Oracle Professional
Scheduling with Cron
Repeated tasks may be scheduled with the
cr ont ab command.
cr ont ab - e will edit the current user's crontab
with the default editor.
Comments can be put into the crontab with the #.
# Weekl y f ul l hot backup
00 03 * * 0
/ u01/ app/ or acl e/ admi n/ common/ scr i pt s/ hot _backup. sh
oss 0
J on Emmons Shell Scripting for the Oracle Professional
Crontab entries are executed when all the
specified time conditions are met.*
00 03 * * 0 / u01/ app/ or acl e/ admi n/ com
This entry will be executed at 0 minutes
past the hour, the hour of 3(am), any day
of the month, any month of the year, but
only if it is Sunday.
J on Emmons Shell Scripting for the Oracle Professional
*On many platforms if the day of the week
and day of month/month of year are both
specified the job will be executed when
either condition is met.
So, the following job would run on the first
Sunday of the month on some platforms,
but on others would run every Sunday
and the 1
st
through 7
th
of each month.
00 03 1- 7 * 0
/ u01/ app/ or acl e/ admi n/ com
J on Emmons Shell Scripting for the Oracle Professional
Scheduling One-time Tasks with at
Use at for one-time tasks which need to be run
off-hours or at a specific time.
at can easily schedule jobs to run at a specific
time today, tomorrow, or on a specified date
and time.
J ust like with cron output from commands run with
at will be sent to the user via email. If you
would like an email when the job completes,
regardless of output just add the - mflag.
J on Emmons Shell Scripting for the Oracle Professional
Run an export at 11:30 pm today:
$ at 23:30
at >
/u01/app/oracle/admin/oss/scripts/full_exp
ort.sh
at > ctrl-d <EOT>
j ob 5 at 2007- 01- 21 23: 30
Run an export at 11:00 am tomorrow and email me when
complete:
$ at -m 11:00 tomorrow
at >
/u01/app/oracle/admin/oss/scripts/full_exp
ort.sh
at > ctrl-d <EOT>
j ob 6 at 2007- 01- 22 11: 00
J on Emmons Shell Scripting for the Oracle Professional
Managing at J obs
The atq command will list jobs in the at queue.
$ atq
6 2007- 01- 22 11: 00 a or acl e
5 2007- 01- 21 23: 30 a or acl e
To remove a job use atrm with the job number
from the queue.
$ atrm 6
J on Emmons Shell Scripting for the Oracle Professional
Troubleshooting Tips
J on Emmons Shell Scripting for the Oracle Professional
Determining where a
failure is happening
Add lines like echo " Compl et ed f i r st f or
l oop" or echo " About t o l aunch
sql pl us" to help pinpoint errors.
Echo count variables. echo " Loop
compl et ed t i me $i "
When you're done with these markers simply
comment them out with a pound rather than
removing them. You might need them again.
J on Emmons Shell Scripting for the Oracle Professional
Debug Mode
Running a script in debug mode will print each line
of the shell script (including comments) before it
is executed.
Enable debug mode by adding - v after the
interpreter listing at the shebang.
#! / bi n/ sh v
Leaving this mode on will generate a lot of output
and may expose passwords. Debug mode
should be enabled when needed and
immediately disabled when done.
J on Emmons Shell Scripting for the Oracle Professional
$ ./status.sh
#! / bi n/ bash - v
#
# st at us. sh scr i pt by J on Emmons
# Publ i shed i n Or acl e Shel l Scr i pt i ng, Rampant
TechPr ess, 2007
#
# A si mpl e scr i pt t o pr ovi de some i nf or mat i on about
t he syst em
# Show t he user and host name
echo " Hel l o $USER! "
Hel l o or acl e!
echo " Wel come t o `host name`"
host name
Wel come t o gl onk
echo " - - - Cur r ent Di sk Usage - - - "
- - - Cur r ent Di sk Usage - - -
df - h
J on Emmons Shell Scripting for the Oracle Professional
Show Commands After
Variable Substitution
Another option, - x, will show each command
once variables have been substituted in.
Debug output will appear with a + at the beginning
of each line.
This can help determine where problems are with
loops and i f statements.
- vx can be specified if both debug modes are
desired
Again, this mode should only be enabled when
needed.
J on Emmons Shell Scripting for the Oracle Professional
$ ./status.sh
+ echo ' Hel l o or acl e! '
Hel l o or acl e!
++ host name
+ echo ' Wel come t o gl onk'
Wel come t o gl onk
+ echo ' - - - Cur r ent Di sk Usage - - - '
- - - Cur r ent Di sk Usage - - -
+ df - h
Fi l esyst em Si ze Used Avai l Use%Mount ed
on
/ dev/ mapper / Vol Gr oup00- LogVol 00
72G 6. 6G 61G 10%/
/ dev/ hda1 99M 9. 8M 84M 11%/ boot
/ dev/ shm 252M 0 252M 0%/ dev/ shm
J on Emmons Shell Scripting for the Oracle Professional
Some Scripts
J on Emmons Shell Scripting for the Oracle Professional
Script Downloads
View scripts shown in this presentation at
http://www.lifeaftercoffee.com/presentation-scripts/
Password: luwak
J on Emmons Shell Scripting for the Oracle Professional
More Information
Oracle Shell Scripting: Linux &
UNIX Programming for Oracle
On shelves this summer.
Cover price $49.95
Buy for $34.95
Available at rampant-books.com
Get an extra %10 off with
coupon code thanks-gmoug
J on Emmons Shell Scripting for the Oracle Professional
More Information/Contact Me
www.lifeaftercoffee.com
J on Emmons Shell Scripting for the Oracle Professional
Thanks to
The Green Mountain Oracle User Group
Take an extra 10% off at rampant-books.com
with coupon code thanks-gmoug
Burleson Consulting
Rampant TechPress
J on Emmons Shell Scripting for the Oracle Professional