Oracle8i Data Cartridge Developer's Guide
Release 8.1.5

A68002-01

Library

Product

Contents

Index

Prev Next

14
Reference -- Extensibility Constants & Types


System Defined Constants

All the constants referred to in this document are defined in the ODCIConst package installed as part of the catodci.sql script. There are equivalent definitions for use within C routines in odci.h.

We strongly recommend that you use these constants instead of hardcoding their underlying values in your routines.


Alter Options Values


ODCIArgDesc.ArgType Bits


ODCIPredInfo.Flag Bits


ODCIFuncInfo.Flags Bits


ODCIQueryInfo.Flags Bits


ODCIStatsOptions.Flags Bits


DCIStatsOptions.Options Bits


ScnFlg (Function with Index Context) values


Status Values


System Defined Types

A number of system-defined types are defined by Oracle and need to be created by running the catodci.sql catalog script. The C mappings for these object ytpes are defined odci.h The ODCIIndex routines that follow use these types as parameters.

Unless otherwise mentioned, the names pased as type attributes are unquoted identifiers.


ODCIArgDesc

Name

ODCIArgDesc 

Datatype

Object type.

Purpose

Stores function/operator arguments.

Table 14-1 Function/Operator Argument Description -- Attributes
Name  Datatype  Purpose 
ArgType
 
NUMBER
 

Argument type - see "ODCICost"  

TableName
 
VARCHAR2(30)
 

Name of table  

TableSchema
 
VARCHAR2(30)
 

Schema containing the table  

ColName
 
VARCHAR2(4000)
 

Name of column. This could be top level column name such as "A", or a nested column "A"."B" Note that the column name are quoted identifiers.  


ODCIArgDescList

Name

ODCIArgDesc 

Datatype

VARRAY(32767) of ODCIArgDesc

Purpose

Lists descriptions of arguments.


ODCIRidList

Name

ODCIRidList 

Datatype

VARRAY(32767) OF VARCHAR2("M_URID_SZ")

Purpose

Stores list of rowids. The rowids are stored in their character format.


ODCIColInfo

Name

ODCIColInfo 

Datatype

Object type.

Purpose

Stores information related column.

Table 14-2 Column Related Information -- Attributes
Name  Datatype  Purpose 
TableSchema
 
VARCHAR2(30)
 

Schema containing table  

TableName
 
VARCHAR2(30)
 

Name of table  

ColName
 
VARCHAR2(4000)
 

Name of column. This could be top level column name such as "A", or a nested column "A"."B" Note that the column name are quoted identifiers.  

ColTypeName
 
VARCHAR2(30)
 

Datatype of column  

ColTypeSchema
 
VARCHAR2(30)
 

Schema containing datatype if user-defined datatype  


ODCIColInfoList

Name

ODCIColInfoList 

Datatype

VARRAY(32) OF ODCIColInfo

Purpose

Stores information related to a list of columns.


ODCICost

Name

ODCICost 

Datatype

Object type.

Purpose

Stores cost information.

Table 14-3 Cost Information -- Attributes
Name  Datatype  Purpose 
CPUCost
 
NUMBER
 

CPU cost  

IOCost
 
NUMBER
 

I/O cost  

NetworkCost
 
NUMBER
 

Communication cost  


ODCIFuncInfo

Name

ODCIFuncInfo 

Datatype

Object type.

Purpose

Stores function information.

Table 14-4 Function Information -- Attributes
Name  Datatype  Purpose 
ObjectSchema
 
VARCHAR2(30)
 

Object schema name  

ObjectName
 
VARCHAR2(30)
 

Function/package/type name  

MethodName
 
VARCHAR2(30)
 

Method name for package/type  

Flags
 
NUMBER
 

Function flags - see ODCIConst  


ODCIIndexInfo

Name

ODCIIndexInfo 

Datatype

Object type

Purpose

Stores the metadata information related to a domain index. It is passed as a parameter to all ODCIIndex routines.

Table 14-5 Index Related Information -- Attributes
Name  Datatype  Purpose 
IndexSchema
 
VARCHAR2(30)
 

Schema containing domain index  

IndexName
 
VARCHAR2(30)
 

Name of domain index  

IndexCols
 
ODCIColInfoList
 

List of indexed columns  


ODCIPredInfo

Name

ODCIPredInfo 

Datatype

Object type

Purpose

Stores the metadata information related to a predicate containing a user-defined operator or function. It is also passed as a parameter to ODCIIndexStart() query routine.

Table 14-6 Operator Related Information -- Attributes
Name  Datatype  Purpose 
ObjectSchema
 
VARCHAR2(30)
 

Schema of operator/function  

ObjectName
 
VARCHAR2(30)
 

Name of operator/function  

MethodName
 
VARCHAR2(30)
 

Name of method, applies only to package methods type  

Flags
 
NUMBER
 

The possible flags that could be set are:

PredExactMatch - Exact Match

PredPrefixMatch - Prefix Match

PredIncludeStart - Bounds include the start key value

PredIncludeStop - Bounds include the stop key value

PredObjectFunc - Object is a function

PredObjectPlg - Object is a package

PredObjectType - Object is a type  


ODCIIndexCtx

Name

ODCIIndexCtx 

Datatype

Object type

Purpose

Stores the index context, including the domain index metadata and the ROWID. It is passed as parameter to the functional implementation of an operator that expects index context.

Table 14-7 Index Context Related Information -- Attributes
Name  Datatype  Purpose 
IndexInfo
 
ODCIIndexInfo
 

stores the metadata information about the domain index  

rid
 
VARCHAR2("M_URID_
SZ")
 

row identifier of the current row  


ODCIObject

Name

ODCIObject 

Datatype

Object type

Purpose

Stores information about a schema object.

Table 14-8 Index Context Related Information -- Attributes
Name  Datatype  Purpose 
ObjectSchema
 
VARCHAR2(30)
 

Name of schema in which object is located  

ObjectName
 
VARCHAR2(30)
 

Name of object  


ODCIObjectList

Name

ODCIObjectList 

Datatype

VARRAY(32) OF ODCIObject 

Purpose

Stores information about a list of schema objects.


ODCIQueryInfo

Name

ODCIQueryInfo 

Datatype

Object type

Purpose

Stores information about the context of a query. It is passed as a parameter to the ODCIIndexStart routine.

Table 14-9 Index Context Related Information -- Attributes
Name  Datatype  Purpose 
Flags
 
NUMBER
 

The following flags can be set:

QueryFirstRows -- 'FIRST_ROWS' specified in the query

QueryAllRows -- 'ALL_ROWS' specified in the query  

AncOps
 
ODCIObjectList
 

Ancillary operators referenced in the query  


ODCIStatsOptions

Name

ODCIStatsOptions 

Datatype

Object type.

Purpose

Stores options information for ANALYZE.

Table 14-10 Cost Information -- Attributes
Name  Datatype  Purpose 
Sample
 
NUMBER
 

Sample size  

Options
 
NUMBER
 

ANALYZE options - see "ODCICost"  

Flags
 
NUMBER
 

ANALYZE flags - see "ODCICost"  




Prev

Next
Oracle
Copyright © 1999 Oracle Corporation.

All Rights Reserved.

Library

Product

Contents

Index