sbISQLSelectBuilder Interface Reference

Interface for building SELECT statements. More...

import"sbISQLBuilder.idl";

Inheritance diagram for sbISQLSelectBuilder:
[legend]
Collaboration diagram for sbISQLSelectBuilder:
[legend]

Public Member Functions

void addColumn (in AString aTableName, in AString aColumnName)
 Add a column to the output column list. More...
 
void clearColumns ()
 Clears added columns. More...
 
void addOrder (in AString aTableName, in AString aColumnName, in boolean aAscending)
 Add an order clause to the query. More...
 
void addRandomOrder ()
 Add a random order clause to the query. More...
 
void addGroupBy (in AString aTableName, in AString aColumnName)
 Add an group by clause to the query. More...
 
- Public Member Functions inherited from sbISQLWhereBuilder
void addCriterion (in sbISQLBuilderCriterion aCriterion)
 Add a criteria constraint to the query. More...
 
void removeCriterion (in sbISQLBuilderCriterion aCriterion)
 Remve a criteria constraint from the query. More...
 
sbISQLBuilderCriterion createMatchCriterionString (in AString aTableName, in AString aSrcColumnName, in unsigned long aMatchType, in AString aValue)
 Create a match criterion with an AString datatype. More...
 
sbISQLBuilderCriterion createMatchCriterionBetweenString (in AString aTableName, in AString aSrcColumnName, in AString aLeftValue, in AString aRightValue)
 
sbISQLBuilderCriterion createMatchCriterionNotBetweenString (in AString aTableName, in AString aSrcColumnName, in AString aLeftValue, in AString aRightValue)
 
sbISQLBuilderCriterion createMatchCriterionLong (in AString aTableName, in AString aSrcColumnName, in unsigned long aMatchType, in long aValue)
 Create a match criterion with a long (32 bit) datatype. More...
 
sbISQLBuilderCriterion createMatchCriterionLongLong (in AString aTableName, in AString aSrcColumnName, in unsigned long aMatchType, in long long aValue)
 Create a match criterion with a long long (64 bit) datatype. More...
 
sbISQLBuilderCriterion createMatchCriterionNull (in AString aTableName, in AString aSrcColumnName, in unsigned long aMatchType)
 Create a match criterion that tests against the null value. More...
 
sbISQLBuilderCriterion createMatchCriterionTable (in AString aLeftTableName, in AString aLeftColumnName, in unsigned long aMatchType, in AString aRightTableName, in AString aRightColumnName)
 Create a match criterion that tests against a table column. More...
 
sbISQLBuilderCriterionIn createMatchCriterionIn (in AString aTableName, in AString aSrcColumnName)
 Create a match criterion using the IN() operator. More...
 
sbISQLBuilderCriterion createMatchCriterionParameter (in AString aTableName, in AString aSrcColumnName, in unsigned long aMatchType)
 Create a match criterion that tests against a parameter placeholder. More...
 
sbISQLBuilderCriterion createAndCriterion (in sbISQLBuilderCriterion aLeft, in sbISQLBuilderCriterion aRight)
 Create a match criterion that is the logical AND of two critera. More...
 
sbISQLBuilderCriterion createOrCriterion (in sbISQLBuilderCriterion aLeft, in sbISQLBuilderCriterion aRight)
 Create a match criterion that is the logical OR of two critera. More...
 
- Public Member Functions inherited from sbISQLBuilder
void addJoin (in unsigned long aJoinType, in AString aJoinedTableName, in AString aJoinedTableAlias, in AString aJoinedColumnName, in AString aJoinToTableName, in AString aJoinToColumnName)
 Add a join to the query. More...
 
void addJoinWithIndexHint (in unsigned long aJoinType, in AString aJoinedTableName, in AString aJoinedTableAlias, in AString aJoinedColumnName, in AString aJoinToTableName, in AString aJoinToColumnName, in boolean aRequiresFromTableIndexHint, in boolean aRequiresToTableIndexHint)
 Add a join to the query. More...
 
void addSubqueryJoin (in unsigned long aJoinType, in sbISQLSelectBuilder aJoinedSubquery, in AString aJoinedTableAlias, in AString aJoinedColumnName, in AString aJoinToTableName, in AString aJoinToColumnName)
 Add a subquery join join to the query. More...
 
void addJoinWithCriterion (in unsigned long aJoinType, in AString aJoinedTableName, in AString aJoinedTableAlias, in sbISQLBuilderCriterion aCriterion)
 Add a join to the query with a critera object specifcying the join constraints. More...
 
void addSubquery (in sbISQLSelectBuilder aSubquery, in AString aAlias)
 Add a subquery to the from clause. More...
 
void reset ()
 Clears out query configuration to this instance can be reused. More...
 
AString toString ()
 Return the generated SQL statement for the query. More...
 

Public Attributes

attribute AString baseTableName
 The query's base table. More...
 
attribute AString baseTableAlias
 The query's base table's alias. More...
 
attribute boolean distinct
 Is the query distinct? More...
 
- Public Attributes inherited from sbISQLBuilder
const unsigned long MATCH_EQUALS = 0
 
const unsigned long MATCH_NOTEQUALS = 1
 
const unsigned long MATCH_GREATER = 2
 
const unsigned long MATCH_GREATEREQUAL = 3
 
const unsigned long MATCH_LESS = 4
 
const unsigned long MATCH_LESSEQUAL = 5
 
const unsigned long MATCH_LIKE = 6
 
const unsigned long MATCH_NOTLIKE = 7
 
const unsigned long MATCH_MATCH = 8
 
attribute long limit
 Value for the limit clause. More...
 
attribute boolean limitIsParameter
 Is the limit clause a parameter? More...
 
attribute long offset
 Value for the offset clause. More...
 
attribute boolean offsetIsParameter
 Is the offset clause a parameter? More...
 
const unsigned long JOIN_INNER = 0
 
const unsigned long JOIN_LEFT = 1
 
const unsigned long JOIN_LEFT_OUTER = 2
 

Detailed Description

Interface for building SELECT statements.

Definition at line 313 of file sbISQLBuilder.idl.

Member Function Documentation

void sbISQLSelectBuilder::addColumn ( in AString  aTableName,
in AString  aColumnName 
)

Add a column to the output column list.

Parameters
aTableNameThe table name the column belongs to. To omit the table name qualification, use null.
aColumnNameThe name of the column to add to the list
void sbISQLSelectBuilder::addGroupBy ( in AString  aTableName,
in AString  aColumnName 
)

Add an group by clause to the query.

Parameters
aTableNameTable name the column belongs to
aColumnNameName of the column to group on
void sbISQLSelectBuilder::addOrder ( in AString  aTableName,
in AString  aColumnName,
in boolean  aAscending 
)

Add an order clause to the query.

Parameters
aTableNameTable name the column belongs to
aColumnNameName of the column to sort
aAscendingTrue if the sort should be ascending
void sbISQLSelectBuilder::addRandomOrder ( )

Add a random order clause to the query.

Parameters
aTableNameTable name the column belongs to
void sbISQLSelectBuilder::clearColumns ( )

Clears added columns.

Member Data Documentation

attribute AString sbISQLSelectBuilder::baseTableAlias

The query's base table's alias.

Definition at line 323 of file sbISQLBuilder.idl.

attribute AString sbISQLSelectBuilder::baseTableName

The query's base table.

Definition at line 318 of file sbISQLBuilder.idl.

attribute boolean sbISQLSelectBuilder::distinct

Is the query distinct?

Definition at line 328 of file sbISQLBuilder.idl.


The documentation for this interface was generated from the following file: