occicommon.h

SQLAPI C/C++ 连接Oracle 数据库！

/* Copyright (c) Oracle Corporation 2000, 2001. All Rights Reserved. */
 
/* 
   NAME 
     occiCommon.h - header file for doing forward references

   DESCRIPTION 
     Just declare all the classes

   RELATED DOCUMENTS 
     <note any documents related to this facility>
 
   EXPORT FUNCTION(S) 
     <external functions declared for use outside package - one-line descriptions>

   INTERNAL FUNCTION(S)
     <other external functions declared - one-line descriptions>

   EXAMPLES

   NOTES
     <other useful comments, qualifications, etc.>

   MODIFIED   (MM/DD/YY)
   rratnam     04/25/01 - fixed NT porting bug1673780
   rvallam     04/12/01 - added dummy parameter in getVector of AnyData
                          for PObject *
   rratnam     04/10/01 - removed references to wstring
   rvallam     04/02/01 - fixed linux porting bug 1654670
   gayyappa    03/29/01 - remove get/set vector methods for int/float/double/
                          unsigned int for anydata.
   rvallam     03/20/01 - added dummy parameter for Type in getVector for
                          void * in statement and ResultSet
                          added setVector of Ref<T> and Number prototype
                          for statement
   gayyappa    03/15/01 - added parameter to getvector on anydata with void*.
   rratnam     03/13/01 - added virtual destructor to RefCounted
   rkasamse    03/15/01 - add an arg, Type, to getVector of void*
   rratnam     03/06/01 - removed references() from RefCounted
   slari       02/15/01 - suppress lint warnings
   rratnam     02/12/01 - removed #include <iostream.h>
   rvallam     02/07/01 - added enum OCCI_MAX_PREFETCH_DEPTH
   gayyappa    01/15/01 - change ub4 to unsigned int for
                          get/set vector methods..
   gayyappa    01/03/01 - put "using namespace std" in a ifndef
   gayyappa    12/14/00 - add forward declaration for ResultSetImpl 
                          and StatementImpl.
                          Remove commented #defines
   gayyappa    11/17/00 - change Session to Connection
   gayyappa    09/12/00 - remove OCCI_SQLT_INT, OCCI_SQLT_FLT 
                          remove OCCIUNSIGNED_CHAR, OCCISHORT, 
                          OCCIUNSIGNED_SHORT, OCCILONG ,OCCI_LONGDOUBLE,
                          OCCI_UNSIGNEDLONG  from enum Type.
   gayyappa    08/25/00 - add const to get/set vector mthds of anydata.
   rvallam     08/10/00 - updated Type enum
   slari       08/04/00 - add OCCIROWID and OCCICURSOR
   rkasamse    08/04/00 - add setVector methods
   slari       07/24/00 - add BytesImpl
   rratnam     07/25/00 - Added forward declarations for LobStreamImpl,
                          ConnectionPool[Impl], removed those for
                          Connection[Impl]
   rkasamse    07/28/00 - add getVector(ResultSet*...) methods
   rratnam     06/14/00 - Added forward declaration for RefImpl,
                          added DefaultCharSet to the CharSet 
                          enum
   rratnam     06/13/00 - Added DefaultCharSet to the CharSet enum
   kmohan      05/31/00 - RefCounted no more templated
   rratnam     22/05/00 - Added forward declaration of ConnectionImpl, and the
                         LobOpenMode enum
   kmohan      05/05/00 - Added global routine prototypes
   rkasamse    05/23/00 -
   slari       04/28/00 - add forward declaration of SQLExceptionImpl
   kmohan      04/19/00 - Added enums Type,CharSet,CharSetForm
   gayyappa    04/18/00 - removed checkStatus. added checkOCICall and 
                          createSQLEXception functions 
   kmohan      04/11/00 - Creation

*/


#ifndef OCCICOMMON_ORACLE
# define OCCICOMMON_ORACLE

#ifndef _olint

#ifndef OCI_ORACLE
#include <oci.h>
#endif

#ifndef ORASTRING
#define ORASTRING
#include <string>
#endif

#ifndef ORAVECTORSTL
#include <vector>
#define ORAVECTORSTL
#endif

#ifndef ORALISTSTL
#include <list>
#define ORALISTSTL
#endif

#ifdef HPUX
#define OCCI_STD_NAMESPACE
#undef  OCCI_HAVE_STD_NAMESPACE
#else
#define OCCI_STD_NAMESPACE std
#define OCCI_HAVE_STD_NAMESPACE 1
#endif

namespace oracle {
namespace occi {
class Environment;
class EnvironmentImpl;
class Connection;
class ConnectionImpl;
class ConnectionPool;
class ConnectionPoolImpl;
class Statement;
class StatementImpl;
class ResultSet;
class ResultSetImpl;
class SQLException;
class SQLExceptionImpl;
class Stream;
class PObject;
class Number;
class Bytes;
class BytesImpl;
class Date;
class Timestamp;

class MetaData;
class MetaDataImpl;
template <class T> class Ref;
class RefImpl;
class RefAny;
class Blob;
class Bfile;
class Clob;
class LobStreamImpl;
class AnyData;
class AnyDataImpl;
class Map;
class IntervalDS;
class IntervalYM;


/*---------------------------------------------------------------------------
                           ENUMERATORS
  ---------------------------------------------------------------------------*/
enum Type
{
 OCCI_SQLT_CHR=SQLT_CHR,
 OCCI_SQLT_NUM=SQLT_NUM,
 OCCIINT = SQLT_INT,
 OCCIFLOAT = SQLT_FLT,
 OCCI_SQLT_STR=SQLT_STR,
 OCCI_SQLT_VNU=SQLT_VNU,
 OCCI_SQLT_PDN=SQLT_PDN,
 OCCI_SQLT_LNG=SQLT_LNG,
 OCCI_SQLT_VCS=SQLT_VCS,
 OCCI_SQLT_NON=SQLT_NON,
 OCCI_SQLT_RID=SQLT_RID,
 OCCI_SQLT_DAT=SQLT_DAT,
 OCCI_SQLT_VBI=SQLT_VBI,
 OCCI_SQLT_BIN=SQLT_BIN,
 OCCI_SQLT_LBI=SQLT_LBI,
 OCCIUNSIGNED_INT = SQLT_UIN,
 OCCI_SQLT_SLS=SQLT_SLS,
 OCCI_SQLT_LVC=SQLT_LVC,
 OCCI_SQLT_LVB=SQLT_LVB,
 OCCI_SQLT_AFC=SQLT_AFC,
 OCCI_SQLT_AVC=SQLT_AVC,
 OCCI_SQLT_CUR=SQLT_CUR,
 OCCI_SQLT_RDD=SQLT_RDD,
 OCCI_SQLT_LAB=SQLT_LAB,
 OCCI_SQLT_OSL=SQLT_OSL,
 OCCI_SQLT_NTY=SQLT_NTY,
 OCCI_SQLT_REF=SQLT_REF,
 OCCI_SQLT_CLOB=SQLT_CLOB,
 OCCI_SQLT_BLOB=SQLT_BLOB,
 OCCI_SQLT_BFILEE=SQLT_BFILEE,
 OCCI_SQLT_CFILEE=SQLT_CFILEE,
 OCCI_SQLT_RSET=SQLT_RSET,
 OCCI_SQLT_NCO=SQLT_NCO,
 OCCI_SQLT_VST=SQLT_VST,
 OCCI_SQLT_ODT=SQLT_ODT,
 OCCI_SQLT_DATE=SQLT_DATE,
 OCCI_SQLT_TIME=SQLT_TIME,
 OCCI_SQLT_TIME_TZ=SQLT_TIME_TZ,
 OCCI_SQLT_TIMESTAMP=SQLT_TIMESTAMP,
 OCCI_SQLT_TIMESTAMP_TZ=SQLT_TIMESTAMP_TZ,
 OCCI_SQLT_INTERVAL_YM=SQLT_INTERVAL_YM,
 OCCI_SQLT_INTERVAL_DS=SQLT_INTERVAL_DS,
 OCCI_SQLT_TIMESTAMP_LTZ=SQLT_TIMESTAMP_LTZ,
 OCCI_SQLT_FILE=SQLT_FILE,
 OCCI_SQLT_CFILE=SQLT_CFILE,
 OCCI_SQLT_BFILE=SQLT_BFILE,
 
 OCCICHAR = 32 *1024,
 OCCIDOUBLE,
 OCCIBOOL,
 OCCIANYDATA ,
 OCCINUMBER,
 OCCIBLOB,
 OCCIBFILE,
 OCCIBYTES,
 OCCICLOB ,
 OCCIVECTOR,
 OCCIMETADATA,
 OCCIPOBJECT,
 OCCIREF ,
 OCCIREFANY,
 OCCISTRING  ,
 OCCISTREAM  ,
 OCCIDATE  ,
 OCCIINTERVALDS  ,
 OCCIINTERVALYM  ,
 OCCITIMESTAMP,
 OCCIROWID,
 OCCICURSOR


};

enum LockOptions {OCCI_LOCK_NONE = OCI_LOCK_NONE,
                      OCCI_LOCK_X = OCI_LOCK_X, 
                      OCCI_LOCK_X_NOWAIT = OCI_LOCK_X_NOWAIT
                     };

enum {OCCI_MAX_PREFETCH_DEPTH = UB4MAXVAL};

enum TypeCode
{

OCCI_TYPECODE_REF = OCI_TYPECODE_REF,
OCCI_TYPECODE_DATE = OCI_TYPECODE_DATE,
OCCI_TYPECODE_REAL = OCI_TYPECODE_REAL,
OCCI_TYPECODE_DOUBLE = OCI_TYPECODE_DOUBLE,
OCCI_TYPECODE_FLOAT = OCI_TYPECODE_FLOAT,
OCCI_TYPECODE_NUMBER = OCI_TYPECODE_NUMBER,
OCCI_TYPECODE_DECIMAL = OCI_TYPECODE_DECIMAL,
OCCI_TYPECODE_OCTET = OCI_TYPECODE_OCTET,
OCCI_TYPECODE_INTEGER = OCI_TYPECODE_INTEGER,
OCCI_TYPECODE_SMALLINT= OCI_TYPECODE_SMALLINT,
OCCI_TYPECODE_RAW = OCI_TYPECODE_RAW,
OCCI_TYPECODE_VARCHAR2 = OCI_TYPECODE_VARCHAR2,
OCCI_TYPECODE_VARCHAR = OCI_TYPECODE_VARCHAR,
OCCI_TYPECODE_CHAR = OCI_TYPECODE_CHAR,
OCCI_TYPECODE_VARRAY= OCI_TYPECODE_VARRAY,
OCCI_TYPECODE_TABLE = OCI_TYPECODE_TABLE,
OCCI_TYPECODE_CLOB = OCI_TYPECODE_CLOB,
OCCI_TYPECODE_BLOB = OCI_TYPECODE_BLOB,
OCCI_TYPECODE_BFILE = OCI_TYPECODE_BFILE,
OCCI_TYPECODE_OBJECT = OCI_TYPECODE_OBJECT,
OCCI_TYPECODE_NAMEDCOLLECTION = OCI_TYPECODE_NAMEDCOLLECTION
};


enum CharSet	
{
    DefaultCharSet =0
   ,US7ASCII =1
   ,WE8DEC =2
   ,WE8HP =3
   ,US8PC437 =4
   ,WE8EBCDIC37 =5
   ,WE8EBCDIC500 =6
   ,WE8EBCDIC1140 =7
   ,WE8EBCDIC285 =8
   ,WE8EBCDIC1146 =9
   ,WE8PC850 =10
   ,D7DEC =11
   ,F7DEC =12
   ,S7DEC =13
   ,E7DEC =14
   ,SF7ASCII =15
   ,NDK7DEC =16
   ,I7DEC =17
   ,NL7DEC =18
   ,CH7DEC =19
   ,YUG7ASCII =20
   ,SF7DEC =21
   ,TR7DEC =22
   ,IW7IS960 =23
   ,IN8ISCII =25
   ,WE8EBCDIC1148 =27
   ,WE8PC858 =28
   ,WE8ISO8859P1 =31
   ,EE8ISO8859P2 =32
   ,SE8ISO8859P3 =33
   ,NEE8ISO8859P4 =34
   ,CL8ISO8859P5 =35
   ,AR8ISO8859P6 =36
   ,EL8ISO8859P7 =37
   ,IW8ISO8859P8 =38
   ,WE8ISO8859P9 =39
   ,NE8ISO8859P10 =40
   ,TH8TISASCII =41
   ,TH8TISEBCDIC =42
   ,BN8BSCII =43
   ,VN8VN3 =44
   ,VN8MSWIN1258 =45
   ,WE8ISO8859P15 =46
   ,WE8NEXTSTEP =50
   ,AR8ASMO708PLUS =61
   ,AR8EBCDICX =70
   ,AR8XBASIC =72
   ,EL8DEC =81
   ,TR8DEC =82
   ,WE8EBCDIC37C =90
   ,WE8EBCDIC500C =91
   ,IW8EBCDIC424 =92
   ,TR8EBCDIC1026 =93
   ,WE8EBCDIC871 =94
   ,WE8EBCDIC284 =95
   ,WE8EBCDIC1047 =96
   ,WE8EBCDIC1140C =97
   ,WE8EBCDIC1145 =98
   ,WE8EBCDIC1148C =99
   ,EEC8EUROASCI =110
   ,EEC8EUROPA3 =113
   ,LA8PASSPORT =114
   ,BG8PC437S =140
   ,EE8PC852 =150
   ,RU8PC866 =152
   ,RU8BESTA =153
   ,IW8PC1507 =154
   ,RU8PC855 =155
   ,TR8PC857 =156
   ,CL8MACCYRILLIC =158
   ,CL8MACCYRILLICS =159
   ,WE8PC860 =160
   ,IS8PC861 =161
   ,EE8MACCES =162
   ,EE8MACCROATIANS =163
   ,TR8MACTURKISHS =164
   ,IS8MACICELANDICS =165
   ,EL8MACGREEKS =166
   ,IW8MACHEBREWS =167
   ,EE8MSWIN1250 =170
   ,CL8MSWIN1251 =171
   ,ET8MSWIN923 =172
   ,BG8MSWIN =173
   ,EL8MSWIN1253 =174
   ,IW8MSWIN1255 =175
   ,LT8MSWIN921 =176
   ,TR8MSWIN1254 =177
   ,WE8MSWIN1252 =178
   ,BLT8MSWIN1257 =179
   ,D8EBCDIC273 =180
   ,I8EBCDIC280 =181
   ,DK8EBCDIC277 =182
   ,S8EBCDIC278 =183
   ,EE8EBCDIC870 =184
   ,CL8EBCDIC1025 =185
   ,F8EBCDIC297 =186
   ,IW8EBCDIC1086 =187
   ,CL8EBCDIC1025X =188
   ,D8EBCDIC1141 =189
   ,N8PC865 =190
   ,BLT8CP921 =191
   ,LV8PC1117 =192
   ,LV8PC8LR =193
   ,BLT8EBCDIC1112 =194
   ,LV8RST104090 =195
   ,CL8KOI8R =196
   ,BLT8PC775 =197
   ,DK8EBCDIC1142 =198
   ,S8EBCDIC1143 =199