Main Page   Namespace List   Compound List   File List   Namespace Members   Compound Members   File Members  

oralib Namespace Reference

Contains all classes in the library. More...


Compounds

class  column
 Encapsulates a resultset column. More...

class  connection
 Handles connection to an Oracle server. More...

class  parameter
 Encapsulates a named variable (AKA bound variable, parameter). More...

class  resultset
 Encapsulates a resultset - SQL select statement result or ref cursor bound variable. More...

class  statement
 Encapsulates a prepared SQL (or PL/SQL) statement. More...


Typedefs

typedef std::string String
 Will be std::string or std::wstring depending on the build type. In either case parameters (bound variables) and result-set columns will be accessible via this type.

typedef const char * Pstr
 Will be const char* or const wchar_t* depending on the build type. In either case parameters (bound variables) could be assigned to this type.


Enumerations

enum  DataTypesEnum {
  DT_UNKNOWN, DT_NUMBER, DT_DATE, DT_TEXT,
  DT_RESULT_SET
}
 Enumeration of internally supported data types. Each parameter (named or bound variable) and result-set column are having one. More...

enum  ParameterPrefixesEnum {
  PP_ARRAY = 't', PP_NUMERIC = 'n', PP_DATE = 'd', PP_TEXT = 's',
  PP_RESULT_SET = 'c'
}
 Enumeration with prefixes for parameters (bound variables) where prefix is used to specify parameter type instead of passing type separately (usable if OraLib is driven via external interface).

enum  StatementTypesEnum {
  ST_UNKNOWN, ST_SELECT = OCI_STMT_SELECT, ST_UPDATE = OCI_STMT_UPDATE, ST_DELETE = OCI_STMT_DELETE,
  ST_INSERT = OCI_STMT_INSERT, ST_CREATE = OCI_STMT_CREATE, ST_DROP = OCI_STMT_DROP, ST_ALTER = OCI_STMT_ALTER,
  ST_BEGIN = OCI_STMT_BEGIN, ST_DECLARE = OCI_STMT_DECLARE
}

Variables

const ub2 MAX_OUTPUT_TEXT_BYTES = 1024
 Maximal length (in characters) of a text parameter (bound variable).

const ub2 FETCH_SIZE = 20
 Number of result-set (cursor) rows to request on each fetch operation.

const ub2 ERROR_FORMAT_MAX_MSG_LEN = 1024
 Maximal length (in ANSI characters) of user-supplied error message to format.

const ub2 FIRST_COLUMN_NO = 1
 Index of the first column in a result set. Better set to 0 or 1. The reason for using 1-based instead of 0-based indexes is that 0 should be explicitly casted to long, because compiler confuses it with char*.

const ub2 FIRST_PARAMETER_NO = 1
 Index of the first parameter in a statement. Better set to 0 or 1. The reason for using 1-based instead of 0-based indexes is that 0 should be explicitly casted to long, because compiler confuses it with char*.

const int CHAR_SIZE = sizeof (char)
 Size of a single character in bytes. Will be 1 in ANSI builds and 2 (or more) with Unicode builds.


Detailed Description

Contains all classes in the library.

Enumeration Type Documentation

enum oralib::DataTypesEnum
 

Enumeration of internally supported data types. Each parameter (named or bound variable) and result-set column are having one.

Enumeration values:
DT_UNKNOWN  not initialized yet;
DT_NUMBER  a number type; includes following Oracle types: SQLT_INT (integer), SQLT_LNG (long), SQLT_UIN (unsigned integer), SQLT_NUM (numeric), SQLT_FLT (float), SQLT_VNU (numeric with length) and SQLT_PDN (packed decimal);
DT_DATE  a date type; includes following Oracle types: SQLT_DAT (date) and SQLT_ODT (OCI date);
DT_TEXT  a text type; includes following Oracle types: SQLT_CHR (character string), SQLT_STR (zero-terminated string), SQLT_VCS (variable-character string), SQLT_AFC (ANSI fixed char), SQLT_AVC (ANSI var char) and SQLT_VST (OCI string type);
DT_RESULT_SET  a REF CURSOR type (SQLT_RSET Oracle type only).


Generated on Sun Aug 18 13:56:27 2002 for OraLib by doxygen1.2.17