The Open Client Embedded SQL/COBOL Programmers Guide explains how to use Embedded SQL™ and the Embedded SQL precompiler with COBOL applications. Embedded SQL is a superset of Transact-SQL® that lets you place Transact-SQL statements in application programs written in languages such as COBOL and C.
The information in this guide is platform-independent. For platform-specific instructions on using Embedded SQL, see the Open Client and Open Server Programmer’s Supplement.
This guide is intended for application developers and others interested in Embedded SQL concepts and uses. To use this guide, you should:
Be familiar with the information in the Adaptive Server Enterprise Reference Manual
Have COBOL programming experience
The first two chapters of this guide are introductory. If you are an experienced Embedded SQL user, you may go directly to Chapter 3, “Communicating with Adaptive Server.” The manual is organized as follows:
Chapter 1, “Introduction,” presents a brief overview of Embedded SQL and describes its advantages and capabilities.
Chapter 2, “General Information,” describes the tasks of an Embedded SQL program and provides general rules for programming with Embedded SQL.
Chapter 3, “Communicating with Adaptive Server,” describes how to establish and use a communication area with SQLCA, SQLCODE, and SQLSTATE. This chapter also describes the system variables used in the communication area.
Chapter 4, “Using Variables,” explains how to declare and use host and indicator variables in Embedded SQL. This chapter also describes arrays and explains datatype conversions.
Chapter 5, “Connecting to Adaptive Server,” explains how to use Embedded SQL to connect an application program to Adaptive Server® Enterprise (called “SQL Server” in versions prior to 11.5), and data servers in general.
Chapter 6, “Using Transact-SQL Statements,” describes how to use Transact-SQL in an Embedded SQL application program. This chapter describes how to select rows using arrays and batches, and how to group Transact-SQL statements.
Chapter 7, “Using Dynamic SQL,” describes how to create Embedded SQL statements that your application’s users can enter interactively at runtime.
Chapter 8, “Handling Errors,” describes return codes and the Embedded SQL precompiler’s facilities for detecting and handling errors.
Chapter 9, “Embedded SQL Statements: Reference Pages,” provides a reference page for each Embedded SQL statement.
Chapter 10, “Open Client/Server Configuration File,” describes the use of an external configuration file with Embedded SQL.
Appendix A, “Precompiler Warning and Error Messages,” lists precompiler and runtime messages.
The Glossary defines many of the terms used in this manual.
This guide is one of several manuals you will need to have a complete understanding of Embedded SQL and the Embedded SQL precompiler with COBOL applications. Following is a list of the other manuals you may need to consult.
The Open Server and SDK New Features for Microsoft Windows, Linux, and UNIX, which describes new features available for Open Server and the Software Developer’s Kit. This document is revised to include new features as they become available.
Adaptive Server Enterprise Reference Manual
Open Client Client-Library/C Reference Manual
Software Developer’s Kit and Open Server Installation Guide
Open Client Embedded SQL/C Programmers Guide
Open Client and Open Server Programmer’s Supplement
Use the Sybase Getting Started CD, the SyBooks CD, and the Sybase Product Manuals Web site to learn more about your product:
The Getting Started CD contains release bulletins and installation guides in PDF format, and may also contain other documents or updated information not included on the SyBooks CD. It is included with your software. To read or print documents on the Getting Started CD, you need Adobe Acrobat Reader, which you can download at no charge from the Adobe Web site using a link provided on the CD.
The SyBooks CD contains product manuals and is included with your software. The Eclipse-based SyBooks browser allows you to access the manuals in an easy-to-use, HTML-based format.
Some documentation may be provided in PDF format, which you can access through the PDF directory on the SyBooks CD. To read or print the PDF files, you need Adobe Acrobat Reader.
Refer to the SyBooks Installation Guide on the Getting Started CD, or the README.txt file on the SyBooks CD for instructions on installing and starting SyBooks.
The Sybase Product Manuals Web site is an online version of the SyBooks CD that you can access using a standard Web browser. In addition to product manuals, you will find links to EBFs/Maintenance, Technical Documents, Case Management, Solved Cases, newsgroups, and the Sybase Developer Network.
To access the Sybase Product Manuals Web site, go to Product Manuals.
Technical documentation at the Sybase Web site is updated frequently.
Finding the latest information on product certifications
Point your Web browser to Technical Documents.
Click Certification Report.
In the Certification Report filter select a product, platform, and timeframe and then click Go.
Click a Certification Report title to display the report.
Finding the latest information on component certifications
Point your Web browser to Availability and Certification Reports.
Either select the product family and product under Search by Base Product; or select the platform and product under Search by Platform.
Select Search to display the availability and certification report for the selection.
Creating a personalized view of the Sybase Web
site (including support pages)
Set up a MySybase profile. MySybase is a free service that allows you to create a personalized view of Sybase Web pages.
Point your Web browser to Technical Documents.
Click MySybase and create a MySybase profile.
Finding the latest information on EBFs and software
maintenance
Point your Web browser to the Sybase Support Page.
Select EBFs/Maintenance. If prompted, enter your MySybase user name and password.
Select a product.
Specify a time frame and click Go. A list of EBF/Maintenance releases is displayed.
Padlock icons indicate that you do not have download authorization for certain EBF/Maintenance releases because you are not registered as a Technical Support Contact. If you have not registered, but have valid information provided by your Sybase representative or through your support contract, click Edit Roles to add the “Technical Support Contact” role to your MySybase profile.
Click the Info icon to display the EBF/Maintenance report, or click the product description to download the software.
Key |
Definition |
|---|---|
command |
Command names, command option names, utility names, utility flags, and other keywords are in sans serif font. |
variable |
Variables, or words that stand for values that you fill in, are in italics. |
{ }
|
Curly braces indicate that you choose at least one of the enclosed options. Do not include braces in your option. |
[ ] |
Brackets mean choosing one or more of the enclosed items is optional. Do not include brackets in your option. |
( ) |
Parentheses are to be typed as part of the command. |
| |
The vertical bar means you can select only one of the options shown. |
, |
The comma means you can choose as many of the options shown as you like, separating your choices with commas to be typed as part of the command. |
Embedded SQL keywords
are not case sensitive. You can enter them in uppercase, lowercase,
or mixed case. This guide lists Embedded SQL keywords
in lowercase.
This distinguishes Embedded SQL statements from COBOL commands, which this guide shows in upper case. For example:
DISPLAY "PLEASE ENTER USER-ID".
If you have access to Adaptive Server release 10.0 or later, you can use sp_syntax, a system procedure, to retrieve the syntax of Embedded SQL statements. For information on how to install sp_syntax, see the System Administration Guide. For information on how to run sp_syntax, see sp_syntax in the Adaptive Server Enterprise Reference Manual.
When using sp_syntax to
retrieve a statement’s syntax, enclose the procedure name
in quotation marks. For example, to get a display of the syntax for
the exec sql statement, enter this
command:
sp_syntax “exec sql”
This document is available in an HTML version that is specialized for accessibility. You can navigate the HTML with an adaptive technology such as a screen reader, or view it with a screen enlarger.
Open Client and Open Server documentation has been tested for compliance with U.S. government Section 508 Accessibility requirements. Documents that comply with Section 508 generally also meet non-U.S. accessibility guidelines, such as the World Wide Web Consortium (W3C) guidelines for Web sites.
You might need to configure your accessibility tool
for optimal use. Some screen readers pronounce text based on its
case; for example, they pronounce ALL UPPERCASE TEXT as initials,
and MixedCase Text as words. You might find it helpful to configure
your tool to announce syntax conventions. Consult the documentation
for your tool.
For information about how Sybase supports accessibility, see Sybase Accessibility. The Sybase Accessibility site includes links to information on Section 508 and W3C standards.
Each Sybase installation that has purchased a support contract has one or more designated people who are authorized to contact Sybase Technical Support. If you cannot resolve a problem using the manuals or online help, please have the designated person contact Sybase Technical Support or the Sybase subsidiary in your area.
