Plug-in Documentation

Sybase

 

Overview

The Sybase plugin provides steps to integrate with a Sybase Adaptive Server Enterprise relational database server.

This plug-in includes one step:

  • Run SQL Scripts

Compatibility

This plug-in requires IBM UrbanCode Deploy version 6.0 or later.

This plug-in runs on all operating systems that UrbanCode Deploy supports.

Installation

No special steps are required for installation. See Installing plug-ins in UrbanCode Deploy.

History

Version 6

Added support for Sybase source profile path with spaces in Linux.

Version 5

Added SYBASE environment script sourcing for Windows.

Version 4

Removed SYBASE Home field in favor of the SYBASE.sh Path to source the profile.

Version 3

RFE 135616 Added a property to set the SYBASE environment variable.

Version 2

Added failure property to determine what action to take on SQL errors.

Version 1

Initial release of the Sybase Plugin.

Steps

Process steps in the Sybase plug-in

Run SQL Scripts

Execute one or more SQL scripts on the server.

Input properties for the Run SQL Scripts step
Name Type Description Required
Additional Arguments String Specify any additional arguments to append to the isql utility.
Separate each argument by a new line.
No
Database String The name of the database in which the Isql session begins. Yes
Error Notification Enumeration:

  • fail
  • warn
  • failAfter
Select the action to take when a SQL file returns an error.
The default Fail On Error will fail the process immediately,
Warn On Error will only warn that an error occured, and Fail
After Errors will execute all SQL scripts and fail afterwards
if any errors occurred.
No
ISQL Path String The path to the isql command executable. Yes
Password Password The case-sensitive password to authenticate with Sybase. Yes
SQL Files String Specify either a list of SQL files separated by newlines,
or a control file containing files listed in the same format.
Note that any file without a .sql extension will be treated as
a control file.
Yes
SYBASE.sh Path String The path to your SYBASE profile (SYBASE.sh file). If specified,
this file will be sourced before executing SQL scripts. This is not
necessary if you source the file in your agent startup profile.
(E.G. /opt/sybase/SYBASE.sh)
No
Server Name String The name of the Adaptive Server in which to connect. If nothing
is specified, the default SYBASE server name will be used.
No
Username String The case-sensitive username to authenticate with Sybase. Yes