OTL翻译(4) -- otl_stream类

构造函数。该构造函数创建一个otl_steram对象，并且调用open()函数。

构造函数，该构造函数创建一个otl_stream对象，并且调用open()函数。

在ODBC和DB2 CLI下面对该对象还定义了如下两个常量：

otl_explicit_select:指定该流为一个简单的SELECT语句流；

otl_implicit_select:指定该流为一个返回结果集的流；

该函数打开（执行）SQL语句，总共分为如下：解析SQL语句、在流内部为输入输出变量分配内存空间、自动绑定变量到对应的占位符。

该函数打开（执行）SQL语句，总共分为如下：解析SQL语句、在流内部为输入输出变量分配内存空间、自动绑定变量到对应的占位符。

如果在设置了auto-commit标识的情况下，在刷新了输出缓冲区后，也就会自动的进行一次事务提交。更详细的解释请见set_commit()

１、 对大数据量的操作更高效

２、 能够识别（发现）出重复的数据，并抛出异常

1:表示自动提交标识已设置

0:表示自动提交标识未设置

取得流的类型。返回的类型由如下的整形常量：

otl_no_stream_type—流还未通过SQL进行实例化

otl_select_stream_type—流是一个简单的SELECT语句的流

otl_inout_stream_type—流是通过一个带有输入输出参数的匿名的SQL块进行实例化的，还有可能是一个存储过程。

otl_refcur_stream_type—流是通过一个SQL语句块进行实例化的，该SQL块返回的是一个游标。在这种流的情况下，只能有输入参数，输出参数一定是一个游标。

otl_constant_sql_type—该类型本只能在使用create_stored_proc_call()里面使用，然而它代表了一种流类型。在create_stord_proc_call()里面它本义也是指不带有参数的，而且它必须通过otl_cursor::direct_exec()执行。

otl_mixed_refcur_stream_type—只由create_stoerd_proc_call()实例的类型。它能够带有输入或输出参数，并且一定有返回一个游标。如果create_stored_proc_call()的sql_stm参数设定了的情况下，流的缓冲区大小必须设置为1，并且必须通过otl_refcur_stream去读取游标的数据。更详细的请见例：153

不能定义在OTL_UNICODE宏下面实现。通过存储过程名去实现一个兼容的otl_stream流。

这是个静态的函数，意图去实现调用oracle的存储过程。

为了能够获取到存储过程的参数和类型，该函数使用ORACLE的系统数据字典。可能会抛出32014、32015、32016的OTL异常。

该函数能够调用下列的函数或存储过程:

1:当前或指定用户名下面的SQL包的存储过程或函数；当前或指定用户名下面的全局的存储过程或函数。

2:公共或私有同义词下面的SQL包的存储过程或函数；公共或私有同义词下面的全局的存储过程或函数。

3:没有重载（同名）的存储过程或函数。

4:带有标量的输入或输出参数，或带有输出游标的存储过程或函数。

如果clean_up_error_flag参数设置为1，那么除了清掉缓冲区内容的同时，还清理掉流里面抛出的异常信息。详细请见例：65、66、67.该参数的意义在于提供一个不需要关闭流的情况下可以重新返回数据库的相关错误信息。

在4.0.6及以后的版本中，该函数还能中断一个正在执行中的SQL语句，并且清空错误信息。

 while(s>>f1>>f2){ 
    cout<<"f1="<<f1
        <<", f2="
        <<f2<<endl; 
  }

中止一个正在处理中的SELECT语句或是存储过程。而且对于一个线程中正在运行的，另一个线程能异步的中止该正在执行中的流。

具体的中止操作取决于数据库层的API函数。并且错误信息也是由数据库层抛出。

OCI8/8i/9i/10g也有一个相类似的函数otl_connect:cancel()，但是与DB2 CLI确是不同的。

必须定义OTL_ODBC_SQL_STATEMENT_WITH_DIAG_REC_OUTPUT宏。

该函数是用来通过MS SQL SERVER的BACKUP/DBCC命令获取动态的记录。函数内部实际是调用SQLGetDiagRec()函数。记录的索引从1开始计数。函数能自动的增加索引。更详细资料请见例：688、689

必须定义OTL_ODBC_SQL_STATEMENT_WITH_DIAG_REC_OUTPUT宏。

该函数用来返回底层的ODBC句柄。

返回的数据由INSERT/UPDATE/DELETE语句返回的操作行数；对于INSERT操作，它返回的是小于或等于缓冲区大小。对于UPDATE或DELETE语句，它取决于实际更新或删除的行数。

在4.0.6及以后的版本中，该函数对于SELECT语句返回的是累计操作的行数。

对于ORACLE和DB2 CLI或ODBC，该函数返回值有些不同。如对于出错状态的情况下，ORACLE返回的是实际成功的行数，而对于DB2或ODBC它返回的总是0.

结论：对于想兼容所有的数据库来说，该函数并不适用于所有的数据库。但对于ORACLE的不同版本的数据库来说，它还是通用的。

当流的输出缓冲区刷新的时候，就会自动进行事务提交操作。

如果想避免自动提交，请设置自动提交标识为false。

该自动提交标识与数据库的自动提交是两码事，该自动提交标识只是OTL自己的自动事务提交标识。

实际上设置为非自动提交还是非常方便的，在这种情况下，就可以使用otl_nocommit_stream类。otl_nocommit_stream类是一个直接继承otl_stream类的子类，仅是关闭了自动提交标识。

默认值为真。实际上，流的析构函数试图进行刷新操作。自动刷新标识可以通过该函数进行关闭。如果自动刷新标识被关闭后，流就必须通过otl_stream::close()或otl_stream::flush()操作来强制刷新流，因为就算流的脏标志为真的情况下流的析构函数也不会去刷新缓冲区。

该函数仅是禁止析构函数里面的自动刷新功能。对于一般的缓冲区提交不能禁止。例如缓冲区满的情况下还是会自动进行刷新操作。

otl_var_desc类类型如下：

该函数用来取得输出变量的属性，参数desc_len返回的是otl_var_desc结构体大小。如果流里面没有输出参数，则返回0。如果有参数同时为输入和输出参数，它返回输出参数部分。

流的输出参数指的是取出流的部分。

流的输入参数指的是输入流的部分。

save_in_stream_pool标志是一个初始化标志。当它设置为真的时候，在定义了OTL_STREAM_POOLING_ON宏的情况下，关闭一个流，并非真正的把流关闭了，而是把该流放到一个流缓冲池下面。如果后续还要接着使用该流，那直接调用缓冲池里面的流就可以，而不用重新再新建一个流。

如果标志设置为假，那么关闭流的时候就是真正关闭了流。

在对于某些流需要消耗大量系统资源的情况下，该参数非常有用。因为可以减少分配、删除流资源的时间而提高性能。

更详细的请见例：113、114、115

仅对下列有效：

• 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)

函数返回otl_column_desc结构体的指针。otl_column_desc类型如下：

OTL定义了如下的类型与相应的数据库类型相对应：

除了返回结构体的指针外，该函数还返回一个desc_len的参数。该参数表示返回的字段列表的长度。该函数返回的结构的指针不用用户删除，流里面在析构的时候会处理删除任务。

otl_stream str
   (100,
    "INSERT INTO test_tab VALUES(:f1<int>,:f2<char[31]>)",
   db);
   ...
   try{
     // writing rows into the stream
     ...
   }catch(const otl_exception& ex){
      if(ex.code==32000){
       str.reset_to_last_valid_row();
       str.flush();
      }
   }

当定义了OTL_UNICODE的时候，它返回的是以NULL结尾的双字节的字符串。否则返回的是单字节的字符串。

读取流中的string类型

读取流中的ACE_TString类型。

读取用户自定义的与string类型兼容的类型。

必须定义OTL_STRING_TO_BIGINT/OTL_BIGINT_TO_STRING。

往流中写入一个以NULL结尾的字符串。如果定义了OTL_UNICODE，则是双字节字符串。

必须定义OTL_STRING_TO_BIGINT/OTL_BIGINT_TO_STRING。

OTL定义了一个匿名的NULL类，如下：

class otl_null

{

public:

otl_null();

~otl_null();

};

fraction/frac_precision两个成员是由数据库决定的。具体数据库支持的精度不一样，该两个成员变量值也不一样。

(const unsigned int amask=0);

otl_all_num2str

otl_all_date2str

otl_all_num2str | otl_all_date2str

(const int column_ndx,

const int col_type,

const int col_size=0);

column_ndx索引为输出字段的相对位置，如1、2、3.

col_type是由OTL定义的一组类型。

col_size是指用来存放新的类型的长度，该长度只对otl_var_char类型有效，对于数值类型能自动计算得出。

该函数能被简单的SELECT语句、带游标的SELECT语句和返回结果集的SELECT语句调用。

该函数里面的类型组合如下：

该函数强烈要求限制使用，只有在那些确实因为数值容纳不下的情况下，才允许使用otl_var_char进行转换

如果缓冲区长度被设置为1后，该函数总是返回0.因为如果缓冲区为1后，每次取出记录都会填满缓冲区，此时缓冲区被填满后就会自动刷新，所以缓冲区里面未被刷新的数据总是0条。所以总是返回0.

该函数同样可以返回SELECT语句的游标或结果集缓冲区里面的脏数据。

对于其它的（非SELECT/UPDATE/DELETE/UPDATE）SQL语句块或存储过程，该函数未定义。

如：对于某SELECT语句，第一次执行返回50,第二次执行返回50,第三次执行结果返回23,那么执行该函数时候，依次返回的的结果是50、100、123.

operator>>(otl_stream& (*pf) (otl_stream&));

s>>f1>>f2>>endr;