otl_stream(...);

otl_stream(...);

• otl_explicit_select -- to indicate that if the stream is a SELECT statement then the statement is a simple SELECT.
• otl_implicit_select -- to indicate that the stream is a stored procedure call that returns one result set.
• otl_direct_exec_select -- to indicate that if the stream is a "one time" SELECT statement or a stored procedure returning an implicit result set, and it should be processed via a call to SQLExecDirect() instead of SQLPrepare()+SQLExecute(), which is more efficient for some database types. Such SELECT statements or stored procedures are limited to have no input variables / to be constant string literals.
  

When otl_implicit_select is used, only input parameters are allowed in the corresponding stored procedure call that returns an implicit result set, otherwise the following otl_exception is thrown: This type of otl_stream can only have input variables (error code 32040).

Essentially, the stream, that processes an implicit result set, works as an extension of the internal SELECT stream.

void open(...);

void open(...);

ODBC/DB2-CLI only.

This function open an SQL statement and the statement
gets parsed, all input and output variables get dynamically allocated inside the stream and automatically bound to
the placeholders.

int eof();

int setBufSize(const int buf_size);

void flush();

void flush(...);

The following global  constants (int's) are defined:
 

• otl_no_stream_type -- stream is not instantiated with any SQL statement yet.
  
  
• otl_select_stream_type -- stream is instantiated with a straight SELECT statement.
  
  
• otl_inout_stream_type -- stream is instantiated with an anonymous PL/SQL block which has input/output bind variables, possibly, parameters in a stored procedure call.
  
  
• otl_refcur_stream_type -- stream is instantiated with a PL/SQL block, which returns a reference cursor. In this type of a PL/SQL block (possibly, a stored procedure call), only input bind variables are allowed. The output of the PL/SQL block is the reference cursor itself.
  
  
• otl_constant_sql_type -- special constant that is only used in create_stored_proc_call(), and not returned by get_stream_type(). However, the constant completes this logical group of constants, that represent types of  OTL streams. In the context of create_stored_proc_call(), this constant indicates a call to a stored procedure, which has no parameters, and it needs to be executed via otl_cursor::direct_exec().
  
  
• otl_mixed_refcur_stream_type -- special constant that is only used in create_stored_proc_call(), and not returned by get_stream_type(). However, the constant completes this logical group of constants, that represent types of  OTL streams. In the context of create_stored_proc_call(), this constant indicates a call to a stored procedure, which has reference cursor(s) as well as scalar (input/) output parameters (mixed reference cursor stream). If create_stored_proc_call() returns this constant in its stm_type parameter, and when create_stored_proc_call()'s sql_stm parameter is instantiated, the corresponding otl_stream's buffer size needs to be set to 1, and otl_refcur_stream should be used to fetch rows from the refcur bind variables of the sql_stm's text. Also, otl_stream::describe_in_vars() and otl_stream::describe_out_vars() should be used to describe the stream input and output variables in the case of general-purpose C++ code to handle PL/SQL procedure calls that get generated by the create_stored_proc_call() function. See example 153 for more detai

OTL/OCI8/9/10/11/12 only. Not implemented under #define OTL_UNICODE. Creates an otl_stream compatible call (string) to a stored procedure by the stored procedure name. This function is static in class and intended for some automation in generating Oracle 8/8i/9i/10g/11g stored procedure calls. The function uses Oracle system data dictionary directly (ALL_ARGUMENTS system view), in order to retrieve information about stored procedure's parameters, and their data types. Potentially, the function may raise the OTL defined exceptions with the following error codes: 32014, 32015, 32016. 

The function is able to handle the following types of stored procedures/functions:

• stored procedures / functions from PL/SQL packages from the current / specified schema, or global procedures / functions from the current / specified schema.
  
  
• stored procedures / functions from PL/SQL packages available via private / public synonyms, or global procedures / functions available via private / public synonyms.
  
  
• procedures / functions, whose names are not overloaded.

• procedures / functions, with scalar input and/or output parameters, and maybe with output reference cursor(s).

For more detail, also see #define OTL_ORA_CREATE_STORED_PROC_CALL_MAPS_RAW_TO_RAW, and #define OTL_ORA_CREATE_STORED_PROC_CALL_MAPS_RAW_TO_RAW_LONG.

void rewind();

operator int();

void cancel();

int is_null();

void set_lob_stream_mode
(const bool mode=false);

long get_rpc();

Conclusion: for portable, multi-database OTL based code, it's not recommended to use the database specific behavior of the get_rpc() function. For Oracle OTL based code, it's okay to use it, since this kind of behavior is consistent with all versions of Oracle, that are supported by OTL.

void set_commit(int auto_commit=0);

If it is more convenient to have the stream "auto-commit off" by default, then the otl_nocommit_stream can be used. otl_nocommit_stream is a class derived directly from otl_stream with auto-commit turned off by default, so it does not commit transactions.

void set_flush(const bool auto_flush=true);

otl_var_desc* describe_out_vars
(int& desc_len);  

class otl_var_desc{
       public:

otl_var_desc* describe_in_vars
(int& desc_len);

otl_var_desc* describe_next_out_var();

otl_var_desc* describe_next_in_var();

(1) void close();

(2) void close
(const bool save_in_stream_pool=true);

int good();

otl_column_desc* describe_select
(int& desc_len);

• straight SELECT statement (OCIx, ODBC, and DB2-CLI)
• Referenced cursor (OCIx)
• Result set returned via a stored procedure call (ODBC for MS SQL Server and Sybase, DB2-CLI for DB2)

class otl_column_desc{
     public:

};

otl_stream& operator>>(unsigned char* s);

under #define OTL_UNICODE
under #define OTL_UNICODE_CHAR_TYPE

reads the Unicode LOB from the stream.

otl_stream& operator>>(OTL_UNICODE_CHAR_TYPE& c);

under #define OTL_UNICODE
under #define OTL_UNICODE_CHAR_TYPE

otl_stream&
operator>>(OTL_UNICODE_CHAR_TYPE* s);

under #define OTL_UNICODE
under #define OTL_UNICODE_CHAR_TYPE

under #define OTL_UNICODE
under #define OTL_UNICODE_CHAR_TYPE
under #define OTL_UNICODE_STRING_TYPE

when #define OTL_BIGINT is enabled. For ODBC drivers that do not support bigint binding of host variables natively, this operator can convert a numeric string value to a bigint numeric value. That is, when a numeric value is returned from the SQL statement as a string, this operator will convert the string to a signed 64-bit integer in C++, when #define  OTL_STR_TO_BIGINT, and and #define OTL_BIGINT_TO_STR are defined.

class otl_null{
public:
   otl_null(){}
   ~otl_null(){}
};

class otl_datetime{
public:

Fraction can be up to nine decimal significant digits long, depending on what the second's precision (frac_precision) is supported by the database (MS SQL Server 2005 down to  milliseconds, MS SQL Server 2008 down to 100s of a nanosecond, Sybase down to milliseconds, DB2 down to microseconds, etc.), and what precision is specified in the timestamp data type (Oracle 9i/10g/11g: decimal digits in the range of [1..6] digits). Fraction does not have any effect in case if the database supports the timestamp data type with whole seconds only.

• otl_all_num2str, e.g.: set_all_column_types(otl_all_num2str);
• otl_all_date2str, e.g.: set_all_column_types(otl_all_date2str);
• otl_all_num2str | otl_all_date2str, e.g.: set_all_column_types(otl_all_num2str | otl_all_date2str);

 void set_column_type
       (const int column_ndx,
        const int col_type,
        const int col_size=0);

It is recommended that this function and data type overrides be used with caution. This feature is introduced to address issues like: NUMBER is too large to fit into the otl_var_double container and it is necessary to convert the NUMBER into otl_var_char. Or, for small enough LONG or TEXT columns, sometimes it is more convenient to use the otl_var_char container.

#if defined(OTL_STREAM_WITH_STD_OPTIONAL_ON)

#if defined(OTL_STREAM_WITH_STD_TUPLE_ON)

#if defined(OTL_STREAM_WITH_STD_CHAR_ARRAY_ON)

#if defined(OTL_STREAM_WITH_STD_UNICODE_CHAR_ARRAY_ON)

• int
• double
• float
• unsigned int
• short int
• long int
• otl_datetime
• OTL_BIGINT
• OTL_UBIGINT