Class: TSQLTableDescriptor

Declaration: SQLDataAccess.h

Taxonomy Categories:

Member Functions:

~TSQLTableDescriptor
TSQLTableDescriptor
operator=
GetName
GetOwner
GetQualifier
GetType
GetRemarks
operator<<=
operator>>=

Interface Category:

API.

Inherits From:

MCollectible, MReferenceCounted

Inherited By:

None.

Purpose:

This concrete class provides descriptive information for a single database table. Instead of using this master class, clients should use the associated counted pointer class, TSQLTableDescriptorHandle.

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: TSQLTableDescriptor::~TSQLTableDescriptor

virtual ~ TSQLTableDescriptor ()

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: TSQLTableDescriptor::TSQLTableDescriptor

TSQLTableDescriptor (const TSQLTableDescriptor & source)
TSQLTableDescriptor ()
TSQLTableDescriptor (const TText & table, const TText & owner =TStandardText :: GetEmptyText (), const TText & qualifier =TStandardText :: GetEmptyText (), const TText & type =TStandardText :: GetEmptyText (), const TText & remarks =TStandardText :: GetEmptyText ())

Interface Category:

API.

Purpose:

Copy constructor.
Default constructor.
A constructor that takes client specifics.

Calling Context:

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

Parameters:

const TSQLTableDescriptor & source -The object to copy.
Takes no parameters.
const TText & table -The table name.
const TText & owner =TStandardText :: GetEmptyText () -The table owner.
const TText & qualifier =TStandardText :: GetEmptyText () -The table qualifier.
const TText & type =TStandardText :: GetEmptyText () -The table type.
const TText & remarks =TStandardText :: GetEmptyText () -Any remarks associated with the table.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTableDescriptor::operator=

TSQLTableDescriptor & operator =(const TSQLTableDescriptor & right)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TSQLTableDescriptor & right -The table descriptor 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: TSQLTableDescriptor::GetName

const TText & GetName (TText &) const

Interface Category:

API.

Purpose:

Returns the database table name.

Calling Context:

Call this function directly.

Parameters:

TText & -On return, holds the database table name.

Return Value:

A const reference to the database table name.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTableDescriptor::GetOwner

const TText & GetOwner (TText &) const

Interface Category:

API.

Purpose:

Returns the database owner name.

Calling Context:

Call this function directly.

Parameters:

TText & -On return, holds the database owner name.

Return Value:

A const reference to the database owner name.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTableDescriptor::GetQualifier

const TText & GetQualifier (TText &) const

Interface Category:

API.

Purpose:

Returns the qualifier of the table. The qualifier is typically used for the database name.

Calling Context:

Call this function directly.

Parameters:

TText & -On return, holds the qualifier of the table.

Return Value:

A const reference to the qualifier of the table.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTableDescriptor::GetType

const TText & GetType (TText &) const

Interface Category:

API.

Purpose:

Returns the database table type name. The type name returned is data source specific, but is typically Table, View, and so forth.

Calling Context:

Call this function directly.

Parameters:

TText & -On return, holds the database table type name.

Return Value:

A const reference to the database table type name.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTableDescriptor::GetRemarks

const TText & GetRemarks (TText &) const

Interface Category:

API.

Purpose:

Returns any remarks associated with the table.

Calling Context:

Call this function directly.

Parameters:

TText & -On return, holds the remarks associated with the table.

Return Value:

A const reference to the remarks associated with the table.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTableDescriptor::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator. Streams in an SQL table description.

Calling Context:

Called to stream in data.

Parameters:

TStream & -The stream the object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSQLTableDescriptor::operator>>=

virtual TStream & operator >>=(TStream &) const

Interface Category:

API.

Purpose:

Stream-out operator. Streams out an SQL table description.

Calling Context:

Called to stream out data.

Parameters:

TStream & -The stream the object streams itself out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

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.