Module TabularResults

This module defines CORBA IDL constants and types for dynamic result set handling, with the intention of supporting easy conversion from and to java.sql.ResultSet (or jdbc.sql.ResultSet for JDK 1.0.2).

No interface types are defined for result set handling. When an operation returns a result set, the entire result set must be transmitted from server to client before the client can begin processing the results.

This approach has the potential to be much more efficient in a wide-area network environment than the use of interface types, which would result in a large number of small requests from client to server to fetch an entire result set. It is also preferable to streaming the result set into an octet sequence, since the IDL language mappings for the ResultSet type allow for convenient manipulation of result set data and meta-data.

If a client requires the ability to process some results before all the results have been transmitted, the result set can be explicitly broken into batches by the server programmer using an IDL interface such as:

     interface SampleInterface
     {
         TabularResults::ResultSet operationWhichReturnsResultSet(...);

         TabularResults::ResultSet getMoreResults();
     };
 

Constant Index

• FLAG_AUTO_INCREMENT
• FLAG_CASE_SENSITIVE
• FLAG_CURRENCY
• FLAG_DEFINITELY_WRITABLE
• FLAG_NOT_NULLABLE
• FLAG_NULLABLE
• FLAG_READONLY
• FLAG_SEARCHABLE
• FLAG_UNSIGNED
• FLAG_WRITABLE
• TYPE_BIGINT
• TYPE_BINARY
• TYPE_BIT
• TYPE_BLOB
• TYPE_CHAR
• TYPE_CLOB
• TYPE_DATE
• TYPE_DECIMAL
• TYPE_DOUBLE
• TYPE_FLOAT
• TYPE_INTEGER
• TYPE_LONGVARBINARY
• TYPE_LONGVARCHAR
• TYPE_NUMERIC
• TYPE_REAL
• TYPE_SMALLINT
• TYPE_TIME
• TYPE_TIMESTAMP
• TYPE_TINYINT
• TYPE_VARBINARY
• TYPE_VARCHAR

Type Index

• BinarySeq
• BooleanSeq
• Column
• ColumnSeq
• Data
• DateSeq
• DecimalSeq
• DoubleSeq
• FloatSeq
• LongSeq
• OctetSeq
• ResultSet
• ResultSets
• ShortSeq
• StringSeq
• TimeSeq
• TimestampSeq

Constants

• FLAG_AUTO_INCREMENT

      const unsigned long FLAG_AUTO_INCREMENT = 1;
  

• FLAG_CASE_SENSITIVE

      const unsigned long FLAG_CASE_SENSITIVE = 2;
  

• FLAG_CURRENCY

      const unsigned long FLAG_CURRENCY = 4;
  

• FLAG_DEFINITELY_WRITABLE

      const unsigned long FLAG_DEFINITELY_WRITABLE = 512;
  

• FLAG_NOT_NULLABLE

      const unsigned long FLAG_NOT_NULLABLE = 8;
  

• FLAG_NULLABLE

      const unsigned long FLAG_NULLABLE = 16;
  

• FLAG_READONLY

      const unsigned long FLAG_READONLY = 32;
  

• FLAG_SEARCHABLE

      const unsigned long FLAG_SEARCHABLE = 64;
  

• FLAG_UNSIGNED

      const unsigned long FLAG_UNSIGNED = 128;
  

• FLAG_WRITABLE

      const unsigned long FLAG_WRITABLE = 256;
  

• TYPE_BIGINT

      const long TYPE_BIGINT = -5;
  

• TYPE_BINARY

      const long TYPE_BINARY = -2;
  

• TYPE_BIT

      const long TYPE_BIT = -7;
  

• TYPE_BLOB

      const long TYPE_BLOB = 2004;
  

• TYPE_CHAR

      const long TYPE_CHAR = 1;
  

• TYPE_CLOB

      const long TYPE_CLOB = 2005;
  

• TYPE_DATE

      const long TYPE_DATE = 91;
  

• TYPE_DECIMAL

      const long TYPE_DECIMAL = 3;
  

• TYPE_DOUBLE

      const long TYPE_DOUBLE = 8;
  

• TYPE_FLOAT

      const long TYPE_FLOAT = 6;
  

• TYPE_INTEGER

      const long TYPE_INTEGER = 4;
  

• TYPE_LONGVARBINARY

      const long TYPE_LONGVARBINARY = -4;
  

• TYPE_LONGVARCHAR

      const long TYPE_LONGVARCHAR = -1;
  

• TYPE_NUMERIC

      const long TYPE_NUMERIC = 2;
  

• TYPE_REAL

      const long TYPE_REAL = 7;
  

• TYPE_SMALLINT

      const long TYPE_SMALLINT = 5;
  

• TYPE_TIME

      const long TYPE_TIME = 92;
  

• TYPE_TIMESTAMP

      const long TYPE_TIMESTAMP = 93;
  

• TYPE_TINYINT

      const long TYPE_TINYINT = -6;
  

• TYPE_VARBINARY

      const long TYPE_VARBINARY = -3;
  

• TYPE_VARCHAR

      const long TYPE_VARCHAR = 12;
  

Types

• BinarySeq

      typedef sequence < BCD::Binary > BinarySeq;
  

• BooleanSeq

      typedef sequence < boolean > BooleanSeq;
  

• Column

  A result column consists of meta data and data values, as well as a sequence indicating which rows contain null values. The length of 'nulls' may be less than the number of result rows. The default value if a row's 'nulls' entry is not present is false (i.e. non-null). This optimisation is particularly useful when the column's 'flags' contains the FLAG_NOT_NULLABLE bit.

      struct Column
      {
          unsigned long flags;
          unsigned long width;
          unsigned long scale;
          string name;
          string label;
          TabularResults::Data values;
          TabularResults::BooleanSeq nulls;
      };
      

  The precision for floating-point decimal values is calculated as 'width - sign - dot', where sign = 1 if the flags bit FLAG_UNSIGNED is set (otherwise sign = 0), and dot = 1 if scale > 0 (otherwise dot = 0).

  The scale must be zero for TYPE_BIGINT.

• ColumnSeq

      typedef sequence < TabularResults::Column > ColumnSeq;
  

• Data

  The Data type represents an entire column in a result set. Data is stored in a result set in column-major order. This means the column data type (the union discriminator) only needs to be transmitted over the network once, and minimises padding when using GIOP.

      union Data switch (long)
      {
          case TYPE_BIT: TabularResults::BooleanSeq booleanValues;
          case TYPE_TINYINT: TabularResults::OctetSeq octetValues;
          case TYPE_SMALLINT: TabularResults::ShortSeq shortValues;
          case TYPE_INTEGER: TabularResults::LongSeq longValues;
          case TYPE_REAL: TabularResults::FloatSeq floatValues;
          case TYPE_DOUBLE: case TYPE_FLOAT: TabularResults::DoubleSeq doubleValues;
          case TYPE_CHAR: case TYPE_LONGVARCHAR: case TYPE_VARCHAR: case TYPE_CLOB: TabularResults::StringSeq stringValues;
          case TYPE_BINARY: case TYPE_LONGVARBINARY: case TYPE_VARBINARY: case TYPE_BLOB: TabularResults::BinarySeq binaryValues;
          case TYPE_BIGINT: case TYPE_DECIMAL: case TYPE_NUMERIC: TabularResults::DecimalSeq decimalValues;
          case TYPE_DATE: TabularResults::DateSeq dateValues;
          case TYPE_TIME: TabularResults::TimeSeq timeValues;
          case TYPE_TIMESTAMP: TabularResults::TimestampSeq timestampValues;
      };
      

  Notes:

  • Type BIGINT uses BCD::Decimal because some CORBA ORBs do not support the IDL "long long" type that was introduced with CORBA 2.1 / GIOP 1.1.

• DateSeq

      typedef sequence < MJD::Date > DateSeq;
  

• DecimalSeq

      typedef sequence < BCD::Decimal > DecimalSeq;
  

• DoubleSeq

      typedef sequence < double > DoubleSeq;
  

• FloatSeq

      typedef sequence < float > FloatSeq;
  

• LongSeq

      typedef sequence < long > LongSeq;
  

• OctetSeq

      typedef sequence < octet > OctetSeq;
  

• ResultSet

  The ResultSet type may be used as the return type for an operation returning a single result set.

      struct ResultSet
      {
          unsigned long rows;
          TabularResults::ColumnSeq columns;
      };
      

• ResultSets

  The ResultSets type may be used as the return type for an operation returning multiple result sets.

      typedef sequence < TabularResults::ResultSet > ResultSets;
  

• ShortSeq

      typedef sequence < short > ShortSeq;
  

• StringSeq

      typedef sequence < string > StringSeq;
  

• TimeSeq

      typedef sequence < MJD::Time > TimeSeq;
  

• TimestampSeq

      typedef sequence < MJD::Timestamp > TimestampSeq;