EDB Postgres™ Advanced Server OCL Connector Guide OCL Connector Version 11.0.3.1 October 10, 2019 EDB Postgres™ Advanced Server OCL Connector Guide by EnterpriseDB® Corporation Copyright © 2007 - 2019 EnterpriseDB Corporation. All rights reserved. EnterpriseDB Corporation, 34 Crosby Drive, Suite 201, Bedford, MA 01730, USA T +1 781 357 3390 F +1 978 467 1307 E [email protected] www.enterprisedb.com EDB Postgres™ Advanced Server OCL Connector Guide Table of Contents 1 Introduction ............................................................................................................................................ 4 1.1 Typographical Conventions Used in this Guide ............................................................................. 5 1.2 What’s New .................................................................................................................................... 6 2 Requirements Overview ......................................................................................................................... 7 2.1 Supported Server Versions ............................................................................................................. 7 2.2 Supported Platforms ....................................................................................................................... 7 3 Open Client Library ................................................................................................................................ 8 3.1 Comparison with Oracle Call Interface .......................................................................................... 8 3.2 Installing and Configuring the OCL Connector.............................................................................. 9 3.2.1 Installing the Connector with an RPM Package ..................................................................... 9 3.2.1.1 Updating an RPM Installation...........................................................................................11 3.2.2 Installing the Connector on an SLES 12 Host .......................................................................12 3.2.3 Installing a DEB Package on a Debian or Ubuntu Host ........................................................14 3.2.4 Using the Graphical Installer to Install the Connector ...........................................................15 3.3 Forming a Connection String.........................................................................................................19 3.4 Compiling and Linking a Program ................................................................................................20 3.5 Ref Cursor Support ........................................................................................................................22 3.6 OCL Function Reference ...............................................................................................................25 3.6.1 Connect, Authorize and Initialize Functions .........................................................................25 3.6.1.1 Using the tnsnames.ora File ..............................................................................................25 3.6.2 Handle and Descriptor Functions ..........................................................................................26 3.6.2.1 EDB_ATTR_EMPTY_STRINGS ....................................................................................26 3.6.2.2 EDB_ATTR_HOLDABLE ...............................................................................................27 3.6.2.3 EDB_HOLD_CURSOR_ACTION ..................................................................................27 3.6.2.4 EDB_ATTR_STMT_LVL_TX ........................................................................................29 3.6.3 Bind, Define and Describe Functions ....................................................................................30 3.6.4 Statement Functions ..............................................................................................................30 3.6.5 Transaction Functions ............................................................................................................30 3.6.6 XA Functions .........................................................................................................................30 3.6.6.1 xaoSvcCtx .........................................................................................................................31 3.6.7 Date and Datetime Functions .................................................................................................31 3.6.8 Interval Functions ..................................................................................................................32 3.6.9 Number Functions .................................................................................................................33 3.6.10 String Functions .....................................................................................................................34 3.6.11 Cartridge Services and File I/O Interface Functions ..............................................................34 3.6.12 LOB Functions ......................................................................................................................34 3.6.13 Miscellaneous Functions .......................................................................................................35 3.6.14 Supported Data Types............................................................................................................35 3.7 OCL Error Codes – Reference .......................................................................................................37 4 Generating the OCL Trace ....................................................................................................................39 5 Using SSL..............................................................................................................................................40 Copyright © 2007 - 2019 EnterpriseDB Corporation. All rights reserved. 3 EDB Postgres™ Advanced Server OCL Connector Guide 1 Introduction The OCL connector provides an API similar to the Oracle Call Interface. Applications that are written to use the Oracle Call Interface may be recompiled using EnterpriseDB's OCL connector in order to interact with an Advanced Server database server. This guide provides installation and usage instructions: How to install the connector. How to form an Oracle style connection string. How to compile and link a program. This guide also includes a reference section for the functions supported by Advanced Server. Please note: EnterpriseDB does not support use of the Open Client Library with Oracle Real Application Clusters (RAC) and Oracle Exadata; the aforementioned Oracle products have not been evaluated nor certified with this EnterpriseDB product. Copyright © 2007 - 2019 EnterpriseDB Corporation. All rights reserved. 4 EDB Postgres™ Advanced Server OCL Connector Guide 1.1 Typographical Conventions Used in this Guide Certain typographical conventions are used in this manual to clarify the meaning and usage of various commands, statements, programs, examples, etc. This section provides a summary of these conventions. In the following descriptions a term refers to any word or group of words which may be language keywords, user-supplied values, literals, etc. A term’s exact meaning depends upon the context in which it is used. Italic font introduces a new term, typically, in the sentence that defines it for the first time. Fixed-width (mono-spaced) font is used for terms that must be given literally such as SQL commands, specific table and column names used in the examples, programming language keywords, etc. For example, SELECT * FROM emp; Italic fixed-width font is used for terms for which the user must substitute values in actual usage. For example, DELETE FROM table_name; A vertical pipe | denotes a choice between the terms on either side of the pipe. A vertical pipe is used to separate two or more alternative terms within square brackets (optional choices) or braces (one mandatory choice). Square brackets [ ] denote that one or none of the enclosed term(s) may be substituted. For example, [ a | b ], means choose one of “a” or “b” or neither of the two. Braces {} denote that exactly one of the enclosed alternatives must be specified. For example, { a | b }, means exactly one of “a” or “b” must be specified. Ellipses ... denote that the proceeding term may be repeated. For example, [ a | b ] ... means that you may have the sequence, “b a a b a”. Copyright © 2007 - 2019 EnterpriseDB Corporation. All rights reserved. 5 EDB Postgres™ Advanced Server OCL Connector Guide 1.2 What’s New The following features are added to create Advanced Server OCL Connector 11.0.3.1: The Advanced Server OCL Connector now provides SSL connection support for EDB Postgres Advanced Server. Copyright © 2007 - 2019 EnterpriseDB Corporation. All rights reserved. 6 EDB Postgres™ Advanced Server OCL Connector Guide 2 Requirements Overview The following section details the supported platforms for the Advanced Server OCL Connector. 2.1 Supported Server Versions The Advanced Server OCL Connector is certified with Advanced Server version 9.4 and above. 2.2 Supported Platforms The Advanced Server OCL Connector native packages are supported on the following platforms: 64 bit Linux: Red Hat Enterprise Linux (x86_64) 6.x and 7.x CentOS (x86_64) 6.x and 7.x OEL Linux 6.x and 7.x PPC-LE