Class: TSQLStandardHint

Declaration: SQLStandardDataAccess.h

Taxonomy Categories:

Member Functions:

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

Interface Category:

API.

Inherits From:

TSQLHint

Inherited By:

None.

Purpose:

This concrete class provides SQL construction hints for a standard connection.

Instantiation:

Allocate on the heap or the stack. Obtain instances of this class from TSQLStandardConnectionHandle::GetSQLHint.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TSQLStandardHint::TSQLStandardHint

TSQLStandardHint ()
TSQLStandardHint (const TSQLStandardHint &)
TSQLStandardHint (TSQLStandardConnection &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.
A constructor that binds the hint to the given connection.

Calling Context:

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

Parameters:

Takes no parameters.
const TSQLStandardHint & -The object to copy.
TSQLStandardConnection & -Specifies the connection to be bound.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLStandardHint::~TSQLStandardHint

virtual ~ TSQLStandardHint ()

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: TSQLStandardHint::operator=

TSQLStandardHint & operator =(const TSQLStandardHint &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TSQLStandardHint & -The object to copy.

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: TSQLStandardHint::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: TSQLStandardHint::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: TSQLStandardHint::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: TSQLStandardHint::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: TSQLStandardHint::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: TSQLStandardHint::GetLockSQL

virtual const TText & GetLockSQL (TText &, const TSequenceOf < TText > &, const TText &, const TText &) 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 & -Returns, by fill-in reference, the native SQL row-locking select statement.
const TSequenceOf < TText > & -Specifies a sequence of columns containing rows to be locked for update.
const TText & -Specifies the table containing rows to be locked for update.
const TText & -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: TSQLStandardHint::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: TSQLStandardHint::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: TSQLStandardHint::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.

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