Oracle® Database

Heterogeneous Connectivity Administrator's Guide

11g Release 1 (11.1)

B28277-02

July 2007

Oracle Database Heterogeneous Connectivity Administrator's Guide, 11g Release 1 (11.1)

B28277-02

Copyright © 2001, 2007, Oracle. All rights reserved.

Primary Author:  Rhonda Day

Contributor:  Juan Pablo Ahues-Vasquez, Peter Castro, Jacco Draaijer, Vira Goorah, Peter Wong, Raghu Mani, Keith Chen

The Programs (which include both the software and documentation) contain proprietary information; they are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright, patent, and other intellectual and industrial property laws. Reverse engineering, disassembly, or decompilation of the Programs, except to the extent required to obtain interoperability with other independently created software or as specified by law, is prohibited.

The information contained in this document is subject to change without notice. If you find any problems in the documentation, please report them to us in writing. This document is not warranted to be error-free. Except as may be expressly permitted in your license agreement for these Programs, no part of these Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose.

If the Programs are delivered to the United States Government or anyone licensing or using the Programs on behalf of the United States Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the Programs, including documentation and technical data, shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement, and, to the extent applicable, the additional rights set forth in FAR 52.227-19, Commercial Computer Software--Restricted Rights (June 1987). Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.

The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup, redundancy and other measures to ensure the safe use of such applications if the Programs are used for such purposes, and we disclaim liability for any damages caused by such use of the Programs.

Oracle, JD Edwards, PeopleSoft, and Siebel are registered trademarks of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

The Programs may provide links to Web sites and access to content, products, and services from third parties. Oracle is not responsible for the availability of, or any content provided on, third-party Web sites. You bear all risks associated with the use of such content. If you choose to purchase any products or services from a third party, the relationship is directly between you and the third party. Oracle is not responsible for: (a) the quality of third-party products or services; or (b) fulfilling any of the terms of the agreement with the third party, including delivery of products or services and warranty obligations related to purchased products or services. Oracle is not responsible for any loss or damage of any sort that you may incur from dealing with any third party.

Contents

List of Figures

List of Tables

Preface

- Audience

- Documentation Accessibility

- Related Documents

- Conventions

What's New in Heterogeneous Connectivity Administrator's Guide?

- Oracle Database 11g Release 1 (11.1) New Features

- Oracle Database 10g Release 2 (10.2) Features

1 Introduction

- 1.1 The Information Integration Challenge

- 1.2 How Oracle Addresses Synchronous Information Integration

- 1.3 Benefits of Oracle's Solution for Synchronous Information Integration

- 1.3.1 Remote Data Can Be Accessed Transparently

- 1.3.2 No Unnecessary Data Duplication

- 1.3.3 SQL Statements Can Query Several Different Databases

- 1.3.4 Oracle's Application Development and End User Tools Can Be Used

- 1.3.5 Users Can Talk to a Remote Database in its Own Language

2 The Role of the Heterogeneous Services Component

- 2.1 Heterogeneous Connectivity Process Architecture

- 2.2 Heterogeneous Services Agents

- 2.3 Types of Heterogeneous Services Agents

- 2.3.1 Oracle Database Gateways

- 2.3.2 Oracle Database Gateway for ODBC Agent

- 2.4 Heterogeneous Services Components

- 2.4.1 Transaction Service

- 2.4.2 SQL Service

- 2.5 Heterogeneous Services Configuration Information

- 2.5.1 Data Dictionary Translation Views

- 2.5.2 Heterogeneous Services Initialization Parameters

- 2.5.3 Capabilities

- 2.6 The Heterogeneous Services Data Dictionary

- 2.6.1 Classes and Instances

- 2.6.2 Data Dictionary Views

- 2.7 Gateway Process Flow

3 Features of Oracle Database Gateways

- 3.1 SQL and PL/SQL Support

- 3.2 Heterogeneous Replication

- 3.3 Passthrough SQL

- 3.3.1 Using the DBMS_HS_PASSTHROUGH Package

- 3.3.2 Considering the Implications of Using Passthrough SQL

- 3.3.3 Executing Passthrough SQL Statements

- 3.3.3.1 Executing Nonqueries

- 3.3.3.1.1 Using Bind Variables: Overview

- 3.3.3.1.2 Using IN Bind Variables

- 3.3.3.1.3 Using OUT Bind Variables

- 3.3.3.1.4 Using IN OUT Bind Variables

- 3.3.3.2 Executing Queries

- 3.4 Result Set Support

- 3.4.1 Result Set Support In Non-Oracle Systems

- 3.4.1.1 Model 1: Result Set Support

- 3.4.1.2 Model 2: Result Set Support

- 3.4.2 Heterogeneous Services Support for Result Sets

- 3.4.2.1 Results Sets: Cursor Mode

- 3.4.2.2 Result Sets: Sequential Mode

- 3.5 Data Dictionary Translations

- 3.6 Datetime Data Types

- 3.7 Two-Phase Commit Protocol

- 3.8 Piecewise LONG Data Type

- 3.9 SQL*Plus DESCRIBE Command

- 3.10 Constraints on SQL in a Distributed Environment

- 3.10.1 Remote and Heterogeneous References

- 3.10.2 Important Restrictions

- 3.11 Using Oracle's Optimizer with Heterogeneous Services

- 3.11.1 Example: Using Index and Table Statistics

- 3.11.2 Example: Remote Join Optimization

- 3.11.3 Optimizer Restrictions for Non-Oracle Access

4 Using Heterogeneous Services Agents

- 4.1 Initialization Parameters

- 4.1.1 Encrypting Initialization Parameters

- 4.1.1.1 Using the dg4pwd Utility

- 4.1.2 Gateway Initialization Parameters

- 4.2 Optimizing Data Transfers Using Bulk Fetch

- 4.2.1 Using OCI, an Oracle Precompiler, or Another Tool for Array Fetches

- 4.2.2 Controlling the Array Fetch Between the Oracle Database Server and the Agent

- 4.2.3 Controlling the Array Fetch Between Agent and Non-Oracle Server

- 4.2.4 Controlling the Reblocking of Array Fetches

- 4.3 Optimizing Data Loads Using Parallel Load

- 4.4 Registering Agents

- 4.4.1 Enabling Agent Self-Registration

- 4.4.1.1 Using Agent Self-Registration to Avoid Configuration Mismatches

- 4.4.1.2 Understanding Agent Self-Registration

- 4.4.1.2.1 FDS_CLASS and FDS_CLASS_VERSION

- 4.4.1.2.2 FDS_INST_NAME

- 4.4.1.3 Specifying HS_AUTOREGISTER

- 4.4.2 Disabling Agent Self-Registration

- 4.5 Oracle Database Server SQL Construct Processing

- 4.5.1 Data Type Checking Support for a Remote-Mapped Statement

- 4.6 Executing User-Defined Functions on a Non-Oracle Database

- 4.7 Using Synonyms

- 4.7.1 Example of a Distributed Query

- 4.8 Copying Data from the Oracle Database Server to the Non-Oracle Database System

- 4.9 Copying Data from the Non-Oracle Database System to the Oracle Database Server

- 4.10 Using Heterogeneous Services Data Dictionary Views

- 4.10.1 Understanding the Types of Views

- 4.10.2 Understanding the Sources of Data Dictionary Information

- 4.10.3 Using the General Views

- 4.10.4 Using the Transaction Service Views

- 4.10.5 Using the SQL Service Views

- 4.10.5.1 Using Views for Capabilities and Translations

- 4.10.5.2 Using Views for Data Dictionary Translations

- 4.11 Using the Heterogeneous Services Dynamic Performance Views

- 4.11.1 Determining Which Agents Are Running on a Host: V$HS_AGENT View

- 4.11.2 Determining the Open Heterogeneous Services Sessions: V$HS_SESSION View

- 4.11.3 Determining the Heterogeneous Services Parameters: V$HS_PARAMETER View

5 Performance Recommendations

- 5.1 Optimizing Heterogeneous Distributed SQL Statements

- 5.2 Optimizing Performance of Distributed Queries

Index

List of Figures

- 2-1 Oracle Heterogeneous Connectivity Process Architecture

- 2-2 Accessing Multiple Non-Oracle Instances

- 2-3 Gateway Process Flow

- 3-1 Flow Diagram for Nonquery Passthrough SQL

- 3-2 Passthrough SQL for Queries

- 4-1 Optimizing Data Transfers

List of Tables

- 4-1 Data Dictionary Views for Heterogeneous Services

- 4-2 Important Columns in the V$HS_AGENT View

- 4-3 Important Columns in the V$HS_SESSION View

- 4-4 Important Columns in the V$HS_SESSION View

Preface

This manual describes Oracle's approach for information integration in a heterogeneous environment. Specifically, it describes Oracle Database Gateways and is meant to be an administrator's guide.

This preface contains these topics:

- Audience

- Documentation Accessibility

- Related Documents

- Conventions

Audience

This manual is intended for the following users:

- Database administrators who want to administer distributed database systems that involve Oracle to non-Oracle database links

- Application developers who want to make use of the heterogeneous connectivity functionality in the Oracle database server

- Readers who want a high-level understanding of Oracle's architecture for heterogeneous connectivity and how it works

To use this document, you need to be familiar with relational database concepts and basic database or applications administration. You also need to be familiar with the operating system environment under which database administrators are running Oracle.

Documentation Accessibility

Our goal is to make Oracle products, services, and supporting documentation accessible, with good usability, to the disabled community. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Accessibility standards will continue to evolve over time, and Oracle is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For more information, visit the Oracle Accessibility Program Web site at

http://www.oracle.com/accessibility/

Accessibility of Code Examples in Documentation

Screen readers may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, some screen readers may not always read a line of text that consists solely of a bracket or brace.

Accessibility of Links to External Web Sites in Documentation

This documentation may contain links to Web sites of other companies or organizations that Oracle does not own or control. Oracle neither evaluates nor makes any representations regarding the accessibility of these Web sites.

TTY Access to Oracle Support Services

Oracle provides dedicated Text Telephone (TTY) access to Oracle Support Services within the United States of America 24 hours a day, seven days a week. For TTY support, call 800.446.2398.

Related Documents

For more information, see these Oracle resources:

- Oracle Database Concepts

- Oracle Database Administrator's Guide

- Oracle Database Advanced Application Developer's Guide

Many of the examples in this book use the sample schemas, which are installed by default when you select the Basic Installation option with an Oracle Database installation. Refer to Oracle Database Sample Schemas for information on how these schemas were created and how you can use them yourself.

Conventions

The following text conventions are used in this document:

Convention

Meaning

boldface

Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary.

italic

Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.

monospace

Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.

What's New in Heterogeneous Connectivity Administrator's Guide?

This section describes new features of the Oracle Database 11g Release 1 (11.1) and provides pointers to additional information. New features information from previous releases is also retained to help those users migrating to the current release.

The following sections describe the new features in Oracle Database Heterogeneous Connectivity Administrator's Guide:

- Oracle Database 11g Release 1 (11.1) New Features

- Oracle Database 10g Release 2 (10.2) Features

Oracle Database 11g Release 1 (11.1) New Features

New features for Oracle Database 11g Release 1 (11.1) in the Heterogeneous Connectivity Administrator's Guide include:

- Parallel data retrieval

The Heterogeneous Services agent architecture has been enhanced for parallel data retrieval from non-Oracle remote databases. With this feature, gateway customers experience improved elapsed time for data retrieval and load.

This feature includes the new DBMS_HS_PARALLEL package. Four new procedures are introduced with this package:

- LOAD_TABLE

This procedure loads data from a remote table to the local Oracle table in parallel.

- CREATE_TABLE_TEMPLATE

This procedure writes out a CREATE TABLE template based on information gathered from the remote table.

- CREATE_OR_REPLACE_VIEW

This procedure creates (or replaces) a read-only view to be referenced for retrieving the data from a remote table in parallel.

- DROP_VIEW

This procedure drops the view created by the CREATE_OR_REPLACE_VIEW procedure.

See Also:
Oracle Database PL/SQL Packages and Types Reference for additional information

- Optimizer interface improvements

The statistics interface of Heterogeneous Services has been enhanced to enable the Oracle optimizer to derive an equivalent execution plan for distributed SQL when dealing with a remote Oracle database and the agent. With this feature, customers experience similar or better elapsed time for distributed SQL across the gateways.

Oracle Database 10g Release 2 (10.2) Features

New features for Oracle Database 10g Release 2 (10.2) in the Heterogeneous Connectivity Administrator's Guide include:

- Data type checking

This release adds data type checking for remote-mapped statements. The result provides consistent data type checking and complete data type coercion.

See Also:
Section 4.5, "Oracle Database Server SQL Construct Processing"

- dg4pwd Utility

Use this utility to encrypt initialization parameters in a Heterogeneous Services Gateway initialization file.

See Also:
Section 4.1.1, "Encrypting Initialization Parameters"

1 Introduction

This chapter describes the challenges of operating in a heterogeneous environment. Oracle recognizes these challenges and offers both synchronous and asynchronous solutions that enable companies to easily operate in such an environment. The synchronous solution, Oracle Database Gateway, is discussed this book.

This chapter contains these topics:

- The Information Integration Challenge

- How Oracle Addresses Synchronous Information Integration

- Benefits of Oracle's Solution for Synchronous Information Integration

See Also:
For information about a specific Oracle Database Gateway, please consult the Oracle documentation for that specific gateway

1.1 The Information Integration Challenge

Information integration is a challenge that affects many organizations. Many run several different database systems. Each of these systems stores data and has a set of applications that run against it. This data is just bits and bytes on a file system - and only a database can turn the bits and bytes of data into business information. Integration and consolidation of all business information would allow an organization to easily and quickly take advantage of the synergies inherent in business information.

Consolidation of all data into one database system is often difficult. This is in large part because many of the applications that run against one database may not have an equivalent that runs against another. Until such time as migration to one consolidated database system is made feasible, it is necessary for the various heterogeneous database systems to work together.

There are several problems to overcome before such interoperability becomes possible. The database systems can have different access interfaces, different data types, different capabilities, and different ways of handling error conditions. Even when one relational database is trying to access another relational database the differences are significant. In such a situation, the common features of the databases include data access through SQL, two-phase commit, and similar data types.

However, there are significant differences as well. SQL dialects can be different, as can transaction semantics. There can be some data types in one database that do not exist in the other. The most significant area of difference is in the data dictionaries of the two databases. Most data dictionaries contain similar information but the information is structured for each in a completely different way. There are several possible ways of overcoming this problem. In this book, we describe the approach that Oracle has taken for synchronously accessing information from multiple sources.

1.2 How Oracle Addresses Synchronous Information Integration

If a client program needs to access or modify data at several Oracle databases, it can open connections to each of them. This approach, however, has several drawbacks; among them are the following:

- If you want to join data from the databases, the client must contain logic allowing that.

- If data integrity must be guaranteed, the client needs to contain transaction coordination logic.

Oracle provides another approach called distributed processing, where the client connects to one Oracle database and shifts the burden of joining data and transaction coordination to that database. The database to which the client program connects is called the local database. Any database other than this one is a remote database. The client program can access objects at any of the remote databases using database links. The Oracle query processor takes care of the joins and its transaction engine takes care of the transaction coordination.

The approach that Oracle has taken to solving the heterogeneous connectivity problem is to allow a non-Oracle system to be one of the remote nodes in the previously described scenario. From the client's point of view, the remote non-Oracle system functions like a remote Oracle system. It appears to understand the same SQL dialect and to have the same data dictionary structure as an Oracle system. Access to a non-Oracle system in this manner is done through a component in the Oracle server called Heterogeneous Services.

The work done by the Heterogeneous Services component is, for the most part, completely transparent to the end user. With only a few exceptions (these are noted in later chapters), you are not required to do anything different to access a non-Oracle system than is required for accessing an Oracle system. The Heterogeneous Services component is used as the foundation for implementing Oracle's access to non-Oracle databases.

An Oracle Database Gateway works in conjunction with the Heterogeneous Services component of the Oracle Database server to access a particular, commercially available, non-Oracle system for which that Oracle Database Gateway has been designed. For example, you use the Oracle Database Gateway for Sybase to access a Sybase database. Oracle also provides an Oracle Database Gateway for ODBC which enables you to use ODBC drivers to access non-Oracle databases.

Using an Oracle Database Gateway, you can access data anywhere in a distributed database system without being required to know either the location of the data, or how it is stored.

Note:
The ODBC drivers that are required by Oracle Database Gateway for ODBC are not supplied by Oracle. Users should obtain drivers from other vendors.

Oracle also offers asynchronous information integration solutions that are mentioned here, but that are not discussed in this book. Briefly, these solutions include:

- Oracle Streams

Oracle Streams enables the propagation of data, transactions, and events in a single data stream or queue, either within a database or between multiple databases. Not only can Oracle Streams capture, propagate, and apply changes to data, it can also handle data structure changes (DDL) and user-defined events. Changes can be captured and applied as is, or transformed at any point in the capture, propagation, and application processing.

- Messaging Gateway

The messaging gateway enables communication between Oracle and other non-Oracle message queuing.

- Open System Interfaces

Oracle offers a number of open interfaces, such as OCI, JDBC, and ODBC, that enable customers to use third party applications or to write their own client applications to access the Oracle database.

1.3 Benefits of Oracle's Solution for Synchronous Information Integration

Much of the processing power of Oracle Database Gateways is integrated into the database. This provides an efficient solution for information integration that enables full exploitation of the power and features of the Oracle database. This includes such features as powerful SQL parsing and distributed optimization capabilities.

The following sections explore the benefits of Oracle's approach to resolving the challenges of a heterogeneous environment:

- Remote Data Can Be Accessed Transparently

- No Unnecessary Data Duplication

- SQL Statements Can Query Several Different Databases

- Oracle's Application Development and End User Tools Can Be Used

- Users Can Talk to a Remote Database in its Own Language

1.3.1 Remote Data Can Be Accessed Transparently

Oracle Database Gateways provide the ability to transparently access data in non-Oracle databases from an Oracle environment. You can create synonyms for the objects in a non-Oracle database and refer to them without having to specify a physical location. This transparency eliminates the need for application developers to customize their applications to access data from different non-Oracle systems, thus decreasing development efforts and increasing the mobility of the application.

Instead of requiring applications to interoperate with non-Oracle systems using their native interfaces (which can result in intensive application-side processing), applications can be built upon a consistent Oracle interface for both Oracle and non-Oracle systems.

1.3.2 No Unnecessary Data Duplication

Oracle Database Gateways provide applications direct access to data in non-Oracle databases. This eliminates the need to upload and download large amounts of data to different locations, thus reducing data duplication and saving disk storage space. Also, by eliminating this need to upload and download large amounts of data, there is a further benefit of a reduced risk for unsynchronized or inconsistent data.

1.3.3 SQL Statements Can Query Several Different Databases

The Oracle database server accepts SQL statements that query data stored in several different databases. The Oracle database server with the Heterogeneous Services component processes the SQL statement and passes the appropriate SQL directly to other Oracle databases and through gateways to non-Oracle databases. The Oracle database server then combines the results and returns them to the client.

1.3.4 Oracle's Application Development and End User Tools Can Be Used

Oracle Database Gateways extend the range of Oracle's database and application development tools. Oracle has tools that increase application development and user productivity by reducing prototype, development, and maintenance time.

You are not required to develop new tools or learn how to use other tools to access data stored in non-Oracle databases. Instead, you can access Oracle and non-Oracle data with a single set of Oracle tools. These tools can run on remote systems connected through Oracle Net to the Oracle database server.

1.3.5 Users Can Talk to a Remote Database in its Own Language

Oracle enables you to transparently access non-Oracle systems using Oracle SQL. In some cases, however, it becomes necessary to use non-Oracle system SQL to access the non-Oracle system. For such cases, Heterogeneous Services has a passthrough feature that enables you to bypass Oracle's query processor and to talk to the remote database in its own language.

2 The Role of the Heterogeneous Services Component

Oracle's synchronous solutions for operating in a heterogeneous environment are Oracle Database Gateways. The common component of the Oracle database server for supporting these solutions is Heterogeneous Services. This chapter describes the architecture and functionality of the Heterogeneous Services component and its interaction with Oracle Database Gateways.

This chapter contains the following topics:

- Heterogeneous Connectivity Process Architecture

- Heterogeneous Services Agents

- Types of Heterogeneous Services Agents

- Heterogeneous Services Components

- Heterogeneous Services Configuration Information

- The Heterogeneous Services Data Dictionary

- Gateway Process Flow

2.1 Heterogeneous Connectivity Process Architecture

At a high level, Oracle heterogeneous connectivity process architecture is structured as shown in Figure 2-1.

Figure 2-1 Oracle Heterogeneous Connectivity Process Architecture

The Heterogeneous Services component in the Oracle database server talks to a Heterogeneous Services agent process which, in turn, talks to the non-Oracle system. We can conceptually divide the code into three parts:

- The Heterogeneous Services component in the Oracle database server.

Most of the processing related to heterogeneous connectivity is done in this module.

- Agent generic code.

This is code in the agent that is generic to all Heterogeneous Services products. This consists, for the most part, of code to communicate with the database and multithreading support.

- The driver.

This is the module that communicates with the non-Oracle system. It is used to map calls from the Heterogeneous Services onto the native API of the non-Oracle system and it is non-Oracle system specific.

2.2 Heterogeneous Services Agents

A Heterogeneous Services agent is the process through which an Oracle server connects to a non-Oracle system. This agent process that accesses a non-Oracle system is called a gateway. Access to all gateways goes through the Heterogeneous Services component in the Oracle server and all gateways contain the same agent-generic code. Each gateway has a different driver linked in that maps the Heterogeneous Services to the client API of the non-Oracle system.

The agent process consists of two components. These are agent generic code and a non-Oracle system-specific driver. An agent exists primarily to isolate the Oracle database server from third-party code. In order for a process to access the non-Oracle system, the non-Oracle system client libraries have to be linked into it. In the absence of the agent process, these libraries would have to be directly linked into the Oracle database and problems in this code could cause the Oracle server to go down. Having an agent process isolates the Oracle server from any problems in third-party code so that even if a fatal error takes place, only the agent process will end.

An agent can reside in the following places:

- On the same computer as the non-Oracle system

- On the same computer as the Oracle server

- On a computer different from either of these two

Agent processes are started when a user session makes its first non-Oracle system access through a database link. These connections are made using Oracle's remote data access software, Oracle Net Services, which enables both client/server and server-server communication. The agent process continues to run until the user session is disconnected or the database link is explicitly closed.

Multithreaded agents behave differently. They have to be explicitly started and shut down by a database administrator instead of automatically being spawned by Oracle Net Services.

2.3 Types of Heterogeneous Services Agents

There are two types of Heterogeneous Services agents:

- Oracle Database Gateways

- Oracle Database Gateway for ODBC Agent

2.3.1 Oracle Database Gateways

An Oracle Database Gateway is a gateway that is designed for accessing a specific non-Oracle system. Oracle provides gateways to access several commercially produced non-Oracle systems. For example, an Oracle Database Gateway for Sybase is designed to access Sybase databases.

With Oracle Database Gateways, you can use an Oracle database server to access data anywhere in a distributed database system without being required to know either the location of the data or how it is stored. When the results of your queries are returned to you by the Oracle database server, they are presented to you as if the data stores from which they were taken all resided within a remote instance of an Oracle distributed database.

2.3.2 Oracle Database Gateway for ODBC Agent

In addition to Oracle Database Gateways for various non-Oracle database systems, there is the Oracle Database Gateway for ODBC agent. This agent contains only generic code and the customer is responsible for providing the necessary drivers. Oracle Database Gateway for ODBC enables you to use ODBC drivers to access non-Oracle systems that have an ODBC interface.

To access a specific non-Oracle system using Oracle Database Gateway for ODBC, you must configure an ODBC driver to the non-Oracle system. These drivers are not provided by Oracle. However, as long as the non-Oracle system supports the ODBC protocols, you can use Oracle Database Gateway for ODBC to access any non-Oracle system that can be accessed using an ODBC driver.

Oracle Database Gateway for ODBC has some limitations. Especially, when compared to a paticular target, the functionality and performance are limited.

2.4 Heterogeneous Services Components

This section discusses the components of Heterogeneous Services in the Oracle database server. These components are:

- Transaction Service

- SQL Service

2.4.1 Transaction Service

The transaction service component of the Heterogeneous Services component makes it possible for non-Oracle systems to be integrated into Oracle database server transactions and sessions. When you access a non-Oracle system for the first time over a database link within your Oracle user session, you transparently set up an authenticated session in the non-Oracle system. At the end of your Oracle user session, the authenticated session in the non-Oracle database system is also closed.

Additionally, one or more non-Oracle systems can participate in an Oracle distributed transaction. When an application commits a transaction, Oracle's two-phase commit protocol accesses the non-Oracle database system to transparently coordinate the distributed transaction. Even in those cases where the non-Oracle system does not support all aspects of Oracle two-phase commit protocol, Oracle can (with some limitations) support distributed transactions with the non-Oracle system.

2.4.2 SQL Service

The Structured Query Language (SQL) service handles the processing of all SQL-related operations. The work done by the SQL service includes:

- Mapping Oracle internal SQL-related calls to the Heterogeneous Services driver application programing interface (API); this is in turn mapped by the driver to the client API of the non-Oracle system.

- Translating SQL statements from Oracle's SQL dialect to the SQL dialect of the non-Oracle system.

- Translating queries that reference Oracle data dictionary tables to queries that extract the necessary information from the non-Oracle system data dictionary.

- Converting data from non-Oracle system data types to Oracle data types and back.

- Making up for missing functionality at the non-Oracle system by issuing multiple queries to get the necessary data and doing post-processing to get the desired results.

2.5 Heterogeneous Services Configuration Information

Heterogeneous Services components consist of generic code and must be configured to work with many different non-Oracle systems. Each gateway has configuration information stored in the driver module. The information is uploaded to the server immediately after the connection to the gateway has been established. The configuration information includes:

- Data Dictionary Translation Views

- Heterogeneous Services Initialization Parameters

- Capabilities

2.5.1 Data Dictionary Translation Views

Data dictionary translations are views on non-Oracle data dictionary tables. They help Heterogeneous Services translate references to Oracle data dictionary tables into queries that can retrieve the equivalent information from the non-Oracle data dictionary.

2.5.2 Heterogeneous Services Initialization Parameters

Heterogeneous Services initialization parameters serve two functions:

- They give you a means of fine-tuning the gateway to optimize performance and memory utilization for the gateway and the Heterogeneous Services component.

- They enable you to tell the gateway (and, thereby, Heterogeneous Services) how the non-Oracle system has been configured (for example, in what language the non-Oracle system is running). They give information to Heterogeneous Services about the configurable properties of the non-Oracle system.

You can examine the Heterogeneous Services initialization parameters for a session by querying the view V$HS_PARAMETER. Users can set initialization parameters in gateway initialization files.

2.5.3 Capabilities

Capabilities tell Heterogeneous Services about the limitations of the non-Oracle system (such as what types of SQL statements are supported) and how to map Oracle data types and SQL expressions to their non-Oracle system equivalents. In other words, they tell Heterogeneous Services about the non-configurable properties of the non-Oracle system. Capabilities cannot be changed by the user.

2.6 The Heterogeneous Services Data Dictionary

Configuration information is uploaded from an agent to the Heterogeneous Services component immediately after the connection to the agent has been established. The configuration information is stored in Heterogeneous Services data dictionary tables. No further upload takes place until something at the agent changes (for example, if a patch is applied or if the agent is upgraded to a new version).

The following sections describe:

- Classes and Instances

- Data Dictionary Views

2.6.1 Classes and Instances

Using Heterogeneous Services, you can access several non-Oracle systems from a single Oracle database. This is illustrated in Figure 2-2, which shows two non-Oracle systems being accessed.

Figure 2-2 Accessing Multiple Non-Oracle Instances

Both agents upload configuration information, which is stored as part of the Heterogeneous Services data dictionary information on the Oracle database server.

Although it is possible to store data dictionary information at one level of granularity by having completely separate definitions in the Heterogeneous Services data dictionary for each individual instance, this can lead to an unnecessarily large amount of redundant data dictionary information. To avoid this, Oracle organizes the Heterogeneous Services data dictionary by two levels of granularity, called class and instance.

A class pertains to a specific type of non-Oracle system. For example, you may want to access the class of Sybase database systems with your Oracle database server. An instance defines specializations within a class. For example, you may want to access several separate instances within a Sybase database system. Each class definition (one level of granularity) is shared by all the particular instances (a second level of granularity) under that class. Further, instance information takes precedence over class information, and class information takes precedence over server-supplied defaults.

For example, suppose that the Oracle database server accesses three instances of Sybase and two instances of Ingres II. Sybase and Ingres II each have their own code, requiring separate class definitions for the Oracle database server to access them. The Heterogeneous Services data dictionary therefore would contain two class definitions, one for Sybase and one for Ingres II, with five instance definitions, one for each instance being accessed by the Oracle database server.

Note that instance level capability and data dictionary information are session-specific and hence are not stored in the Heterogeneous Services data dictionary of the Oracle database server. However, instance level initialization parameters can be stored in the database.

2.6.2 Data Dictionary Views

The Heterogeneous Services data dictionary views contain the following kinds of information:

- Names of instances and classes uploaded into the Oracle data dictionary

- Capabilities, including SQL translations, defined for each class or instance

- Data Dictionary translations defined for each class or instance

- Initialization parameters defined for each class or instance

You can access information from the Oracle data dictionary by using fixed views. The views are categorized into three main types:

- General views

- Views used for the transaction service

- Views used for the SQL service

2.7 Gateway Process Flow

Figure 2-3 shows a typical gateway process flow. The steps explain the sequence of events that occur when a client application queries the non-Oracle database system database through the gateway.

Figure 2-3 Gateway Process Flow

1. The client application sends a query over Oracle Net to the Oracle database server.

2. Heterogeneous Services and the gateway converts the Oracle SQL statement into a SQL statement understood by the non-Oracle database system.

3. The Oracle database server sends the query over to the gateway using Oracle Net.

4. For the first transaction in a session, the gateway logs into non-Oracle database system using a username and password that is valid in the non-Oracle system.

5. The gateway retrieves data using non-Oracle database system SQL statements.

6. The gateway converts retrieved data into a format compatible with the Oracle database server.

7. The gateway returns query results to the Oracle database server, again using Oracle Net Services.

8. The Oracle database server passes the query results to the client application using Oracle Net. The database link remains open until the gateway session is finished or the database link is explicitly closed.

3 Features of Oracle Database Gateways

This chapter describes the major features provided by Oracle Database Gateways. Descriptions of these features are contained in the following topics:

- SQL and PL/SQL Support

- Heterogeneous Replication

- Passthrough SQL

- Result Set Support

- Data Dictionary Translations

- Datetime Data Types

- Two-Phase Commit Protocol

- Piecewise LONG Data Type

- SQL*Plus DESCRIBE Command

- Constraints on SQL in a Distributed Environment

- Using Oracle's Optimizer with Heterogeneous Services

Note:
These features may not be available in all Heterogeneous Services gateways. Not only must there be generic support for these features, which Heterogeneous Services provides, but there must also be support added to the driver for them. Consult the appropriate gateway documentation to determine if a particular feature is supported for your gateway.

3.1 SQL and PL/SQL Support

SQL statements are translated and data types are mapped according to capabilities. PL/SQL calls are mapped to non-Oracle system stored procedures. In the case of SQL statements, if functionality is missing at the remote system, then either a simpler query is issued or the statement is broken up into multiple queries and the desired results are obtained by post-processing in the Oracle database.

Even though Heterogeneous Services can, for the most part, incorporate non-Oracle systems into Oracle distributed sessions, there are several limitations to this. Some of the generic limitations are:

- There is no support for CONNECT BY clauses in SQL statements.

- ROWID support is limited; consult individual gateway documentation for more details. The Oracle Universal ROWID data type is not supported in any gateway that uses Heterogeneous Services.

- LOBs, ADTs, and REFs are not supported.

- Remote packages are not supported.

- Remote stored procedures can have out arguments of type REF CURSOR but not in or in-out objects.

- Oracle Heterogeneous Services agents do not support shared database links.

Note:
In addition to these generic limitations, each gateway can have additional limitations. Please consult the gateway documentation for individual gateways for a complete list of limitations of the product.

3.2 Heterogeneous Replication

Data can be replicated between a non-Oracle system and an Oracle server using materialized views.

Note:
There is another means of replicating information between Oracle and non-Oracle databases called Streams.
For information about using Streams, see Oracle Streams Concepts and Administration.

Materialized views instantiate data captured from tables at the non-Oracle master site at a particular point in time. This instant is defined by a refresh operation, which copies this data to the Oracle server and synchronizes the copy on Oracle with the master copy on the non-Oracle system. The "materialized" data is then available as a view on the Oracle server.

Replication facilities provide mechanisms to schedule refreshes and to collect materialized views into replication groups to facilitate their administration. Refresh groups permit refreshing multiple materialized views just as if they were a single object.

Heterogeneous replication support is necessarily limited to a subset of the full Oracle-to-Oracle replication functionality:

- Only the non-Oracle system can be the master site. This is because materialized views can be created only on an Oracle server.

- Materialized views must use complete refresh. This is because fast refresh would require Oracle-specific functionality in the non-Oracle system.

- Not all types of materialized views can be created to reference tables on a non-Oracle system. Primary key and subquery materialized views are supported, but ROWID and OBJECT ID materialized views are not supported. This is because there is no SQL standard for the format and contents of ROWID, and non-Oracle systems do not implement Oracle objects.

Other restrictions apply to any access to non-Oracle data through Oracle's Heterogeneous Services facilities. The most important of these are:

- Non-Oracle data types in table columns mapped to a fixed view must be compatible with (that is, have a mapping to or from) Oracle data types. This is usually true for data types defined by ANSI SQL standards.

- A subquery materialized view may not be able to use language features restricted by individual non-Oracle systems. In many cases Heterogeneous Services supports such language features by processing queries within the Oracle server, but occasionally the non-Oracle systems impose limitations that cannot be diagnosed until Heterogeneous Services attempt to execute the query.

The following examples illustrate basic setup and use of three materialized views to replicate data from a non-Oracle system to an Oracle data store.

Note:
For the following examples, remote_db refers to the non-Oracle system which you are accessing from your Oracle database server.
Modify these examples for your environment. Do not try to execute them as they are written.

Example 1: Create Materialized Views for Heterogeneous Replication

This example creates three materialized views that are then used in succeeding examples.

1. Create a primary key materialized view of table customer@remote_db.

CREATE MATERIALIZED VIEW pk_mv REFRESH COMPLETE AS
SELECT * FROM customer@remote_db WHERE "zip" = 94555;

2. Create a subquery materialized view of tables orders@remote_db and customer@remote_db.

CREATE MATERIALIZED VIEW sq_mv REFRESH COMPLETE AS
SELECT * FROM orders@remote_db o WHERE EXISTS
(SELECT c."c_id" FROM customer@remote_db c
WHERE c."zip" = 94555 and c."c_id"  = o."c_id" );

3. Create a complex materialized view of data from multiple tables on remote_db.

CREATE MATERIALIZED VIEW cx_mv
REFRESH COMPLETE AS
SELECT  c."c_id", o."o_id"
FROM customer@remote_db c,
orders@remote_db o,
order_line@remote_db ol
WHERE c."c_id" = o."c_id"
AND o."o_id" = ol."o_id";

Example 2: Set Up a Refresh Group for Heterogeneous Replication

BEGIN
dbms_refresh.make('refgroup1',
'pk_mv, sq_mv, cx_mv',
NULL, NULL);
END;
/

Example 3: Force Refresh of all Three Materialized Views

BEGIN
dbms_refresh.refresh('refgroup1');
END;
/

See Also:
Oracle Database Advanced Replication for a full description of materialized views and replication facilities

3.3 Passthrough SQL

The passthrough SQL feature enables you to send a statement directly to a non-Oracle system without being interpreted by the Oracle server. This feature can be useful if the non-Oracle system allows for operations in statements for which there is no equivalent in Oracle.

This section contains the following topics:

- Using the DBMS_HS_PASSTHROUGH Package

- Considering the Implications of Using Passthrough SQL

- Executing Passthrough SQL Statements

3.3.1 Using the DBMS_HS_PASSTHROUGH Package

You can execute passthrough SQL statements directly at the non-Oracle system using the PL/SQL package DBMS_HS_PASSTHROUGH. Any statement executed with this package is executed in the same transaction as standard SQL statements.

The DBMS_HS_PASSTHROUGH package is a virtual package. It conceptually resides at the non-Oracle system. In reality, however, calls to this package are intercepted by Heterogeneous Services and mapped to one or more Heterogeneous Services calls. The driver, in turn, maps these Heterogeneous Services calls to the API of the non-Oracle system. The client application should invoke the procedures in the package through a database link in exactly the same way as it would invoke a non-Oracle system stored procedure. The special processing done by Heterogeneous Services is transparent to the user.

See Also:
Oracle Database PL/SQL Packages and Types Reference for more information about this package

3.3.2 Considering the Implications of Using Passthrough SQL

When you execute a passthrough SQL statement that implicitly commits or rolls back a transaction in the non-Oracle system, the transaction is affected. For example, some systems implicitly commit the transaction containing a data definition language (DDL) statement. Because the Oracle database server is bypassed, the Oracle database server is unaware of the commit in the non-Oracle system. Consequently, the data at the non-Oracle system can be committed while the transaction in the Oracle database server is not.

If the transaction in the Oracle database server is rolled back, data inconsistencies between the Oracle database server and the non-Oracle server can occur. This situation results in global data inconsistency.

Note that if the application executes a regular COMMIT statement, the Oracle database server can coordinate the distributed transaction with the non-Oracle system. The statement executed with the passthrough facility is part of the distributed transaction.

3.3.3 Executing Passthrough SQL Statements

The following table shows the functions and procedures provided by the DBMS_HS_PASSTHROUGH package that enable you to execute passthrough SQL statements.

Procedure/Function

Description

OPEN_CURSOR

Opens a cursor.

CLOSE_CURSOR

Closes a cursor.

PARSE

Parses the statement.

BIND_VARIABLE

Binds IN variables.

BIND_OUT_VARIABLE

Binds OUT variables.

BIND_INOUT_VARIABLE

Binds IN OUT variables.

EXECUTE_NON_QUERY

Executes nonquery.

EXECUTE_IMMEDIATE

Executes nonquery without bind variables.

FETCH_ROW

Fetches rows from query.

GET_VALUE

Retrieves column value from SELECT statement or retrieves OUT bind parameters.

3.3.3.1 Executing Nonqueries

Nonqueries include the following statements and types of statements:

- INSERT

- UPDATE

- DELETE

- DDL

To execute nonquery statements, use the EXECUTE_IMMEDIATE function. For example, to execute a DDL statement at a non-Oracle system that you can access using the database link salesdb, execute:

DECLARE
num_rows INTEGER;

BEGIN
num_rows := DBMS_HS_PASSTHROUGH.EXECUTE_IMMEDIATE@salesdb
('CREATE TABLE dept1 (n SMALLINT, loc CHARACTER(10))');
END;

The variable num_rows is assigned the number of rows affected by the execution. For DDL statements, zero is returned. Note that you cannot execute a query with EXECUTE_IMMEDIATE and you cannot use bind variables.

3.3.3.1.1 Using Bind Variables: Overview

Bind variables allow you to use the same SQL statement multiple times with different values, reducing the number of times a SQL statement needs to be parsed. For example, when you need to insert four rows in a particular table, you can parse the SQL statement once and bind and execute the SQL statement for each row. One SQL statement can have zero or more bind variables.

To execute passthrough SQL statements with bind variables, you must:

1. Open a cursor.

2. Parse the SQL statement at the non-Oracle system.

3. Bind the variables.

4. Execute the SQL statement at the non-Oracle system.

5. Close the cursor.

Figure 3-1 shows the flow diagram for executing nonqueries with bind variables.

Figure 3-1 Flow Diagram for Nonquery Passthrough SQL

3.3.3.1.2 Using IN Bind Variables

The syntax of the non-Oracle system determines how a statement specifies a bind variable. For example, in Oracle you define bind variables with a preceding colon. For example:

...
UPDATE emp
SET sal=sal*1.1
WHERE ename=:ename;
...

In this statement, ename is the bind variable. In non-Oracle systems, you may need to specify bind variables with a question mark. For example:

...
UPDATE emp
SET sal=sal*1.1
WHERE ename= ?;
...

In the bind variable step, you must positionally associate host program variables (in this case, PL/SQL) with each of these bind variables. For example, to execute the preceding statement, use the following PL/SQL program:

DECLARE
c INTEGER;
nr INTEGER;
BEGIN
c := DBMS_HS_PASSTHROUGH.OPEN_CURSOR@salesdb;
DBMS_HS_PASSTHROUGH.PARSE@salesdb(c,
'UPDATE emp SET SAL=SAL*1.1 WHERE ename=?');
DBMS_HS_PASSTHROUGH.BIND_VARIABLE@salesdb(c,1,'JONES');
nr:=DBMS_HS_PASSTHROUGH.EXECUTE_NON_QUERY@salesdb(c);
DBMS_OUTPUT.PUT_LINE(nr||' rows updated');
DBMS_HS_PASSTHROUGH.CLOSE_CURSOR@salesdb(c);
END;

3.3.3.1.3 Using OUT Bind Variables

In some cases, the non-Oracle system can also support OUT bind variables. With OUT bind variables, the value of the bind variable is not known until after the execution of the SQL statement.

Although OUT bind variables are populated after the SQL statement is executed, the non-Oracle system must know that the particular bind variable is an OUT bind variable before the SQL statement is executed. You must use the BIND_OUT_VARIABLE procedure to specify that the bind variable is an OUT bind variable.

After the SQL statement is executed, you can retrieve the value of the OUT bind variable using the GET_VALUE procedure.

3.3.3.1.4 Using IN OUT Bind Variables

A bind variable can be both an IN and an OUT variable. This means that the value of the bind variable must be known before the SQL statement is executed but can be changed after the SQL statement is executed.

For IN OUT bind variables, you must use the BIND_INOUT_VARIABLE procedure to provide a value before the SQL statement is executed. After the SQL statement is executed, you must use the GET_VALUE procedure to retrieve the new value of the bind variable.

3.3.3.2 Executing Queries

The difference between queries and nonqueries is that queries retrieve a result set from a SELECT statement. The result set is retrieved by iterating over a cursor.

Figure 3-2 illustrates the steps in a passthrough SQL query. After the system parses the SELECT statement, each row of the result set can be fetched with the FETCH_ROW procedure. After the row is fetched, use the GET_VALUE procedure to retrieve the selected list of items into program variables. After all rows are fetched, you can close the cursor.

Figure 3-2 Passthrough SQL for Queries

You do not have to fetch all the rows. You can close the cursor at any time after opening the cursor.

Note:
Although you are fetching one row at a time, Heterogeneous Services optimizes the round-trips between the Oracle server and the non-Oracle system by buffering multiple rows and fetching from the non-Oracle data system in one round-trip.

The following example executes a query:

DECLARE
val  VARCHAR2(100);
c    INTEGER;
nr   INTEGER;
BEGIN
c := DBMS_HS_PASSTHROUGH.OPEN_CURSOR@salesdb;
DBMS_HS_PASSTHROUGH.PARSE@salesdb(c,
'select ENAME
from   EMP
where  DEPTNO=10');
LOOP
nr := DBMS_HS_PASSTHROUGH.FETCH_ROW@salesdb(c);
EXIT WHEN nr = 0;
DBMS_HS_PASSTHROUGH.GET_VALUE@salesdb(c, 1, val);
DBMS_OUTPUT.PUT_LINE(val);
END LOOP;
DBMS_HS_PASSTHROUGH.CLOSE_CURSOR@salesdb(c);
END;

After the SELECT statement has been parsed, the rows are fetched and printed in a loop until the FETCH_ROW function returns the value 0.

3.4 Result Set Support

Various relational databases allow stored procedures to return result sets. In other words, stored procedures will be able to return one or more sets of rows.

Traditionally, database stored procedures worked exactly like procedures in any high-level programming language. They had a fixed number of arguments which could be of types IN, OUT, or IN OUT. If a procedure had n arguments, it could return at most n values as results. However, suppose that you wanted a stored procedure to execute a query such as SELECT * FROM emp and return the results. The emp table might have a fixed number of columns but there is no way of telling, at procedure creation time, the number of rows it has. Because of this, no traditional stored procedure could be created that returned the results of a such a query. As a result, several relational database vendors added the capability of returning results sets from stored procedures, but each kind of relational database returns result sets from stored procedures in a different way.

Oracle has a data type called a REF CURSOR. Like every other Oracle data type, a stored procedure can take this data type as an IN or OUT argument. In Oracle, a stored procedure must have an output argument of type REF CURSOR. It then opens a cursor for a SQL statement and places a handle to that cursor in that output parameter. The caller can then fetch from the REF CURSOR the same way as from any other cursor.

Oracle can do a lot more than simply return result sets. REF CURSOR can be passed as an input argument to PL/SQL routines to be passed back and forth between client programs and PL/SQL routines or as an input argument between several PL/SQL routines.

This section contains the following topics:

- Result Set Support In Non-Oracle Systems

- Heterogeneous Services Support for Result Sets

3.4.1 Result Set Support In Non-Oracle Systems

Several non-Oracle systems allow stored procedures to return result sets but do so in completely different ways. Result sets are supported to some extent in DB2, Sybase, Microsoft SQL Server, and Informix. Result set support in these databases is based on one of the following two models.

3.4.1.1 Model 1: Result Set Support

When creating a stored procedure, you can explicitly specify the maximum number of result sets that can be returned by that stored procedure. While executing, the stored procedure can open anywhere from zero up to its prespecified maximum number of result sets. After the execution of the stored procedure, a client program obtains handles to these result sets by using either an embedded SQL directive or by calling a client library function. After that, the client program can fetch from the result set in the same way as from a regular cursor.

3.4.1.2 Model 2: Result Set Support

In this model, there is no prespecified limit to the number of result sets that can be returned by a stored procedure. Both Model 1 and Oracle have a limit. For Oracle, the number of result sets returned by a stored procedure can be at most the number of REF CURSOR OUT arguments. For Model 1, the upper limit is specified using a directive in the stored procedure language. Another way that Model 2 differs from Oracle and Model 1 is that they do not return a handle to the result sets but instead place the entire result set on the wire when returning from a stored procedure. For Oracle, the handle is the REF CURSOR OUT argument. For Model 1, it is obtained separately after the execution of the stored procedure. For both Oracle and Model 1, once the handle is obtained, data from the result set is obtained by doing a fetch on the handle; there are several cursors open and the fetch can be in any order. In the case of Model 2, however, all the data is already on the wire, with the result sets coming in the order determined by the stored procedure and the output arguments of the procedures coming at the end. So the whole of the first result set must be fetched, then the whole of the second one, until all of the results have been fetched. Finally, the stored procedure OUT arguments must be fetched.

3.4.2 Heterogeneous Services Support for Result Sets

As can be seen in the preceding sections, result set support exists among non-Oracle databases in a variety of forms. All of these have to be mapped onto the Oracle REF CURSOR model. Due to the considerable differences in behavior among the various non-Oracle systems, Heterogeneous Services result set support behaves in one of two different ways depending on the non-Oracle system to which it is connected.

Please note the following about Heterogeneous Services result set support:

- Result set support is present in Heterogeneous Services generic code but in order for the feature to work in a gateway, the driver has to implement it as well. Not all drivers have implemented result set support and you should check in the gateway-specific documentation to determine whether it is supported in your gateway.

- Heterogeneous Services supports REF CURSOR OUT arguments from stored procedures. IN and IN OUT arguments are not supported.

- The REF CURSOR OUT arguments are all anonymous REF CURSORs. No typed REF CURSORs are returned by Heterogeneous Services.

3.4.2.1 Results Sets: Cursor Mode

Each result set returned by the non-Oracle system stored procedure is mapped by the Oracle driver to an OUT argument of type REF CURSOR. The client program sees a stored procedure with several OUT arguments of type REF CURSOR. After executing the stored procedure, the client program can fetch from the REF CURSOR in the same way as it would from a REF CURSOR returned by an Oracle stored procedure. When connecting to the gateway as described in Section 3.4.1.1, Heterogeneous Services will be in cursor mode.

3.4.2.2 Result Sets: Sequential Mode

In Oracle, there is a prespecified maximum number of result sets that a particular stored procedure can return. The number of result sets returned is at most the number of REF CURSOR OUT arguments for the stored procedure. It can return fewer result sets, but it can never return more.

For the system described in Section 3.4.1.2, there is no prespecified maximum number of result sets that can be returned. In the case of Model 1 (in Section 3.4.1.1), we know the maximum number of result sets that a procedure can return, and that the driver can return to Heterogeneous Services, is prespecified in the stored procedure by the number of REF CURSOR OUT arguments. If, on execution of the stored procedure, fewer result sets than the maximum are returned, then the other REF CURSOR OUT arguments are set to NULL.

Another problem for Model 2 database servers is that result sets have to be retrieved in the order in which they were placed on the wire by the database. This prevents Heterogeneous Services from running in cursor mode when connecting to these databases. To access result sets returned by these stored procedures, you must operate Heterogeneous Services in sequential mode.

In sequential mode, the procedure description returned by the driver contains the following:

- All the input arguments of the remote stored procedure

- None of the output arguments

- One OUT argument of type REF CURSOR (corresponding to the first result set returned by the stored procedure)

The client fetches from this REF CURSOR and then calls the virtual package function DBMS_HS_RESULT_SET.GET_NEXT_RESULT_SET to fetch the REF CURSOR corresponding to the next result set. This function call is repeated until all result sets have been fetched. The last result set returned will actually be the OUT arguments of the remote stored procedure.

The major limitations of sequential mode are as follows:

- Result sets returned by a remote stored procedure have to be retrieved in the order in which they were placed on the wire.

- On execution of a stored procedure, all result sets returned by a previously executed stored procedure are closed (regardless of whether the data has been completely fetched or not).

See Also:
Your gateway-specific manual for more information about how result sets are supported through the gateway

3.5 Data Dictionary Translations

Most database systems have some form of data dictionary. A data dictionary is a collection of information about the database objects that have been created by various users of the system. For a relational database, a data dictionary is a set of tables and views which contain information about the data in the database. This information includes information on the users who are using the system and on the objects that they have created (such as tables, views, and triggers). For the most part, all data dictionaries (regardless of the database system) contain the same information but each database system organizes the information in a different way.

For example, the ALL_CATALOG Oracle data dictionary view gives a list of tables, views, and sequences in the database. It has three columns: the first is called OWNER and is the name of the owner of the object, the second is called TABLE_NAME and is the name of the object, and the third is called TABLE_TYPE and is the type. This field has value TABLE, VIEW, SEQUENCE and so forth depending on the object type. However, in Sybase, the same information is stored in two tables called sysusers and sysobjects whose column names are quite different from those of the Oracle ALL_CATALOG table. Additionally, in Oracle, the table type is a string with a value such as TABLE or VIEW. In Sybase, it is a letter. For example, in Sybase, U means user table, S means system table, V means view, and so forth.

If the client program wants information from the table ALL_CATALOG at Sybase, it sends a query referencing ALL_CATALOG@database_link to a gateway. Heterogeneous Services translates this query to an appropriate query on systables and then sends the translated query to Sybase. For example:

SELECT SU."name" OWNER, SO."name" TABLE_NAME,
DECODE(SO."type", 'U ','TABLE', 'S ', 'TABLE', 'V ', 'VIEW')
TABLE_TYPE
FROM "dbo"."sysusers"@remote_db  SU, "dbo"."sysobjects"@remote_db SO
WHERE SU."uid" = SO."uid" AND
(SO."type" = 'V' OR SO."type" = 'S' OR SO."type" = 'U');

To relay the translation of a query on an Oracle data dictionary table to the equivalent one on the non-Oracle system data dictionary table, Heterogeneous Services needs data dictionary translations for that non-Oracle system. A data dictionary translation is a view definition (essentially a SELECT statement) of one or more non-Oracle system data dictionary tables that look exactly like the Oracle data dictionary table, with the same column names and the same information formatting. A data dictionary translation may not be as simple as the preceding example. Often the information needed is scattered over many tables and the data dictionary translation is a complex join of those tables.

In some cases, an Oracle data dictionary table does not have a translation because the information needed does not exist at the non-Oracle system. In such cases, the gateway can decide not to upload a translation at all or can resort to an alternative approach called mimicking. If the gateway wants to mimic a data dictionary table, it will let Heterogeneous Services know and Heterogeneous Services will obtain the description of the data dictionary table by querying the local database but when asked to fetch data, it will report that no rows were selected.

3.6 Datetime Data Types

Oracle has five datetime data types:

- TIMESTAMP

- TIMESTAMP WITH TIME ZONE

- TIMESTAMP WITH LOCAL TIME ZONE

- INTERVAL YEAR TO MONTH

- INTERVAL DAY TO SECOND

Heterogeneous Services generic code supports Oracle datetime data types in SQL and stored procedures. Heterogeneous Services do not support these data types in data dictionary translations or queries involving data dictionary translations.

Even though Heterogeneous Services generic code supports this, support for a particular gateway depends on whether or not the driver for that non-Oracle system has implemented datetime support. Support, even when the driver implements it, may be partial because of the limitations of the non-Oracle system. You should consult the documentation for your particular gateway on this issue.

You must set the timestamp formats of the non-Oracle system in the gateway initialization file. The parameters to set are HS_NLS_TIMESTAMP_FORMAT and HS_NLS_TIMESTAMP_TZ_FORMAT. You should also set the local time zone for the non-Oracle system in the initialization file by setting HS_TIME_ZONE.

See Also:
Oracle Database SQL Language Reference for information about datetime data types

3.7 Two-Phase Commit Protocol

Heterogeneous Services provides the infrastructure for the implementation of the two-phase commit mechanism. The extent to which this is supported depends on the gateway and the remote system. Refer to individual gateway manuals for more information.

See Also:
Oracle Database Administrator's Guide for more information about the two-phase commit protocol

3.8 Piecewise LONG Data Type

Earlier versions of gateways had limited support for the LONG data type. LONG is an Oracle data type that can be used to store up to 2 gigabytes (GB) of character data or raw data (LONG RAW). These earlier versions restricted the amount of LONG data to 4 MB because they treated LONG data as a single piece. This led to restrictions of memory and network bandwidth on the size of the data that could be handled. Current gateways have extended the functionality to support the full 2 GB of heterogeneous LONG data. They handle the data piecewise between the agent and the Oracle server, thereby doing away with the large memory and network bandwidth requirements.

The HS_LONG_PIECE_TRANSFER_SIZE Heterogeneous Services initialization parameter can be used to set the size of the transferred pieces. For example, consider fetching 2 GB of LONG data from a heterogeneous source. A smaller piece size means less memory requirement, but more round-trips to fetch all the data. A larger piece size means fewer round-trips, but more of a memory requirement to store the intermediate pieces internally. Thus the initialization parameter can be used to tune a system for the best performance, that is, for the best trade off between round-trips and memory requirements. If the initialization parameter is not set, the system defaults to a piece size of 64 KB.

Note:
Do not confuse this feature with piecewise operations on LONG data on the client side. Piecewise fetch and insert operations on the client side did work with the earlier versions of the gateways, and continue to do so. The only difference on the client side is that, where earlier versions of the gateways were able to fetch a maximum of 4 megabytes (MB) of LONG data, now they can fetch the entire 2 GB of LONG data. This is a significant improvement, considering that 4 MB is only 0.2% of the data type's full capacity.

3.9 SQL*Plus DESCRIBE Command

You can describe non-Oracle system objects using the SQL*Plus DESCRIBE command. However, there are some limitations. For example, using heterogeneous links, you cannot describe packages, sequences, synonyms, or types.

3.10 Constraints on SQL in a Distributed Environment

This section explains some of the constraints on SQL in a distributed environment. These constraints apply to distributed environments that access non-Oracle systems or remote Oracle databases.

This section contains the following topics:

- Remote and Heterogeneous References

- Important Restrictions

3.10.1 Remote and Heterogeneous References

Note:
Many of the rules for heterogeneous access also apply to remote references. For more information, please see the distributed database section of the Oracle Database Administrator's Guide.

A statement can, with restrictions, be executed on any database node referenced in the statement or the local node. If all objects referenced are resolved to a single, referenced node, Oracle attempts to execute a query at that node. You can force execution at a referenced node by using the /*+ REMOTE_MAPPED */ or /*+ DRIVING_SITE */ hints. If a statement is forwarded to a node other than the node from where the statement was issued, the statement is said to be remote-mapped.

There is complete data type checking support for remote-mapped statements. The result provides consistent data type checking and complete data type coercion.

See Also:
Section 4.5, "Oracle Database Server SQL Construct Processing"

The ways in which statements can be remote-mapped are subject to specific rules or restrictions. If these rules are not followed, an error occurs. As long as the statements issued are consistent with all these rules, the order in which the rules are applied does not matter. See Section 3.10.2 for these rules or restrictions.

Different constraints exist when you are using SQL for remote mapping in a distributed environment. This distributed environment can include remote Oracle databases as well as non-Oracle databases that are accessed through Oracle Database Gateways.

3.10.2 Important Restrictions

The following section lists some of the different rules or restrictions that exist when you are using SQL for remote mapping in a distributed environment.

Note:
In the examples that follow, remote_db refers to a remote non-Oracle system while remote_oracle_db refers to a remote Oracle server.

Rule A: A data definition language statement cannot be remote-mapped.

In Oracle data definition language, the target object syntactically has no place for a remote reference. Data definition language statements that contain remote references are always executed locally. For Heterogeneous Services, this means it cannot directly create database objects in a non-Oracle database using SQL.

However, there is an indirect way using passthrough SQL as shown in the following example:

DECLARE
num_rows INTEGER;
BEGIN
num_rows := DBMS_HS_PASSTHROUGH.EXECUTE_IMMEDIATE@remote_db
(
'create table x1 (c1 char, c2 int)'
);
END;

Rule B: INSERT, UPDATE and DELETE statements with a remote target table must be remote-mapped.

This rule is more restrictive for non-Oracle remote databases than for a remote Oracle database. This is because the remote system cannot fetch data from the originating Oracle database while executing data manipulation language (DML) statements targeting tables in a non-Oracle system.

For example, to insert all local employees from the local emp table to a remote non-Oracle emp table, use the following statement:

This statement is remote-mapped to the remote database. The remote-mapped statement sent to the remote database contains a remote reference back to the originating database for emp. Such a remote link received by the remote database is called a callback link.

Note:
Even though callback links are supported in generic Heterogeneous Services, they may not be implemented in all Heterogeneous Services agents. Refer to your database gateway documentation to determine if callback links work with the database gateway that you are using.

If callback links are not supported by a particular gateway, the previous INSERT statements returns the following error:

ORA-02025: all tables in the SQL statement must be at the remote database

The workaround is to write a PL/SQL block. For example:

DECLARE
CURSOR remote_insert IS SELECT * FROM emp;
BEGIN
FOR rec IN remote_insert LOOP
INSERT INTO emp@remote_db (empno, ename, deptno) VALUES (
rec.empno,
rec.ename,
rec.deptno
);
END loop;
END;

Another special case involves session-specific SQL functions such as USER, USERENV, and SYSDATE. These functions need to be executed at the originating site. A remote-mapped statement containing these functions contains a callback link. For a non-Oracle database for which callbacks are not supported, this can (by default) result in a restriction error.

For example, consider the following statement:

DELETE FROM emp@remote_db WHERE hiredate > sysdate;

The previous statement returns the following error message:

ORA-02070: database REMOTE_DB does not support special functions in this context

This can be resolved by replacing special functions with a bind variable. For example:

DELETE FROM emp@remote_db WHERE hiredate > :1;

Rule C: Object features like tables with nested table columns, ADT columns, Opaque columns, or Ref Columns cannot be remote-mapped.

Currently, these column types are not supported for heterogeneous access. Hence, this limitation is not directly encountered.

Rule D: SQL statements containing operators and constructs that are not supported at the remote site cannot be remote-mapped.

In the case of an INSERT, UPDATE, or DELETE, this means that the SQL statement cannot be executed (see Rule B). However, you might still be able to execute the SQL statement if the unsupported operator or construct can be executed through a callback link.

In the case of a SELECT, you can always execute a statement affected by this rule as long as none of the remaining rules require the statement to be remote mapped. The SELECT statements affected by this rule are executed by fetching all the necessary data through a remote SELECT operation, and processing the unsupported operator or construct locally using the local SQL engine.

A remote SELECT operation is the operation that retrieves rows from the remote table as opposed to an operation that retrieves data from the local table. In the worse possible case of a remote SELECT, Oracle does a full table scan. A full table scan is a fetch of all the data in the remote table across the network without any filtering (for example, SELECT * FROM EMP).

Full table scans are expensive and, therefore, Oracle attempts to avoid them. If there are indexes on the remote table that can be used, these indexes are used in a WHERE clause predicate to reduce the number of rows fetched across the network.

You can check the SQL statement generated by the Oracle server by explaining the statement and querying the OTHER column of the explain plan table for each REMOTE operation.

See Also:
Section 3.11.1 for more information on how to interpret explain plans with remote references

For example, consider the following statement:

SELECT COUNT(*) FROM emp@remote_db WHERE hiredate < sysdate;

The statement returns the following output:

COUNT(*)
----------
14
1 row selected.

The remote table scan is:

SELECT hiredate FROM emp;

The predicate converted to a filter cannot be generated back and passed down to the remote operation because sysdate is not supported by the remote_db or evaluation rules. Thus sysdate must be executed locally.

Note:
Because the remote table scan operation is only partially related to the original query, the number of rows retrieved can be significantly larger than expected and can have a significant impact on performance.

Rule E: SQL statement containing a table expression cannot be remote-mapped.

This limitation is not directly encountered because table expressions are not supported in the heterogeneous access module.

Rule F: If a SQL statement selects LONG data, the statement must be mapped to the node where the table containing the LONG data resides.

Consider the following type of statement:

SELECT long1 FROM table_with_long@remote_db, dual;

The previous statement returns the following error message (if callback links are not supported):

ORA-02025: all tables in the SQL statement must be at the remote database

Rule G: The statement must be mapped to the node on which the table or tables with columns referenced in the FOR UPDATE OF clause resides when the SQL statement is of form "SELECT...FOR UPDATE OF..."

When the SQL statement is of the form SELECT...FOR UPDATE OF..., the statement must be mapped to the node on which the table or tables with columns referenced in the FOR UPDATE OF clause resides.

For example, consider the following statement:

SELECT ename FROM emp@remote_db WHERE hiredate < sysdate FOR UPDATE OF empno;

The previous statement returns the following error message if it cannot be remote-mapped:

ORA-02070: database REMOTE_DB does not support special functions in this context

Rule H: If the SQL statement contains a SEQUENCE or sequences, then the statement must be mapped to the site where each sequence resides.

This rule is not encountered for the heterogeneous access module because remote non-Oracle sequences are not supported.

Rule I: If the statement contains a user-defined operator or operators, then the statement must be mapped to the node where each operator is defined.

If the statement contains a user-defined operator, the entire statement needs to be remote-mapped to the database node where the operator is defined.

Rule J: A statement containing duplicate bind variables cannot be remote-mapped.

The workaround for this restriction is to use unique bind variables and bind by number.

3.11 Using Oracle's Optimizer with Heterogeneous Services

Oracle's optimizer can be used with Heterogeneous Services. Heterogeneous Services collects certain table and index statistics information on the respective non-Oracle system tables and passes this information back to the Oracle server. The Oracle cost-based optimizer uses this information when building the query plan.

There are several other optimizations that the cost-based optimizer performs. The most important ones are remote sort elimination and remote joins.

This section contains the following topics:

- Example: Using Index and Table Statistics

- Example: Remote Join Optimization

- Optimizer Restrictions for Non-Oracle Access

3.11.1 Example: Using Index and Table Statistics

Consider the following statement where you create a table in the Oracle database with 10 rows:

CREATE TABLE T1 (C1 number);

Analyze the table using the DBMS_STATS package. For example:

DBMS_STATS.GATHER_TABLE_STATS ('SCOTT','T1');
DBMS_STATS.GENERATE_STATS ('SCOTT','T1');

The preceding example assumes the schema name is SCOTT and the table name is T1. See the Oracle Database PL/SQL Packages and Types Reference for more information about the DBMS_STATS package.

Create a table in the non-Oracle system with 1000 rows.

Issue the following SQL statement:

SELECT a.* FROM remote_t1@remote_db a, T1 b
WHERE a.C1 = b.C1;

The Oracle optimizer issues the following SQL statement to the agent:

SELECT C1 FROM remote_t1@remote_db;

This fetches all 1000 rows from the non-Oracle system and performs the join in the Oracle database.

If we add a unique index on the column C1 in the table remote_t1, and issue the same SQL statement again, the agent receives the following SQL statement for each value of C1 in the local t1:

...
SELECT C1 FROM remote_t1@remote_db WHERE C1 = ?;
...

Note:
? is the bind parameter marker. Also, join predicates containing bind variables generated by Oracle are generated only for nested loop join methods.

To verify the SQL execution plan, generate an explain plan for the SQL statement. First, load utlxplan in the admin directory.

Enter the following:

EXPLAIN PLAN FOR SELECT a.* FROM remote_t1@remote_db a, T1 b
WHERE a.C1 = b.C1;

Execute the utlxpls utility script by entering the following statement.

@utlxpls

OPERATION REMOTE indicates that remote SQL is being referenced.

To find out what statement is sent, enter the following statement:

SELECT ID, OTHER FROM PLAN_TABLE WHERE OPERATION = 'REMOTE';

3.11.2 Example: Remote Join Optimization

The following is an example of the remote join optimization capability of the Oracle database.

Note:
The explain plan that uses tables from a non-Oracle system can differ from similar statements with local or remote Oracle table scans. This is because of the limitation on the statistics available to Oracle for non-Oracle tables. Most importantly, column selectivity is not available for non-unique indexes of non-Oracle tables. Because of the limitation of the statistics available, the following example is not necessarily what you encounter when doing remote joins and is intended for illustration only.

Consider the following example:

EXPLAIN PLAN FOR
SELECT e.ename, d.dname, f.ename, f.deptno FROM
dept d,
emp@remote_db e,
emp@remote_db f
WHERE e.mgr = f.empno
AND e.deptno = d.deptno
AND e.empno = f.empno;

@utlxpls

You should see output similar to the following:

PLAN_TABLE_OUTPUT
--------------------------------------------------------------------------------

---------------------------------------------------------------------------
| Id    | Operation                           | Name  | Rows  | Bytes  | Cost
| Inst  |IN-OUT|
---------------------------------------------------------------------------
|   0   | SELECT STATEMENT   |                |  2000   |   197K|   205 |
|*  1   | HASH JOIN          |                |  2000   |   197K|
205 |
|   2   | TABLE ACCESS FULL  | DEPT           |  21     |   462 |     2 |
|*  3   | HASH JOIN          |                |  2000   |   154K|
201 |
|   4   | REMOTE             |                |  2000   | 66000
|    52 |
|   5   | REMOTE             |                |  2000   | 92000
|    52 |
---------------------------------------------------------------------------

PLAN_TABLE_OUTPUT
--------------------------------------------------------------------------------

Query Block Name / Hint Alias (identified by operation id):
-----------------------------------------------------------

1 - sel$1 / D
2 - sel$1 / D
3 - sel$1 / F
4 - sel$1 / F
5 - sel$1 / E

Predicate Information (identified by operation id):

PLAN_TABLE_OUTPUT
--------------------------------------------------------------------------------

---------------------------------------------------

1 - access("E"."DEPTNO"="D"."DEPTNO")
3 - access("E"."MGR"="F"."EMPNO" AND "E"."EMPNO"="F"."EMPNO")

Issue the following statement:

SET long 300
SELECT other FROM plan_table WHERE operation = 'REMOTE';

You should see output similar to the following:

OTHER
--------------------------------------------------------------------------------

SELECT "EMPNO","ENAME","DEPTNO" FROM "EMP"
SELECT "EMPNO","ENAME","MGR","DEPTNO" FROM "EMP"
SELECT "EMPNO","ENAME","DEPTNO" FROM "EMP"
SELECT "EMPNO","ENAME","MGR","DEPTNO" FROM "EMP"

3.11.3 Optimizer Restrictions for Non-Oracle Access

The following are optimizer restrictions for non-Oracle system access:

- There are no column statistics for remote objects. This can result in poor execution plans. Verify the execution plan and use hints to improve the plan.

- There is no optimizer hint to force a remote join. However, there is a remote query block optimization that can be used to rewrite the query slightly in order to get a remote join.

The example from the previous section can be rewritten to the following form:

SELECT v.ename, d.dname, d.deptno FROM dept d,
(SELECT /*+ NO_MERGE */
e.deptno deptno, e.ename ename emp@remote_db e, emp@remote_db f
WHERE e.mgr = f.empno
AND e.empno = f.empno;
)
WHERE v.deptno = d.deptno;

This example guarantees a remote join because it has been isolated in a nested query with the NO_MERGE hint.

4 Using Heterogeneous Services Agents

This chapter explains how to use Heterogeneous Services (HS) agents. For installing and configuring the agents, refer to the Oracle Database Gateway installation and configuration guides. This chapter contains the following sections:

- Initialization Parameters

- Optimizing Data Transfers Using Bulk Fetch

- Optimizing Data Loads Using Parallel Load

- Registering Agents

- Oracle Database Server SQL Construct Processing

- Executing User-Defined Functions on a Non-Oracle Database

- Using Synonyms

- Copying Data from the Oracle Database Server to the Non-Oracle Database System

- Copying Data from the Non-Oracle Database System to the Oracle Database Server

- Using Heterogeneous Services Data Dictionary Views

- Using the Heterogeneous Services Dynamic Performance Views

4.1 Initialization Parameters

Configure the gateway using initialization parameters. This is done by creating an initialization file and setting the desired parameters in this file. See Section 2.5 for configuration information.

Heterogeneous Services initialization parameters are distinct from Oracle database server initialization parameters. Heterogeneous Services initialization parameters are set in the Heterogeneous Services initialization file and not in the Oracle database initialization parameter file (init.ora file). There is a Heterogeneous Services initialization file for each gateway instance.

The following sections describe:

- Encrypting Initialization Parameters

- Gateway Initialization Parameters

4.1.1 Encrypting Initialization Parameters

Initialization parameters may contain sensitive information, such as user IDs or passwords. Initialization parameters are stored in plain text files and are insecure. An encryption feature has been added to Heterogeneous Services making it possible to encrypt parameter values. This is done through the dg4pwd utility. To use this feature requires setting the value of a parameter in the initialization file to an unquoted asterisk (*). For example:

HD_FDS_CONNECT_INFO = *
With the value set to this security marker, all Heterogeneous Services agents know that the real value will be stored in a related, encrypted password file. The name of this file will be initsid.pwd, where sid is the Oracle system identifier used for the gateway. This file is created by the dg4pwd utility in the current directory containing the initialization file. Running the utility prompts for the real value of the parameter, which the utility will encrypt and store in the password file. It should be noted that encrypted initialization parameters are implicitly treated as PRIVATE parameters and are not uploaded to the server.

4.1.1.1 Using the dg4pwd Utility

The dg4pwd utility is used to encrypt initialization parameters that would normally be stored in the initialization parameter file in plain text. The utility works by reading the initialization parameter file in the current directory and looking for parameters having a security marker for the value. The security marker is an unquoted asterisk (*). This designates that the value of this parameter is to be stored in an encrypted form in a password file. The following is an example of an initialization parameter set to this value:

HS_FDS_CONNECT_INFO = *

The initialization parameter file in the current directory is first edited to set the value of the parameter to this security marker. Then the utility is run, specifying the gateway SID on the command line, with an optional user ID to designate a different owner of the encrypted information. The utility reads the initialization parameter file and prompts you to enter the real values that are to be encrypted. The syntax of the command is:

dg4pwd [sid] {userid}

Where [sid] is the SID of the gateway and {userid} is an optional user ID used to encrypt the contents. If no user ID is specified, then the current user's ID is used. Values are encrypted using this ID. In order to decrypt the values, the agent must be run as that user. The following example assumes a gateway SID of SYBASE:

dg4pwd SYBASE
ORACLE Gateway Password Utility
Constructing password file for Gateway SID SYBASE
Enter the value for HS_FDS_CONNECT_INFO
sybasew

In the previous example, the initialization parameter file, initSYBASE.ora, is read. The parameter, HS_FDS_CONNECT_INFO, is identified as requiring encryption. Enter the value (for example, sybasew) and presses enter. If more parameters require encryption, they are prompted for in turn. The encrypted data is stored in the same directory as the initialization file.Any initialization parameters needing encryption should be encrypted before using the Oracle Database Gateway.

4.1.2 Gateway Initialization Parameters

Gateway initialization parameters can be divided into two groups. One is a set of generic initialization parameters that are common to all gateways and the other is a set of initialization parameters that are specific to individual gateways. The following generic initialization parameters are the only initialization parameters discussed in this document:

HS_BULK
HS_CALL_NAME
HS_COMMIT_POINT_STRENGTH
HS_DB_DOMAIN
HS_DB_INTERNAL_NAME
HS_DB_NAME
HS_DESCRIBE_CACHE_HWM
HS_FDS_CONNECT_INFO
HS_FDS_DEFAULT_SCHEMA_NAME
HS_FDS_SHAREABLE_NAME
HS_FDS_TRACE_LEVEL
HS_LANGUAGE
HS_LONG_PIECE_TRANSFER_SIZE
HS_NLS_DATE_FORMAT
HS_NLS_DATE_LANGUAGE
HS_NLS_NCHAR
HS_NLS_NUMERIC_CHARACTERS
HS_NLS_TIMESTAMP_FORMAT
HS_NLS_TIMESTAMP_TZ_FORMAT
HS_OPEN_CURSORS
HS_ROWID_CACHE_SIZE
HS_RPC_FETCH_REBLOCKING
HS_RPC_FETCH_SIZE
HS_TIME_ZONE

Do not use the PRIVATE keyword when setting any of these parameters. Using the PRIVATE keyword prevents the parameter from being uploaded to the server and can cause errors in SQL processing. None of these parameters needs to be set in the environment, so you do not need to use the SET keyword.

See Also:
Individual gateway documentation for the list of initialization parameters specific to a gateway

4.2 Optimizing Data Transfers Using Bulk Fetch

When an application fetches data from a non-Oracle system using Heterogeneous Services, data is transferred:

1. From the non-Oracle system to the agent process.

2. From the agent process to the Oracle database server.

3. From the Oracle database server to the application.

Oracle optimizes all three data transfers, as illustrated in Figure 4-1.

Figure 4-1 Optimizing Data Transfers

This section contains the following topics:

- Using OCI, an Oracle Precompiler, or Another Tool for Array Fetches

- Controlling the Array Fetch Between the Oracle Database Server and the Agent

- Controlling the Array Fetch Between Agent and Non-Oracle Server

- Controlling the Reblocking of Array Fetches

4.2.1 Using OCI, an Oracle Precompiler, or Another Tool for Array Fetches

You can optimize data transfers between your application and the Oracle server by using array fetches. See your application development tool documentation for information about array fetching and how to specify the amount of data to be sent and each network round-trip.

4.2.2 Controlling the Array Fetch Between the Oracle Database Server and the Agent

When Oracle retrieves data from a non-Oracle system, the Heterogeneous Services initialization parameter, HS_RPC_FETCH_SIZE, defines the number of bytes sent for each fetch between the agent and the Oracle server. The agent fetches data from the non-Oracle system until one of the following occurs:

- It has accumulated the specified number of bytes to send back to the Oracle database server.

- The last row of the result set is fetched from the non-Oracle system.

4.2.3 Controlling the Array Fetch Between Agent and Non-Oracle Server

The initialization parameter, HS_FDS_FETCH_ROWS, determines the number of rows to be retrieved from a non-Oracle system. Note that the array fetch must be supported by the agent. See your agent-specific documentation to ensure that your agent supports array fetching.

4.2.4 Controlling the Reblocking of Array Fetches

By default, an agent fetches data from the non-Oracle system until it has enough data retrieved to send back to the server. It continues until the number of bytes fetched from the non-Oracle system is equal to or higher than the value of HS_RPC_FETCH_SIZE initialization parameter. In other words, the agent reblocks the data between the agent and the Oracle database server in sizes defined by the value of the HS_RPC_FETCH_SIZE initialization parameter.

When the non-Oracle system supports array fetches, you can immediately send the data fetched from the non-Oracle system by the array fetch to the Oracle database server without waiting until the exact value of the HS_RPC_FETCH_SIZE initialization parameter is reached. That is, you can stream the data from the non-Oracle system to the Oracle database server and disable reblocking by setting the value of the HS_RPC_FETCH_REBLOCKING initialization parameter to OFF.

For example, assume that you set HS_RPC_FETCH_SIZE to 64 kilobytes (KB) and HS_FDS_FETCH_ROWS to 100 rows. Also assume that each row is approximately 600 bytes in size, so that the 100 rows are approximately 60 KB. When the HS_RPC_FETCH_REBLOCKING initialization parameter is set to ON, the agent starts fetching 100 rows from the non-Oracle system.

Because there is only 60 KB of data in the agent, the agent does not send the data back to the Oracle database server. Instead, the agent fetches the next 100 rows from the non-Oracle system. Because there is now 120 KB of data in the agent, the first 64 KB can be sent back to the Oracle database server.

Now there is 56 KB of data left in the agent. The agent fetches another 100 rows from the non-Oracle system before sending the next 64 KB of data to the Oracle database server. By setting the HS_RPC_FETCH_REBLOCKING initialization parameter to OFF, the first 100 rows are immediately sent back to the Oracle database server.

4.3 Optimizing Data Loads Using Parallel Load

The DBMS_HS_PARALLEL PL/SQL package enables parallel processing for heterogeneous targets access. This package improves performance when retrieving data from a large foreign table.

DBMS_HS_PARALLEL is compiled with an authorization ID of CURRENT_USER, meaning it uses invoker's rights. In other words, all procedures in this package are executed with the privileges of the calling user.

For additional information about the procedures, see Oracle Database PL/SQL Packages and Types Reference.

4.4 Registering Agents

Registration is an operation through which Oracle stores information about an agent in the data dictionary. Agents do not have to be registered. If an agent is not registered, Oracle stores information about the agent in memory instead of in the data dictionary. When a session involving an agent terminates, this information ceases to be available.

Self-registration is an operation in which a database administrator sets an initialization parameter that lets the agent automatically upload information into the data dictionary. Self-registration occurs when the HS_AUTOREGISTER initialization parameter is set to TRUE (default).

Note:
HS_AUTOREGISTER is an Oracle initialization parameter that you set in the init.ora file; it is not a Heterogeneous Services initialization parameter that is set in the gateway initialization file.

This section contains the following topics:

- Enabling Agent Self-Registration

- Disabling Agent Self-Registration

4.4.1 Enabling Agent Self-Registration

To ensure correct operation over heterogeneous database links, agent self-registration automates updates to Heterogeneous Services configuration data that describe agents on remote hosts. Agent self-registration is the default behavior. If you do not want to use the agent self-registration feature, set the HS_AUTOREGISTER initialization parameter to FALSE.

Both the server and the agent rely on three types of information to configure and control operation of the Heterogeneous Services connection. These three sets of information are collectively called HS configuration data:

Heterogeneous Services Configuration Data

Description

Heterogeneous Services initialization parameters

Provide control over various connection-specific details of operation.

Capability definitions

Identify details like SQL language features supported by the non-Oracle data source.

Data dictionary translations

Map references to Oracle data dictionary tables and views into equivalents specific to the non-Oracle data source.

See Also:
Section 4.4.1.3, "Specifying HS_AUTOREGISTER"

4.4.1.1 Using Agent Self-Registration to Avoid Configuration Mismatches

HS configuration data is stored in the data dictionary of the Oracle database server. Because the agent may be remote and may therefore be administered separately, several circumstances can lead to configuration mismatches between servers and agents. For example:

- An agent can be newly installed on a separate computer so that the server has no Heterogeneous Services data dictionary content to represent the agent's Heterogeneous Services configuration data.

- A server can be newly installed and lack the necessary Heterogeneous Services configuration data for existing agents and non-Oracle data stores.

- A non-Oracle instance can be upgraded from an older version to a newer version, requiring modification of the Heterogeneous Services configuration data.

- A Heterogeneous Services agent at a remote site can be upgraded to a new version or patched, requiring modification of the Heterogeneous Services configuration data.

- A database administrator (DBA) at the non-Oracle site can change the agent setup, possibly for tuning or testing purposes, in a manner which affects Heterogeneous Services configuration data.

Agent self-registration permits successful operation of Heterogeneous Services in all these scenarios. Specifically, agent self-registration enhances interoperability between any Oracle database server and any Heterogeneous Services agent (if each is Version 8.0.3 or higher). The basic mechanism for this functionality is the ability to upload Heterogeneous Services configuration data from agents to servers.

Self-registration provides automatic updating of Heterogeneous Services configuration data residing in the Oracle database server data dictionary. This update ensures that the agent self-registration uploads need to be done only once, on the initial use of a previously unregistered agent. Instance information is uploaded on each connection, not stored in the server data dictionary.

4.4.1.2 Understanding Agent Self-Registration

The Heterogeneous Services agent self-registration feature can perform the following tasks:

- Identify the agent and the non-Oracle data store to the Oracle database server

- Permit agents to define Heterogeneous Services initialization parameters for use both by the agent and connected Oracle servers

- Upload capability definitions and data dictionary translations, if available, from a Heterogeneous Services agent during connection initialization

Note:
The upload of class information occurs only when the class is undefined in the server data dictionary. Similarly, instance information is uploaded only if the instance is undefined in the server data dictionary.

The information required for agent self-registration is accessed in the server data dictionary by using these agent-supplied names:

- FDS_CLASS

- FDS_CLASS_VERSION

See Also:
Section 4.10, "Using Heterogeneous Services Data Dictionary Views" to learn how to use the Heterogeneous Services data dictionary views

4.4.1.2.1 FDS_CLASS and FDS_CLASS_VERSION

FDS_CLASS and FDS_CLASS_VERSION are defined by Oracle or by third-party vendors for each individual Heterogeneous Services agent and version. Oracle Heterogeneous Services concatenates these names to form FDS_CLASS_NAME, which is used as a primary key to access class information in the server data dictionary.

FDS_CLASS should specify the type of non-Oracle data store to be accessed and FDS_CLASS_VERSION should specify a version number for both the non-Oracle data store and the agent that connects to it. Note that when any component of an agent changes, FDS_CLASS_VERSION must also change to uniquely identify the new release.

Note:
This information is uploaded when you initialize each connection.

4.4.1.2.2 FDS_INST_NAME

Instance-Specific Information can be stored in the server data dictionary. The instance name, FDS_INST_NAME, is configured by the database administrator (DBA) who administers the agent. How the DBA performs this configuration depends on the specific agent in use.

The Oracle database server uses FDS_INST_NAME to look up instance-specific configuration information in its data dictionary. Oracle uses the value as a primary key for columns of the same name in these views:

- FDS_INST_INIT

- FDS_INST_CAPS

- FDS_INST_DD

Server data dictionary accesses that use FDS_INST_NAME also use FDS_CLASS_NAME to uniquely identify configuration information rows. For example, if you port a database from class Sybase816 to class Sybase817, both databases can simultaneously operate with instance name SCOTT and use separate sets of configuration information.

Unlike class information, instance information is not automatically self-registered in the server data dictionary:

- If available, instance information is always uploaded by the agent. However, it is never stored in the server data dictionary. Instead, the information is kept in memory and it is only valid for that connection.

- If the server data dictionary contains instance information, it represents the DBA's defined setup details which correspond to the instance configuration. Data dictionary defined instance information takes precedence over class information. However, uploaded instance information takes precedence over data dictionary defined instance information.

4.4.1.3 Specifying HS_AUTOREGISTER

The HS_AUTOREGISTER Oracle database server initialization parameter enables or disables automatic self-registration of Heterogeneous Services agents. Note that this parameter is specified in the Oracle initialization parameter file, not the agent initialization file. For example, you can set the parameter as follows:

HS_AUTOREGISTER = TRUE

When set to TRUE, the agent uploads information describing a previously unknown agent class or a new agent version into the server's data dictionary.

Oracle recommends that you use the default value for this parameter (TRUE), which ensures that the server's data dictionary content always correctly represents definitions of class capabilities and data dictionary translations as used in Heterogeneous Services connections.

See Also:
Oracle Database Reference for a description of this parameter

4.4.2 Disabling Agent Self-Registration

To disable agent self-registration, set the HS_AUTOREGISTER initialization parameter as follows:

HS_AUTOREGISTER = FALSE

Disabling agent self-registration means that agent information is not stored in the data dictionary. Consequently, the Heterogeneous Services data dictionary views are not useful sources of information. Nevertheless, the Oracle server still requires information about the class and instance of each agent. If agent self-registration is disabled, the server stores this information in local memory.

4.5 Oracle Database Server SQL Construct Processing

Heterogeneous Services and the gateway rewrite SQL statements when the statements need to be translated or postprocessed.

For the following examples, assume the INITCAP function is not supported in the non-Oracle database. Consider a program that requests the following from the non-Oracle database. For example:

SELECT "COLUMN_A" FROM "test"@remote_db
WHERE "COLUMN_A" = INITCAP("COLUMN_B");

The non-Oracle database does not recognize the INITCAP function, so the Oracle database server fetches the data from the table test in the remote database and filters the results locally. The gateway rewrites the SELECT statement as follows:

SELECT "COLUMN_A", "COLUMN_B" FROM "test"@remote_db;

The results of the query are sent from the gateway to Oracle and are filtered by the Oracle database server.

If a string literal or bind variable is supplied in place of "COLUMN_B" as shown in the previous example, the Heterogeneous Services component of the Oracle server would apply the INITCAP function before sending the SQL command to the gateway. For example, if the following SQL command is issued:

SELECT "COLUMN_A" FROM "test"@remote_db WHERE "COLUMN_A" = INITCAP('jones');

The following SQL command would be sent to the gateway:

SELECT "COLUMN_A" FROM "test"@remote_db WHERE "COLUMN_A" = 'Jones';

Consider the following UPDATE request:

UPDATE "test"@remote_db SET "COLUMN_A" = 'new_value'
WHERE "COLUMN_A" = INITCAP("COLUMN_B");

In this case, the Oracle database server and the gateway cannot compensate for the lack of support at the non-Oracle side, so an error is issued.

If a string literal or bind variable is supplied in place of "COLUMN_B" as shown in the preceding example, the Heterogeneous Services component of the Oracle server would apply the INITCAP function before sending the SQL command to the gateway. For example, if the following SQL command is issued:

UPDATE "test"@remote_db SET "COLUMN_A" = 'new_value'
WHERE "COLUMN_A" = INITCAP('jones');

The following SQL command would be sent to the gateway:

UPDATE  "test"@remote_db SET "COLUMN_A" = 'new_value'
WHERE "COLUMN_A" = 'Jones';

In previous releases, the preceding UPDATE statement would have raised an error due to the lack of INITCAP function support in the non-Oracle database.

4.5.1 Data Type Checking Support for a Remote-Mapped Statement

The Oracle database has always performed data type checking and data type coercion in a homogeneous environment. For example, SELECT * FROM EMP WHERE EMPNO='7934' would return the same result as SELECT * FROM EMPNO WHERE EMPNO=7934. There is also full data type checking support for remote-mapped statements in a heterogeneous environment. In general, the operands in SQL statements whether its a column, literal, or bind variable would be processed internally for data type checking. Consider the following examples:

SELECT * FROM EMP@LINK WHERE NUMBER_COLUMN='123'
SELECT * FROM EMP@LINK WHERE NUMBER_COLUMN=CHAR_COLUMN;
SELECT * FROM EMP@LINK WHERE NUMBER_COLUMN=CHAR_BIND_VARIABLE;

Most non-Oracle databases do not support data type coercion, and the previous statements fail if they are sent to a non-Oracle database as is. The Heterogeneous Services component for the Oracle database performs data type checking and the necessary data type coercion before sending an acceptable statement to a non-Oracle database.

Data type checking provides consistent behavior on post-processed or remote-mapped statements. Consider the following two statements:

SELECT * FROM EMP@LINK WHERE TO_CHAR(EMPNO)='7933' + '1';

And:

SELECT * FROM EMP@LINK WHERE EMPNO='7933' + '1';

Both of the previous statements provide the same result and coercion regardless if the TO_CHAR function is supported in the non-Oracle database or not. Now, consider the following statement:

SELECT * FROM EMP@LINK WHERE EMPNO='123abc' + '1';

As data type checking is enforced, the coercion attempt within Oracle generates an error and returns it without sending any statements to a non-Oracle database.

In summary, there is consistent data type checking and coercion behavior regardless of post-processed or remote-mapped statements.

4.6 Executing User-Defined Functions on a Non-Oracle Database

You can execute user-defined functions in a remote non-Oracle database. For example:

SELECT getdeptforemp@Remote_DB(7782) FROM dual;

In this example, a SELECT statement was issued that executes a user-defined function in the remote database that returns department information for employee 7782.

When the remote function resides in an Oracle database, the Oracle database automatically ensures that the remote function does not update any database state (such as updating rows in a database or updating the PL/SQL package state). The gateway cannot verify this when the remote function resides in a non-Oracle database. Therefore, you are responsible for ensuring that the user-defined functions do not update the state in any database. Ensuring no updates to the database is required to guarantee read consistency.

As a security measure, you must specify the functions that you want to execute remotely and their owners in the HS_CALL_NAME parameter in the gateway-specific initialization parameter file. For example:

HS_CALL_NAME = "owner1.A1, owner2.A2 "

owner1 and owner2 are the remote function owner names. A1 and A2 are the remote function names. You do not need to specify the remote function owner in the SQL statement. By default, the remote function needs to reside in the schema that the Database Gateway connects to. If this is not the case, then you must specify the owner of the remote function in the SQL statement.

Some other examples of executing user-defined remote functions are as follows:

- A remote function in a subquery

The function uses the employee_id column data to retrieve the department_id from the EMPLOYEES table in the remote database. The outer query then determines all department numbers in the remote database that match the returned list.

SELECT * FROM departments@remotedb
WHERE department_id IN
(SELECT
getdeptforemp@remotedb (employee_id)
FROM employees@remotedb);

- Applying a local function to the result of a user-defined remote function

This query returns the maximum salary of all employees on the remote database.

SELECT max (getsalforemp@remotedb (employee_id))
FROM employees@remotedb;

- A DML statement

The statement uses the output from a user-defined query in the remote database to update the salary column with new salary information.

UPDDATE employee_history
SET salary = emp_changed_salary@remote_db;

In these examples, the Oracle database passes the function name and owner to the Database Gateway. The user-defined function is executed on the remote database.

4.7 Using Synonyms

You can provide complete data location transparency and network transparency by using the synonym feature of the Oracle database server. When a synonym is defined, you do not have to know the underlying table or network protocol. A synonym can be public, which means that all Oracle users can refer to the synonym. A synonym can also be defined as private, which means every Oracle user must have a synonym defined to access the non-Oracle table.

The following statement creates a systemwide synonym for the emp table in the schema of user ORACLE in the Sybase database:

CREATE PUBLIC SYNONYM emp FOR "ORACLE"."EMP"@SYBS;

See Also:
Oracle Database Administrator's Guide for information about synonyms

4.7.1 Example of a Distributed Query

Note:
Modify these examples for your environment. Do not try to execute them as they are written.

The following statement joins data between the Oracle database server, an IBM DB2 database, and a Sybase database:

SELECT O.CUSTNAME, P.PROJNO, E.ENAME, SUM(E.RATE*P."HOURS")
FROM ORDERS@DB2 O, EMP@ORACLE9 E, "PROJECTS"@SYBS P
WHERE O.PROJNO = P."PROJNO"
AND P."EMPNO" = E.EMPNO
GROUP BY O.CUSTNAME, P."PROJNO", E.ENAME;

Through a combination of views and synonyms, using the following SQL statements, the process of distributed queries is transparent:

CREATE SYNONYM ORDERS FOR ORDERS@DB2;
CREATE SYNONYM PROJECTS FOR "PROJECTS"@SYBS;
CREATE VIEW DETAILS (CUSTNAME,PROJNO,ENAME,SPEND)
AS
SELECT O.CUSTNAME, P."PROJNO", E.ENAME, SUM(E.RATE*P."HOURS")
SPEND
FROM ORDERS O, EMP E, PROJECTS P
WHERE O.PROJNO = P."PROJNO"
AND P."EMPNO" = E.EMPNO
GROUP BY O.CUSTNAME, P."PROJNO", E.ENAME;

Use the following SQL statement to retrieve information from the data stores in one statement:

SELECT * FROM DETAILS;

The statement retrieves the following table:

CUSTNAME         PROJNO           ENAME          SPEND
--------         ------           -----          -----
ABC Co.             1             Jones            400
ABC Co.             1             Smith            180
XYZ Inc.            2             Jones            400
XYZ Inc.            2             Smith            180

4.8 Copying Data from the Oracle Database Server to the Non-Oracle Database System

Heterogeneous Services supports callback links. This enables SQL statements like the following to be executed:

INSERT INTO table_name@dblink SELECT column_list FROM table_name;

Even though Heterogeneous Services supports the callback functionality, not all gateways have implemented it. If the gateway that you are using has not implemented this functionality, the preceding INSERT statement returns the following error message:

ORA-02025: All tables in the SQL statement must be at the remote database

See Also:
Your gateway documentation for information about support for callback links

For gateways that do not support callback links, you can use the SQL*Plus COPY command. The syntax is as follows:

COPY FROM username/password@db_name -
INSERT destination_table -
USING query;

The following example selects all rows from the local Oracle emp table, inserts them into the emp table on the non-Oracle database, and commits the transaction:

COPY FROM SCOTT/TIGER@inst1 -
INSERT EMP@remote_db -
USING SELECT * FROM EMP;

The COPY command supports the APPEND, CREATE, INSERT, and REPLACE options. However, INSERT is the only option supported when copying to non-Oracle databases. The SQL*Plus COPY command does not support copying to tables with lowercase table names. Use the following PL/SQL syntax with lowercase table names:
DECLARE
v1 oracle_table.column1%TYPE;
v2 oracle_table.column2%TYPE;
v3 oracle_table.column3%TYPE;
.
.
.
CURSOR cursor_name IS SELECT * FROM oracle_table;
BEGIN
OPEN cursor_name;
LOOP
FETCH cursor_name INTO v1, v2, v3, ... ;
EXIT WHEN cursor_name%NOTFOUND;
INSERT INTO destination_table VALUES (v1, v2, v3, ...);
END LOOP;

CLOSE cursor_name;
END;

See Also:
SQL*Plus User's Guide and Reference for more information about the COPY command

4.9 Copying Data from the Non-Oracle Database System to the Oracle Database Server

The CREATE TABLE statement lets you copy data from a non-Oracle database to the Oracle database. To create a table on the local database and insert rows from the non-Oracle table, use the following syntax:

CREATE TABLE table_name AS query;

The following example creates the table emp in the local Oracle database and inserts the rows from the EMP table of the non-Oracle database:

CREATE TABLE table1 AS SELECT * FROM "EMP"@remote_db;

Alternatively, you can use the SQL*Plus COPY command to copy data from the non-Oracle database to the Oracle database server.

See Also:
SQL*Plus User's Guide and Reference for more information about the COPY command

4.10 Using Heterogeneous Services Data Dictionary Views

You can use the Heterogeneous Services data dictionary views to access information about Heterogeneous Services. This section addresses the following topics:

- Understanding the Types of Views

- Understanding the Sources of Data Dictionary Information

- Using the General Views

- Using the Transaction Service Views

- Using the SQL Service Views

4.10.1 Understanding the Types of Views

The Heterogeneous Services data dictionary views, whose names all begin with the HS_ prefix, can be divided into the following categories:

- General views

- Views used for the transaction service

- Views used for the SQL service

Most of the data dictionary views are defined for both classes and instances. For most types of data there is a *_CLASS view and a *_INST view. See Table 4-1 for additional details.

Table 4-1 Data Dictionary Views for Heterogeneous Services

View

Type

Identifies

HS_BASE_CAPS

SQL service

All capabilities supported by Heterogeneous Services

HS_BASE_DD

SQL service

All data dictionary translation table names supported by Heterogeneous Services

HS_CLASS_CAPS

Transaction service, SQL service

Capabilities for each class

HS_CLASS_DD

SQL service

Data dictionary translations for each class

HS_CLASS_INIT

General

Initialization parameters for each class

HS_FDS_CLASS

General

Classes accessible from the Oracle server

HS_FDS_INST

General

Instances accessible from the Oracle server

HS_INST_CAPS

Transaction service, SQL service

Capabilities for each instance (if set up by the DBA)

HS_INST_DD

SQL service

Data dictionary translations for each class (if set up by the DBA)

HS_INST_INIT

General

Initialization parameters for each instance (if set up by the DBA)

HS_BULK

Data dictionary view to keep track of internal objects created with bulk load procedures.

Like all Oracle data dictionary tables, these views are read-only. Do not change the content of any of the underlying tables.

4.10.2 Understanding the Sources of Data Dictionary Information

The values used for data dictionary content in any particular connection on a Heterogeneous Services database link can come from any of the following sources, in order of precedence:

- Instance information uploaded by the connected Heterogeneous Services agent at the start of the session. This information overrides corresponding content in the Oracle data dictionary, but is never stored into the Oracle data dictionary.

- Instance information stored in the Oracle data dictionary. This data overrides any corresponding content for the connected class.

- Class information stored in the Oracle data dictionary.

If the Oracle database server runs with the HS_AUTOREGISTER server initialization parameter set to FALSE, then information is not stored automatically in the Oracle data dictionary. The equivalent data is uploaded by the Heterogeneous Services agent on a connection-specific basis each time a connection is made, with any instance-specific information taking precedence over class information.

Note:
It is not possible to determine positively what capabilities and what data dictionary translations are in use for a given session due to the possibility that an agent can upload instance information.

You can determine the values of Heterogeneous Services initialization parameters by querying the VALUE column of the V$HS_PARAMETER view. Note that the VALUE column of V$HS_PARAMETER truncates the actual initialization parameter value from a maximum of 255 characters to a maximum of 64 characters. It truncates the parameter name from a maximum of 64 characters to a maximum of 30 characters.

4.10.3 Using the General Views

The views that are common for all services are as follows:

View

Contains

HS_FDS_CLASS

Names of the classes that are uploaded into the Oracle data dictionary

HS_FDS_INST

Names of the instances that are uploaded into the Oracle data dictionary

HS_CLASS_INIT

Information about the Heterogeneous Services initialization parameters

For example, you can access multiple Sybase gateways from an Oracle database server. After accessing the gateways for the first time, the information uploaded into the Oracle database server could appear as follows:

SQL> SELECT * FROM HS_FDS_CLASS;

FDS_CLASS_NAME        FDS_CLASS_COMMENTS             FDS_CLASS_ID
--------------------- ------------------------------ ------------
Sybase816             Uses Sybase driver, R1.1                 1
Sybase817             Uses Sybase driver, R1.2                21

Two classes are uploaded: a class that accesses Sybase816 and a class that accesses Sybase817. The data dictionary in the Oracle database server now contains capability information, SQL translations, and data dictionary translations for both Sybase816 and Sybase817.

The Oracle database server data dictionary also contains instance information in the HS_FDS_INST view for each non-Oracle system instance that is accessed.

4.10.4 Using the Transaction Service Views

When a non-Oracle system is involved in a distributed transaction, the transaction capabilities of the non-Oracle system and the agent control whether it can participate in distributed transactions. Transaction capabilities are stored in the HS_CLASS_CAPS tables.

The ability of the non-Oracle system and agent to support two-phase commit protocols is specified by the 2PC type capability, which can specify one of the types shown in the following table.

Type

Capability

Read-Only (RO)

The non-Oracle system can be queried only with SQL SELECT statements. Procedure calls are not allowed because procedure calls are assumed to write data.

Single-Site (SS)

The non-Oracle system can handle remote transactions but not distributed transactions. That is, it cannot participate in the two-phase commit protocol.

Commit Confirm (CC)

The non-Oracle system can participate in distributed transactions. It can participate in the server's two-phase commit protocol but only as the commit point site. That is, it cannot prepare data, but it can remember the outcome of a particular transaction if asked by the global coordinator.

Two-Phase Commit (2PC)

The non-Oracle system can participate in distributed transactions. It can participate in the server's two-phase commit protocol, as a regular two-phase commit node, but not as a commit point site. That is, it can prepare data, but it cannot remember the outcome of a particular transaction if asked to by the global coordinator.

Two-Phase Commit Confirm (2PCC)

The non-Oracle system can participate in distributed transactions. It can participate in the server's two-phase commit protocol as a regular two-phase commit node or as the commit point site. That is, it can prepare data and it can remember the outcome of a particular transaction if asked by the global coordinator.

The transaction model supported by the driver and non-Oracle system can be queried from the HS_CLASS_CAPS Heterogeneous Services data dictionary view.

The following example shows one of the capabilities is of the 2PC type:

SELECT cap_description, translation
FROM   hs_class_caps
WHERE  cap_description LIKE '2PC%'
AND    fds_class_name LIKE 'SYBASE%';

CAP_DESCRIPTION                          TRANSLATION
---------------------------------------- -----------
2PC type (RO-SS-CC-PREP/2P-2PCC)                  CC

When the non-Oracle system and agent support distributed transactions, the non-Oracle system is treated like any other Oracle server. When a failure occurs during the two-phase commit protocol, the transaction is recovered automatically. If the failure persists, the in-doubt transaction may need to be manually overridden by the database administrator.

4.10.5 Using the SQL Service Views

Data dictionary views that are specific for the SQL service contain information about:

- SQL capabilities and SQL translations of the non-Oracle data source

- Data dictionary translations to map Oracle data dictionary views to the data dictionary of the non-Oracle system

Note:
This section describes only a portion of the SQL Service-related capabilities. Because you should never need to alter these settings for administrative purposes, these capabilities are not discussed here.

4.10.5.1 Using Views for Capabilities and Translations

The HS_*_CAPS data dictionary tables contain information about the SQL capabilities of the non-Oracle data source and required SQL translations. These views specify whether the non-Oracle data store or the Oracle database server implements certain SQL language features. If a capability is turned off, then Oracle does not send any SQL statements to the non-Oracle data source that require this particular capability, but it still performs postprocessing.

4.10.5.2 Using Views for Data Dictionary Translations

In order to make the non-Oracle system appear similar to an Oracle database server, Heterogeneous Services connections map a limited set of Oracle data dictionary views onto the non-Oracle system's data dictionary. This mapping permits applications to issue queries as if these views belonged to an Oracle data dictionary. Data dictionary translations make this access possible. These translations are stored in Heterogeneous Services views whose names have the _DD suffix.

For example, the following SELECT statement transforms into a Sybase query that retrieves information about emp tables from the Sybase data dictionary table:

SELECT * FROM USER_TABLES@remote_db WHERE UPPER(TABLE_NAME)='EMP';
Data dictionary tables can be mimicked instead of translated. If a data dictionary translation is not possible because the non-Oracle data source does not have the required information in its data dictionary, then Heterogeneous Services causes it to appear as if the data dictionary table is available, but the table contains no information.

To retrieve information about which Oracle data dictionary views or tables are translated or mimicked for the non-Oracle system, connect as user SYS and issue the following query on the HS_CLASS_DD view:

SELECT DD_TABLE_NAME, TRANSLATION_TYPE
FROM   HS_CLASS_DD
WHERE  FDS_CLASS_NAME LIKE 'SYBASE%';

DD_TABLE_NAME                  T
-----------------------------  -
ALL_ARGUMENTS                  M
ALL_CATALOG                    T
ALL_CLUSTERS                   T
ALL_CLUSTER_HASH_EXPRESSIONS   M
ALL_COLL_TYPES                 M
ALL_COL_COMMENTS               T
ALL_COL_PRIVS                  M
ALL_COL_PRIVS_MADE             M
ALL_COL_PRIVS_RECD             M
...

The T translation type specifies that a translation exists. When the translation type is M, the data dictionary table is mimicked.

4.11 Using the Heterogeneous Services Dynamic Performance Views

The Oracle database server stores information about agents, sessions, and parameters. You can use the dynamic performance views to access this information. This section contains the following topics:

- Determining Which Agents Are Running on a Host: V$HS_AGENT View

- Determining the Open Heterogeneous Services Sessions: V$HS_SESSION View

- Determining the Heterogeneous Services Parameters: V$HS_PARAMETER View

4.11.1 Determining Which Agents Are Running on a Host: V$HS_AGENT View

The V$HS_AGENT view identifies the set of Heterogeneous Services agents currently operating on a specified host. Table 4-2 shows the most relevant columns. For a description of all the columns in the view, see Oracle Database Reference.

Table 4-2 Important Columns in the V$HS_AGENT View

Column

Description

AGENT_ID

Oracle Net session identifier used for connections to agent (listener.ora SID)

MACHINE

Operating system machine name

PROGRAM

Program name of agent

AGENT_TYPE

Type of agent

FDS_CLASS_ID

The ID of the foreign data store class

FDS_INST_ID

The instance name of the foreign data store

4.11.2 Determining the Open Heterogeneous Services Sessions: V$HS_SESSION View

The V$HS_SESSION view shows the sessions for each agent and specifies the database link that is used. Table 4-3 shows the most relevant columns. For a description of all the columns in the view, see Oracle Database Reference.

Table 4-3 Important Columns in the V$HS_SESSION View

Column

Description

HS_SESSION_ID

Unique Heterogeneous Services session identifier

AGENT_ID

Oracle Net session identifier used for connections to agent (listener.ora SID)

DB_LINK

Server database link name used to access the agent NULL means that no database link is used (for example, when using external procedures)

DB_LINK_OWNER

Owner of the database link in DB_LINK

4.11.3 Determining the Heterogeneous Services Parameters: V$HS_PARAMETER View

The V$HS_PARAMETER view lists the Heterogeneous Services parameters and their values that are registered in the Oracle database server. Table 4-4 shows the most relevant columns. For a description of all the columns in the view, see Oracle Database Reference.

Table 4-4 Important Columns in the V$HS_SESSION View

Column

Description

HS_SESSION_ID

Unique Heterogeneous Services session identifier

PARAMETER

The name of the Heterogeneous Services parameter

VALUE

The value of the Heterogeneous Services parameter

Information about the database link that was used for establishing the distributed connection, the startup time, and the set of initialization parameters used for the session is also available. All of the runtime information is derived from dynamically updated tables.

5 Performance Recommendations

This chapter suggests ways to optimize distributed SQL statements and improve the performance of distributed queries.

This chapter includes the following sections:

- Optimizing Heterogeneous Distributed SQL Statements

- Optimizing Performance of Distributed Queries

Note:
For information about general data transfer performance, see Section 4.2, "Optimizing Data Transfers Using Bulk Fetch" and Section 4.3, "Optimizing Data Loads Using Parallel Load"

5.1 Optimizing Heterogeneous Distributed SQL Statements

When a SQL statement accesses data from non-Oracle systems, it is said to be a heterogeneous distributed SQL statement. To optimize heterogeneous distributed SQL statements, follow the same guidelines as for optimizing distributed SQL statements that access Oracle databases only. However, you must consider that the non-Oracle system usually does not support all the functions and operators that Oracle supports.

The Oracle Database Gateways tell Oracle (at connect time) which functions and operators they support. If the non-Oracle data source does not support a function or operator, then Oracle performs that function or operator. In this case, Oracle obtains the data from the other data source and applies the function or operator locally. This affects the way in which the SQL statements are decomposed and can affect performance, especially if Oracle is not on the same computer as the other data source. However, performance can be improved if you use the bulk fetch and bulk load features.

5.2 Optimizing Performance of Distributed Queries

You can improve the performance of distributed queries by using the following strategies:

- Choose the best SQL statement.

In many cases, there are several SQL statements that can achieve the same result. If all tables are on the same database, then the difference in performance between these SQL statements may be minimal. If the tables are located on different databases, then the difference in performance may be more significant.

- Use the query optimizer.

The query optimizer uses indexes on remote tables, considers more execution plans than the rule-based optimizer, and generally gives better results. With the query optimizer, performance of distributed queries is generally satisfactory. Only on rare occasions is it necessary to change SQL statements, create views, or use procedural code.

- Use views.

In some situations, views can be used to improve performance of distributed queries. For example:

- Joining several remote tables on the remote database

- Sending a different table through the network

- Retrieve data from the remote table in parallel

- Use procedural code.

On rare occasions, it can be more efficient to replace a distributed query by procedural code, such as a PL/SQL procedure or a precompiler program.

Index
A  B  C  D  E  F  G  H  I  M  O  P  Q  R  S  T  U  V

A

agents

Database Gateways, 2.3.1

Heterogeneous Services

architecture, 2.1

disabling self-registration, 4.4.2

registering, 4.4, 4.4.1, 4.4.1.1, 4.4.1.2

types of agents, 2.3

Oracle Database Gateway for ODBC, 2.3.2 application development

Heterogeneous Services

controlling array fetches between non-Oracle server and agent, 4.2.3

controlling array fetches between Oracle server and agent, 4.2.2

controlling reblocking of array fetches, 4.2.4

DBMS_HS_PASSTHROUGH package, 3.3

passthrough SQL, 3.3

using bulk fetches, 4.2

using OCI for bulk fetches, 4.2.1

array fetches, 4.2.1

agents, 4.2.3

B

bind queries

executing using passthrough SQL, 3.3.3.2

BIND_INOUT_VARIABLE procedure, 3.3.3, 3.3.3.1.4 BIND_OUT_VARIABLE procedure, 3.3.3, 3.3.3.1.3 BIND_VARIABLE procedure, 3.3.3 buffers

multiple rows, 3.3.3.2

bulk fetches

optimizing data transfers using, 4.2

C

callback link, 3.10.2

CLOSE_CURSOR function, 3.3.3

copying data

from Oracle database server to SQL Server, 4.8

from SQL Server to Oracle database server, 4.9

INSERT statement, 4.9

D

data dictionary views

Heterogeneous Services, 4.10

data type checking support

for remote-mapped statements, 4.5.1

DBMS_HS_PASSTHROUGH package, 3.3.1

list of functions and procedures, 3.3.3

distributed queries

optimizing performance, 5.2

dynamic performance views

Heterogeneous Services, 4.11

determining open sessions, 4.11.2

determining which agents are on host, 4.11.1

E

EXECUTE_IMMEDIATE procedure, 3.3.3

restrictions, 3.3.3.1

EXECUTE_NON_QUERY procedure, 3.3.3

F

FDS_CLASS, 4.4.1.2.1

FDS_CLASS_VERSION, 4.4.1.2.1

FDS_INST_NAME, 4.4.1.2.2

features

new, Preface

FETCH_ROW procedure, 3.3.3

executing queries using passthrough SQL, 3.3.3.2

fetches

bulk, 4.2

optimizing round-trips, 3.3.3.2

G

gateways

how they work, 2.7

GET_VALUE procedure, 3.3.3, 3.3.3.1.3, 3.3.3.1.4

H

Heterogeneous Services

agent registration, 4.4

avoiding configuration mismatches, 4.4.1.1

disabling, 4.4.2

enabling, 4.4.1

self-registration, 4.4.1.2

application development

controlling array fetches between non-Oracle server and agent, 4.2.3

controlling array fetches between Oracle server and agent, 4.2.2

controlling reblocking of array fetches, 4.2.4

DBMS_HS_PASSTHROUGH package, 3.3

passthrough SQL, 3.3

using bulk fetches, 4.2

using OCI for bulk fetches, 4.2.1

data dictionary views, 4.10

types, 4.10.1

understanding sources, 4.10.2

using general views, 4.10.3

using SQL service views, 4.10.5

using transaction service views, 4.10.4

dynamic performance views, 4.11

V$HS_AGENT view, 4.11.1

V$HS_SESSION view, 4.11.2

initialization parameters, 2.5.2, 4.1 SQL service, 2.4.2 transaction service, 2.4.1 HS_AUTOREGISTER initialization parameter

using to enable agent self-registration, 4.4.1.3

HS_BASE_CAPS view, 4.10.1 HS_BASE_DD view, 4.10.1 HS_BULK view, 4.10.1 HS_CLASS_CAPS view, 4.10.1 HS_CLASS_DD view, 4.10.1 HS_CLASS_INIT view, 4.10.1 HS_FDS_CLASS view, 4.10.1 HS_FDS_FETCH_ROWS initialization parameter, 4.2.3 HS_FDS_INST view, 4.10.1 HS_INST_CAPS view, 4.10.1 HS_INST_DD view, 4.10.1 HS_INST_INIT view, 4.10.1 HS_RPC_FETCH_REBLOCKING initialization parameter, 4.2.4 HS_RPC_FETCH_SIZE initialization parameter, 4.2.2, 4.2.4

I

information integration

benefits of Oracle solutions, 1.3

challenges, 1.1

how Oracle addresses, 1.2

Messaging Gateway, 1.2

Open System Interfaces, 1.2

Oracle Streams, 1.2

initialization parameters

Heterogeneous Services (HS), 2.5.2, 4.1

initialization parameters (HS)

common to all gateways, 4.1

purpose, 2.5.2

M

Messaging Gateway

defined, 1.2

multiple rows

buffering, 3.3.3.2

O

OCI

optimizing data transfers using, 4.2.1

Open System Interfaces

defined, 1.2

OPEN_CURSOR procedure, 3.3.3 Oracle Database Gateway for ODBC

Heterogeneous Services, 2.3.2

Oracle Database Gateways

optimizing SQL statements, 5.1

Oracle database server

SQL construct processing, 4.5

Oracle Net Services listener, 2.2 Oracle precompiler

optimizing data transfers using, 4.2.1

Oracle Streams

defined, 1.2

OUT bind variables, 3.3.3.1.3

P

PARSE procedure, 3.3.3

passthrough SQL

avoiding SQL interpretation, 3.3

executing statements, 3.3.3

non-queries, 3.3.3.1

queries, 3.3.3.2

with bind variables, 3.3.3.1.1

with IN bind variables, 3.3.3.1.2

with IN OUT bind variables, 3.3.3.1.4

with OUT bind variables, 3.3.3.1.3

implications of using, 3.3.2 overview, 3.3 restrictions, 3.3.2

Q

queries

passthrough SQL, 3.3.3.2

R

reblocking, 4.2.4

remote-mapped statements

and data type checking support, 4.5.1

rows

buffering multiple, 3.3.3.2

S

SQL capabilities

data dictionary tables, 4.10.5.1

SQL service

data dictionary views, 2.6.2, 4.10.1

Heterogeneous Services, 2.4.2

views

Heterogeneous Services, 4.10.5

SQL statements

optimizing distributed, 5.1

Streams

using for heterogeneous connectivity, 3.2

Synonyms, 4.7

T

transaction service

Heterogeneous Services, 2.4.1

views

Heterogeneous Services, 4.10.4

U

user-defined functions

executing on non-Oracle database, 4.6

V

variables

bind, 3.3.3.1.1

Oracle Legal Notices

Copyright Notice

Copyright © 1994-2016, Oracle and/or its affiliates. All rights reserved.

License Restrictions Warranty/Consequential Damages Disclaimer

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

Warranty Disclaimer

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

Restricted Rights Notice

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are "commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government.

Hazardous Applications Notice

This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Trademark Notice

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.

Third-Party Content, Products, and Services Disclaimer

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

Alpha and Beta Draft Documentation Notice

If this document is in preproduction status:

This documentation is in preproduction status and is intended for demonstration and preliminary use only. It may not be specific to the hardware on which you are using the software. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to this documentation and will not be responsible for any loss, costs, or damages incurred due to the use of this documentation.

Private Alpha and Beta Draft Documentation Notice

If this document is in private preproduction status:

The information contained in this document is for informational sharing purposes only and should be considered in your capacity as a customer advisory board member or pursuant to your beta trial agreement only. It is not a commitment to deliver any material, code, or functionality, and should not be relied upon in making purchasing decisions. The development, release, and timing of any features or functionality described in this document remains at the sole discretion of Oracle.

This document in any form, software or printed matter, contains proprietary information that is the exclusive property of Oracle. Your access to and use of this confidential material is subject to the terms and conditions of your Oracle Master Agreement, Oracle License and Services Agreement, Oracle PartnerNetwork Agreement, Oracle distribution agreement, or other license agreement which has been executed by you and Oracle and with which you agree to comply. This document and information contained herein may not be disclosed, copied, reproduced, or distributed to anyone outside Oracle without prior written consent of Oracle. This document is not part of your license agreement nor can it be incorporated into any contractual agreement with Oracle or its subsidiaries or affiliates.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.