Class: TSQLHint

Declaration: SQLDataAccess.h

Taxonomy Categories:

Member Functions:

TSQLHint
~TSQLHint
operator=
GetServerNameCase
GetBooleanHint
GetTextHint
GetNumericColumnType
GetTextColumnType
GetLockSQL
GetSQLTimestamp
GetSQLTime
GetSQLDate
GetEmptyHint

Interface Category:

API. However, this class will be made as an abstract class after Release 1.0.

Inherits From:

None.

Inherited By:

TSQLStandardHint

Purpose:

Instances of TSQLHint are used to define the translation from SQLDAS/Base Client SQL to datastore native SQL. Client applications can also choose to use TSQLHint instances to construct their own native SQL statements for a datastore. Notice that this concrete class will be an abstract class after Release 1.0. Therefore, clients should get the TSQLStandardHint object from an established database connection to obtain the information needed.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TSQLHint::TSQLHint

TSQLHint ()
TSQLHint (const TSQLHint &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators and any other function that needs to construct an uninitialized object.
Called to copy an object.

Parameters:

Takes no parameters.
const TSQLHint & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLHint::~TSQLHint

virtual ~ TSQLHint ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLHint::operator=

TSQLHint & operator =(const TSQLHint &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TSQLHint & -The hint to be copied.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLHint::GetServerNameCase

virtual ECase GetServerNameCase () const

Interface Category:

API.

Purpose:

Returns the server name case for system entity names.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The server name case for system entity names.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLHint::GetBooleanHint

virtual bool GetBooleanHint (EBooleanHint) const

Interface Category:

API.

Purpose:

Returns the value of the specified Boolean attribute.

Calling Context:

Call this function directly.

Parameters:

EBooleanHint -The hint to look up.

Return Value:

Returns true if the value of the requested hint is true.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLHint::GetTextHint

virtual const TText & GetTextHint (ETextHint, TText &) const

Interface Category:

API.

Purpose:

Returns the value of the specified text attribute.

Calling Context:

Call this function directly.

Parameters:

ETextHint -The hint to look up.
TText & -On return, holds the value of the specified text attribute.

Return Value:

A const reference to the value of the specified text attribute.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLHint::GetNumericColumnType

virtual const TText & GetNumericColumnType (TText &, TSQLColumnDescriptor :: Length, TSQLColumnDescriptor :: Precision precision =0) const

Interface Category:

API.

Purpose:

Returns the native SQL for the numeric column creation.

Calling Context:

Call this function directly.

Parameters:

TText & -Returns, by fill-in reference, the native SQL for the numeric column creation.
TSQLColumnDescriptor :: Length -Specifies the size of the numeric data to be stored in the column.
TSQLColumnDescriptor :: Precision precision =0 -Specifies the precision of the numeric data to be stored in the column.

Return Value:

The column creation SQL for the specified numeric type.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLHint::GetTextColumnType

virtual const TText & GetTextColumnType (TText &, TSQLColumnDescriptor :: Length) const

Interface Category:

API.

Purpose:

Returns the native SQL for the text column creation.

Calling Context:

Call this function directly.

Parameters:

TText & -Returns, by fill-in reference, the native SQL for the text column creation.
TSQLColumnDescriptor :: Length -Specifies the size of the text data to be stored in the column.

Return Value:

The column creation SQL for the specified text type.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLHint::GetLockSQL

virtual const TText & GetLockSQL (TText & sql, const TSequenceOf < TText > & cols, const TText & table, const TText & keyConstraint) const

Interface Category:

API.

Purpose:

Returns, by value and fill-in reference, the native SQL row-locking select statement for updating the specified columns of the named table in the rows that match the given selection constraint.

Calling Context:

Call this function directly.

Parameters:

TText & sql -Returns, by fill-in reference, the native SQL row-locking select statement.
const TSequenceOf < TText > & cols -Specifies a sequence of columns containing rows to be locked for update.
const TText & table -Specifies the table containing rows to be locked for update.
const TText & keyConstraint -Specifies the SQL selection constraint for rows to be locked for update.

Return Value:

Returns, by value, the native SQL row-locking select statement.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLHint::GetSQLTimestamp

virtual const TText & GetSQLTimestamp (TText &, const TSQLTimestamp &) const

Interface Category:

API.

Purpose:

Returns, by value and fill-in reference, the native SQL that corresponds to the given time-stamp value.

Calling Context:

Call this function directly.

Parameters:

TText & -Returns, by fill-in reference, the native SQL statement.
const TSQLTimestamp & -Specifies the time-stamp value.

Return Value:

Returns, by value, the native SQL statement.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLHint::GetSQLTime

virtual const TText & GetSQLTime (TText &, const TSQLTime &) const

Interface Category:

API.

Purpose:

Returns, by value and fill-in reference, the native SQL that corresponds to the given time value.

Calling Context:

Call this function directly.

Parameters:

TText & -Returns, by fill-in reference, the native SQL statement.
const TSQLTime & -Specifies the time value.

Return Value:

Returns, by value, the native SQL statement.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLHint::GetSQLDate

virtual const TText & GetSQLDate (TText &, const TSQLDate &) const

Interface Category:

API.

Purpose:

Returns, by value and fill-in reference, the native SQL string constant that corresponds to the given date value.

Calling Context:

Call this function directly.

Parameters:

TText & -Returns, by fill-in reference, the native SQL statement.
const TSQLDate & -Specifies the date value.

Return Value:

Returns, by value, the native SQL statement.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLHint::GetEmptyHint

static const TSQLHint & GetEmptyHint ()

Interface Category:

API.

Purpose:

Obtains an empty SQL construction hint object.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns an empty construction SQL hint object.

Exceptions:

Throws a kSQLHintInvalid exception if GetSQLDate, GetSQLTime, or GetSQLTimestamp member function is called.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.