OCI Cartridge Functions

List of Examples
List of Figures
List of Tables
Title and Copyright Information
Preface
- Audience
- Documentation Accessibility
- Related Documents
- Conventions
Changes in This Release for Oracle Call Interface Programmer's Guide
- Changes in Oracle Database Release 19c Version 19.1
  - New Features
  - Other Changes
- Changes in Oracle Database Release 18c Version 18.1
  - New Features
  - Deprecated Features
1 OCI: Introduction
- 1.1 Overview of OCI
- 1.2 Building an OCI Application
- 1.3 Alternatives to OCI
- 1.4 SQL Statements
- 1.5 Procedural and Nonprocedural Elements
- 1.6 Object Support
- 1.7 Simple Oracle Document Access (SODA)
- 1.8 Encapsulated Interfaces
- 1.9 User Authentication and Password Management
- 1.10 Features to Improve Application Performance and Scalability
- 1.11 Oracle Database Advanced Queuing
- 1.12 XA Library Support
2 Oracle Instant Client and Oracle Instant Client Light
- 2.1 About Oracle Instant Client
- 2.2 Install from ZIP Files, from RPMs, and from Oracle Universal Installer
- 2.3 Environment Variables for Oracle Instant Client
- 2.4 Database Connection Strings for Oracle Instant Client
- 2.5 SDK for Oracle Instant Client
- 2.6 About Oracle Instant Client Light
- 2.7 About Patching Oracle Instant Client Shared Libraries on Linux or UNIX
- 2.8 Regeneration of Data Shared Library and Zip and RPM Files
3 Building and Configuring OCI Applications
- 3.1 Header File and Makefile Locations
- 3.2 Building an OCI Application on Linux and UNIX
  - 3.2.1 Oracle Directory Structure
  - 3.2.2 Demonstration OCI Programs
- 3.3 Building an Application on Windows
- 3.4 Database Connection Strings
  - 3.4.1 Examples of Oracle Database Connection String Connect Identifiers
- 3.5 Client and Server Operating with Different Versions of Time Zone Files
- 3.6 OCI Client-Side Deployment Parameters Using oraaccess.xml
- 3.7 About Compatibility and Upgrading
- 3.8 Fault Diagnosability in OCI
4 OCI Programming Basics
- 4.1 Overview of OCI Program Programming
- 4.2 OCI Data Structures
  - 4.2.1 Handles
- 4.3 OCI Programming Steps
- 4.4 Additional Coding Guidelines
- 4.5 About Using PL/SQL in an OCI Program
- 4.6 OCI Globalization Support
5 Data Types
- 5.1 Oracle Data Types
  - 5.1.1 About Using External Data Type Codes
- 5.2 Internal Data Types
- 5.3 External Data Types
- 5.4 Data Conversions
- 5.5 Typecodes
  - 5.5.1 Relationship Between SQLT and OCI_TYPECODE Values
- 5.6 Definitions in oratypes.h
6 Using SQL Statements in OCI
- 6.1 Overview of SQL Statement Processing
- 6.2 About Preparing Statements
  - 6.2.1 About Using Prepared Statements on Multiple Servers
- 6.3 About Binding Placeholders in OCI
  - 6.3.1 Rules for Placeholders
- 6.4 About Executing Statements
  - 6.4.1 Execution Snapshots
  - 6.4.2 Execution Modes of OCIStmtExecute()
    - 6.4.2.1 Using Batch Error Mode
    - 6.4.2.2 Example of Batch Error Mode
- 6.5 About Describing Select-List Items
  - 6.5.1 Implicit Describe
  - 6.5.2 Explicit Describe of Queries
- 6.6 About Defining Output Variables in OCI
- 6.7 About Fetching Results
  - 6.7.1 About Fetching LOB Data
  - 6.7.2 About Setting Prefetch Count
- 6.8 About Using Scrollable Cursors in OCI
  - 6.8.1 About Increasing Scrollable Cursor Performance
  - 6.8.2 Example of Access on a Scrollable Cursor
7 Binding and Defining in OCI
- 7.1 Overview of Binding in OCI
- 7.2 Advanced Bind Operations in OCI
- 7.3 Overview of Defining in OCI
  - 7.3.1 Steps Used in OCI Defining
- 7.4 Advanced Define Operations in OCI
- 7.5 About Binding and Defining Arrays of Structures in OCI
- 7.6 About Binding and Defining Multiple Buffers
- 7.7 DML with a RETURNING Clause in OCI
- 7.8 Character Conversion in OCI Binding and Defining
- 7.9 PL/SQL REF CURSORs and Nested Tables in OCI
- 7.10 Natively Describe and Bind All PL/SQL Types Including Package Types
- 7.11 Runtime Data Allocation and Piecewise Operations in OCI
8 Describing Schema Metadata
- 8.1 About Using OCIDescribeAny()
  - 8.1.1 Limitations on OCIDescribeAny()
  - 8.1.2 Notes on Types and Attributes
- 8.2 Parameter Attributes
- 8.3 Character-Length Semantics Support in Describe Operations
  - 8.3.1 Implicit Describing
  - 8.3.2 Explicit Describing
    - 8.3.2.1 Client and Server Compatibility Issues for Describing
- 8.4 Examples Using OCIDescribeAny()
9 LOB and BFILE Operations
- 9.1 About Using OCI Functions for LOBs
- 9.2 About Creating and Modifying Persistent LOBs
- 9.3 About Associating a BFILE in a Table with an Operating System File
- 9.4 LOB Attributes of an Object
  - 9.4.1 Writing to a LOB Attribute of an Object
  - 9.4.2 Transient Objects with LOB Attributes
- 9.5 Array Interface for LOBs
- 9.6 About Using LOBs of Size Greater than 4 GB
  - 9.6.1 Functions to Use for the Increased LOB Sizes
  - 9.6.2 Compatibility and Migration
- 9.7 LOB and BFILE Functions in OCI
- 9.8 Temporary LOB Support
- 9.9 Prefetching of LOB Data, Length, and Chunk Size
- 9.10 Options of SecureFiles LOBs
10 Managing Scalable Platforms
- 10.1 OCI Support for Transactions
- 10.2 Levels of Transactional Complexity
- 10.3 Password and Session Management
- 10.4 Middle-Tier Applications in OCI
  - 10.4.1 OCI Attributes for Middle-Tier Applications
- 10.5 Externally Initialized Context in OCI
- 10.6 Client Application Context
- 10.7 Using Edition-Based Redefinition
- 10.8 OCI Security Enhancements
- 10.9 Overview of OCI Multithreaded Development
- 10.10 OCIThread Package
11 Session Pooling and Connection Pooling in OCI
- 11.1 Session Pooling in OCI
- 11.2 Database Resident Connection Pooling
- 11.3 About Using Oracle Connection Manager in Traffic Director Mode
- 11.4 Connection Pooling in OCI
- 11.5 When to Use Connection Pooling, Session Pooling, or Neither
  - 11.5.1 Functions for Session Creation
  - 11.5.2 About Choosing Between Different Types of OCI Sessions
12 High Availability in OCI
- 12.1 Runtime Connection Load Balancing
- 12.2 HA Event Notification
- 12.3 Transparent Application Failover in OCI
- 12.4 OCI and Transaction Guard
  - 12.4.1 Developing Applications that Use Transaction Guard
    - 12.4.1.1 Typical Transaction Guard Usage
    - 12.4.1.2 Transaction Guard Examples
- 12.5 OCI and Application Continuity
13 Notification Methods and Database Advanced Queuing
- 13.1 About Continuous Query Notification
- 13.2 Publish-Subscribe Notification in OCI
- 13.3 OCI and Database Advanced Queuing
14 User-Defined Callback Functions in OCI
- 14.1 About Registering User Callbacks in OCI
- 14.2 OCI Callbacks from External Procedures
15 Performance Topics
- 15.1 Statement Caching in OCI
- 15.2 Implicit Fetching of ROWIDs
  - 15.2.1 About Implicit Fetching of ROWIDs
  - 15.2.2 Example of Implicit Fetching of ROWIDs
- 15.3 OCI Support for Implicit Results
- 15.4 Client Result Cache
- 15.5 Client Statement Cache Auto-Tuning
16 Database Startup and Shutdown
- 16.1 About OCI Database Startup and Shutdown
- 16.2 Examples of Startup and Shutdown in OCI
17 Support for Pluggable Databases
- 17.1 Enhancements on OCI API Calls with Multitenant Container Databases (CDB) in General
- 17.2 OCI Enhancements for ALTER SESSION SET CONTAINER
- 17.3 Restrictions on OCI API Calls with Multitenant Container Databases (CDB) in General
- 17.4 Restrictions on OCI Calls with ALTER SESSION SET CONTAINER
- 17.5 Restrictions on OCI Calls with ALTER SESSION SWITCH CONTAINER SWITCH SERVICE
18 OCI Interface for Using Shards
- 18.1 About Specifying a Sharding Key and Super Sharding Key for Getting a Connection from an OCI Session Pool
- 18.2 About Specifying a Sharding Key and Super Sharding Key for Getting a Connection from a Custom Pool
19 OCI Object-Relational Programming
- 19.1 OCI Object Overview
- 19.2 About Working with Objects in OCI
  - 19.2.1 Basic Object Program Structure
  - 19.2.2 Persistent Objects, Transient Objects, and Values
- 19.3 About Developing an OCI Object Application
- 19.4 About Type Inheritance
- 19.5 About Type Evolution
20 Object-Relational Data Types in OCI
- 20.1 Overview of OCI Functions for Objects
- 20.2 About Mapping Oracle Data Types to C
  - 20.2.1 OCI Type Mapping Methodology
- 20.3 About Manipulating C Data Types with OCI
  - 20.3.1 Precision of Oracle Number Operations
- 20.4 Date (OCIDate)
  - 20.4.1 Date Example
- 20.5 Datetime and Interval (OCIDateTime, OCIInterval)
- 20.6 Number (OCINumber)
  - 20.6.1 OCINumber Examples
- 20.7 Fixed or Variable-Length String (OCIString)
  - 20.7.1 About String Functions
  - 20.7.2 String Example
- 20.8 Raw (OCIRaw)
  - 20.8.1 About Raw Functions
  - 20.8.2 Raw Example
- 20.9 Collections (OCITable, OCIArray, OCIColl, OCIIter)
- 20.10 About Multilevel Collection Types
  - 20.10.1 Multilevel Collection Type Example
- 20.11 REF (OCIRef)
  - 20.11.1 About REF Manipulation Functions
  - 20.11.2 REF Example
- 20.12 Object Type Information Storage and Access
  - 20.12.1 Descriptor Objects
- 20.13 AnyType, AnyData, and AnyDataSet Interfaces
- 20.14 About Binding Named Data Types
- 20.15 About Defining Named Data Types
- 20.16 About Binding and Defining Oracle C Data Types
  - 20.16.1 Bind and Define Examples
  - 20.16.2 Salary Update Examples
- 20.17 SQLT_NTY Bind and Define Examples
  - 20.17.1 SQLT_NTY Bind Example
  - 20.17.2 SQLT_NTY Define Example
21 Direct Path Load Interface
- 21.1 Direct Path Loading Overview
- 21.2 Direct Path Loading of Object Types
- 21.3 Direct Path Loading in Pieces
  - 21.3.1 Loading Object Types in Pieces
- 21.4 Direct Path Context Handles and Attributes for Object Types
22 Object Advanced Topics in OCI
- 22.1 Object Cache and Memory Management
- 22.2 Object Navigation
  - 22.2.1 Simple Object Navigation
- 22.3 OCI Navigational Functions
- 22.4 Type Evolution and the Object Cache
23 OCI Support for XML
- 23.1 XML Context
- 23.2 XML Data on the Server
- 23.3 Using OCI XML DB Functions
- 23.4 OCI Client Access to Binary XML
24 Using the Object Type Translator with OCI
- 24.1 What Is the Object Type Translator?
  - 24.1.1 About Creating Types in the Database
  - 24.1.2 About Invoking OTT
- 24.2 OTT Command Line
  - 24.2.1 OTT Command-Line Invocation Example
- 24.3 Intype File
- 24.4 OTT Data Type Mappings
- 24.5 Outtype File
- 24.6 About Using OTT with OCI Applications
- 24.7 OTT Reference
25 Oracle Database Access C API
- 25.1 Introduction to the Relational Functions
- 25.2 Connect, Authorize, and Initialize Functions
- 25.3 Handle and Descriptor Functions
- 25.4 Bind, Define, and Describe Functions
26 More Oracle Database Access C API
- 26.1 Introduction to the Relational Functions
  - 26.1.1 Conventions for OCI Functions
- 26.2 Statement Functions
- 26.3 LOB Functions
- 26.4 Database Advanced Queuing and Publish-Subscribe Functions
- 26.5 Direct Path Loading Functions
- 26.6 Thread Management Functions
- 26.7 Transaction Functions
- 26.8 Sharding Functions
- 26.9 Miscellaneous Functions
27 OCI Navigational and Type Functions
- 27.1 Introduction to the Navigational and Type Functions
- 27.2 OCI Flush or Refresh Functions
- 27.3 OCI Mark or Unmark Object and Cache Functions
- 27.4 OCI Get Object Status Functions
- 27.5 OCI Miscellaneous Object Functions
- 27.6 OCI Pin, Unpin, and Free Functions
- 27.7 OCI Type Information Accessor Functions
28 OCI Data Type Mapping and Manipulation Functions
- 28.1 Introduction to Data Type Mapping and Manipulation Functions
- 28.2 OCI Collection and Iterator Functions
- 28.3 OCI Date, Datetime, and Interval Functions
- 28.4 OCI NUMBER Functions
- 28.5 OCI Raw Functions
- 28.6 OCI REF Functions
- 28.7 OCI String Functions
- 28.8 OCI Table Functions
29 OCI Cartridge Functions
- 29.1 Introduction to External Procedure and Cartridge Services Functions
  - 29.1.1 Conventions for OCI Functions
- 29.2 Cartridge Services — OCI External Procedures
- 29.3 Cartridge Services — Memory Services
- 29.4 Cartridge Services — Maintaining Context
- 29.5 Cartridge Services — Parameter Manager Interface
- 29.6 Cartridge Services — File I/O Interface
- 29.7 Cartridge Services — String Formatting Interface
30 OCI Any Type and Data Functions
- 30.1 Introduction to Any Type and Data Interfaces
  - 30.1.1 Conventions for OCI Functions
- 30.2 OCI Type Interface Functions
- 30.3 OCI Any Data Interface Functions
- 30.4 OCI Any Data Set Interface Functions
31 OCI Globalization Support Functions
- 31.1 Introduction to Globalization Support in OCI
  - 31.1.1 Conventions for OCI Functions
- 31.2 OCI Locale Functions
- 31.3 OCI Locale-Mapping Function
  - 31.3.1 OCINlsNameMap()
- 31.4 OCI String Manipulation Functions
- 31.5 OCI Character Classification Functions
- 31.6 OCI Character Set Conversion Functions
- 31.7 OCI Messaging Functions
32 OCI XML DB Functions
- 32.1 Introduction to XML DB Support in OCI
  - 32.1.1 Conventions for OCI Functions
  - 32.1.2 Returns
- 32.2 OCI XML DB Functions
33 Oracle ODBC Driver
34 Introduction to the OCI Interface for XStream
- 34.1 About the XStream Interface
- 34.2 Handler and Descriptor Attributes
  - 34.2.1 Conventions
  - 34.2.2 Server Handle Attributes
    - 34.2.2.1 OCI_ATTR_XSTREAM_ACK_INTERVAL
    - 34.2.2.2 OCI_ATTR_XSTREAM_IDLE_TIMEOUT
35 OCI XStream Functions
- 35.1 About Using the XStream Interface
- 35.2 Introduction to XStream Functions
- 35.3 OCI XStream Functions
36 OCI SODA Functions
- 36.1 Introduction to OCI SODA Functions
- 36.2 OCI SODA Functions
A Handle and Descriptor Attributes
- A.1 Conventions
- A.2 Environment Handle Attributes
- A.3 Error Handle Attributes
- A.4 Service Context Handle Attributes
- A.5 Server Handle Attributes
  - A.5.1 Authentication Information Handle Attributes
  - A.5.2 User Session Handle Attributes
- A.6 Administration Handle Attributes
- A.7 Connection Pool Handle Attributes
  - A.7.1 Session Pool Handle Attributes
- A.8 Transaction Handle Attributes
- A.9 Statement Handle Attributes
- A.10 Bind Handle Attributes
- A.11 Define Handle Attributes
- A.12 Describe Handle Attributes
- A.13 Parameter Descriptor Attributes
- A.14 Shard Instance Descriptor Attributes
- A.15 SODA Document Handle Attributes
- A.16 SODA Collection Handle Attributes
- A.17 SODA Output Options Handle Attributes
- A.18 SODA Operation Options Handle Attributes
- A.19 LOB Descriptor and LOB Locator Attributes
- A.20 Complex Object Attributes
  - A.20.1 Complex Object Retrieval Handle Attributes
  - A.20.2 Complex Object Retrieval Descriptor Attributes
- A.21 Database Advanced Queuing Descriptor Attributes
  - A.21.1 OCIAQEnqOptions Descriptor Attributes
  - A.21.2 OCIAQDeqOptions Descriptor Attributes
  - A.21.3 OCIAQMsgProperties Descriptor Attributes
  - A.21.4 OCIAQAgent Descriptor Attributes
  - A.21.5 OCIServerDNs Descriptor Attributes
- A.22 Subscription Handle Attributes
  - A.22.1 Continuous Query Notification Attributes
  - A.22.2 Continuous Query Notification Descriptor Attributes
  - A.22.3 Notification Descriptor Attributes
  - A.22.4 Invalidated Query Attributes
- A.23 Direct Path Loading Handle Attributes
  - A.23.1 Direct Path Context Handle (OCIDirPathCtx) Attributes
  - A.23.2 Direct Path Function Context Handle (OCIDirPathFuncCtx) Attributes
  - A.23.3 Direct Path Function Column Array Handle (OCIDirPathColArray) Attributes
  - A.23.4 Direct Path Stream Handle (OCIDirPathStream) Attributes
  - A.23.5 Direct Path Column Parameter Attributes
    - A.23.5.1 About Accessing Column Parameter Attributes
- A.24 Process Handle Attributes
- A.25 Event Handle Attributes
B OCI Demonstration Programs
C OCI Function Server Round-Trips
- C.1 Relational Function Round-Trips
- C.2 LOB Function Round-Trips
- C.3 Object and Cache Function Round-Trips
- C.4 Describe Operation Round-Trips
- C.5 Data Type Mapping and Manipulation Function Round-Trips
- C.6 Any Type and Data Function Round-Trips
- C.7 Other Local Functions
D Getting Started with OCI for Windows
- D.1 What Is Included in the OCI Package for Windows?
- D.2 Oracle Directory Structure for Windows
- D.3 Sample OCI Programs for Windows
- D.4 About Compiling OCI Applications for Windows
- D.5 About Linking OCI Applications for Windows
  - D.5.1 oci.lib
  - D.5.2 Client DLL Loading When Using Load Library()
- D.6 About Running OCI Applications for Windows
- D.7 Oracle XA Library
- D.8 About Using the Object Type Translator for Windows
E Deprecated OCI Features and Functions
- E.1 Deprecated Initialize Functions
  - E.1.1 OCIEnvInit()
  - E.1.2 OCIInitialize()
- E.2 Deprecated Statement Functions
  - E.2.1 OCIStmtFetch()
  - E.2.2 OCIStmtPrepare()
- E.3 Deprecated Lob Functions
- E.4 Deprecated Database Advanced Queuing Functions
  - E.4.1 OCIAQListen()
F Multithreaded extproc Agent
- F.1 Why Use the Multithreaded extproc Agent?
  - F.1.1 The Challenge of Dedicated Agent Architecture
  - F.1.2 The Advantage of Multithreading
- F.2 Multithreaded extproc Agent Architecture
- F.3 Administering the Multithreaded extproc Agent
Index

Search

Print

Download

PDF for offline and print

29 OCI Cartridge Functions

This chapter presents the cartridge functions.

For code examples, see the demonstration programs included with your Oracle Database installation. For additional information, see OCI Demonstration Programs.

This chapter contains these topics: