Summary of Classes

DB Interface Module User's Guide
Rogue Wave web site: Home Page | Main Documentation Page

3.2 Summary of Classes

Now that we have described the categories of classes in the DB Interface Module, we list the individual classes and their operations in Table 1. In Table 2, we list the classes of the Essential Tools Module of SourcePro Core that are referenced by the DB Interface Module API.

Table 1: Summary of the classes of the DB Interface Module

Class	Operation
*RWDBAssignment*	Represents the SQL `Set x = y` phrase
*RWDBBinaryVector*	Vector of data to be used with the bulk read and write classes. Deprecated. Use class *RWDBTBuffer<T>*.
*RWDBBlob*	Stores Binary Large Objects
*RWDBBoundExpr*	Represents a placeholder in dynamic SQL statements
*RWDBBulkInserter*	Encapsulates the bulk write mechanism of the DB Interface Module
*RWDBBulkReader*	Encapsulates the bulk read mechanism of the DB Interface Module
*RWDBCollectableExpr*	SQL expression that can be placed in an *RWCollection*
*RWDBColumn*	References a specific column in a table
*RWDBCompoundSelector*	Created as the result of the set operations `UNION`, `INTERSECTION`, and `DIFFERENCE` on *RWDBSelector*
*RWDBConnection*	Represents a database connection
*RWDBConnCallback*	Interface handle class for connection callback implementation.
*RWDBConnCallbackImp*	Abstract base class for users to derive from and implement connection callbacks.
*RWDBCriterion*	Represents an SQL expression evaluated as a boolean
*RWDBCritFormDefinition*	Defines boolean SQL expressions using replacement text
*RWDBCritFuncDef{n}*	Defines boolean SQL expressions with `n` arguments
*RWDBCursor*	Represents a database cursor
*RWDBDatabase*	Represents a database
*RWDBDatabaseCallback*	Interface handle class for database callback implementation.
*RWDBDatabaseCallbackImp*	Abstract base class for users to derive from and implement database callbacks.
*RWDBDateTime*	Stores a date and time value. Deprecated. Use class *RWDateTime*.
*RWDBDateVector*	Date vector of data to be used with the bulk read and write classes. Deprecated. Use class *RWDBTBuffer<T>*.
*RWDBDecimalVector*	Decimal vector of data to be used with the bulk read and write classes.Deprecated. Use class *RWDBTBuffer<T>*.
*RWDBDeleter*	Encapsulates the SQL `DELETE` statement
*RWDBDuration*	Stores a time period
*RWDBEnvironmentHandle*	Provides methods an application can use to set or retrieve database-vendor-specific connect time and configuration parameters
*RWDBExpr*	Codes SQL expressions using C++ syntax
*RWDBExprFormDefinition*	Defines SQL expressions using replacement text
*RWDBExprFuncDef{n}*	Defines SQL functions with `n` arguments
*RWDBForeignKey*	Encapsulates the SQL notion of foreign keys
*RWDBForeignKeyList*	Represents a list of foreign keys associated with a table
*RWDBInserter*	Encapsulates the SQL `INSERT` statement
*RWDBJoinExpr*	Defines SQL `JOIN` expressions for ANSI-compliant servers
*RWDBManager*	Produces database-dependent instances of *RWDBDatabase*
*RWDBMBString*	Stores a multibyte string
*RWDBMemTable*	Stores tabular data in memory
*RWDBMultiRow*	Adds row semantics to collections of *RWDBTBuffer*s
*RWDBNullIndicator*	Used to detect `NULL` values
*RWDBOSql*	Used to encapsulate an SQL statement and its input and output bindings.
*RWDBPhraseBook*	Standardizes SQL dialects
*RWDBReader*	Reads tabular data one row at a time
*RWDBResult*	Represents a sequence of 0 or more tables of results
*RWDBRow*	Stores a single row of data
*RWDBSchema*	Contains a list of column definitions
*RWDBSelector*	Encapsulates the SQL `SELECT` statement
*RWDBSelectorBase*	The base class for *RWDBSelector* and *RWDBCompoundSelector*. This class should be treated as an abstract base class.
*RWDBStatus*	Represents the status of an object or an operation. Used in error handling.
*RWDBStoredProc*	Represents a database stored procedure
*RWDBStringVector*	String vector of data to be used with the bulk read and write classes. Deprecated. Use class *RWDBTBuffer<T>*.
*RWDBSystemHandle*	Provides access to the underlying vendor-specific database API
*RWDBTable*	Represents tabular data, including database tables and result sets
*RWDBTBuffer<T>*	Encapsulates buffers of data that can be bound to the SQL statement encapsulated by *RWDBOSql. May also be used in RWDBBulkInserter* and *RWDBBulkReader*.
*RWDBTPtrMemTable<T,C>*	A template version of tabular data in memory
*RWDBTracer*	Provides runtime tracing
*RWDBUpdater*	Encapsulates the SQL `UPDATE` statement
*RWDBValue*	Normalizes database data types
*RWDBVector*	Vector of data to be used with the bulk read and write classes. Deprecated. Use class *RWDBTBuffer<T>*.

Table 2: Classes of the Essential Tools Module of SourcePro Core that are referenced by the API of the DB Interface Module

Class	Operation
*RWBasicUString*	Facilitates storage and manipulation of UTF-16 Unicode strings
*RWCollectable*	Abstract base class for collectable objects
*RWCString*	Facilitates string manipulation like the standard C functions
*RWDate (deprecated)*	Represents a date, stored as a Julian day number
*RWDateTime*	Represents a date and time
*RWDecimalPortable*	Represents an arbitrary precision decimal fraction as a character string
*RWLocale*	An abstract base class that defines an interface for formatting dates, times, numbers, and currency to and from strings
*RWTime (deprecated)*	Represents a time, stored as the number of seconds since 00:00:00 January 1, 1901 GMT
*RWWString*	Facilitates manipulation of wide character strings

© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.