PrimaryKeyConstraint Class Reference

Represents a primary key constraint on a table. More...

Inherits Simba::SQLEngine::TableConstraint.

List of all members.

Public Member Functions

virtual TableConstraintClone () const
 Retrieve a clone of this constraint.
virtual const
PrimaryKeyConstraint
GetAsPrimaryKeyConstraint () const
 Return this constraint as a PrimaryKeyConstraint object.
const std::vector< simba_uint16 > & GetPrimaryKeyColumns () const
 Get the vector of column indices included in the primary key.
 PrimaryKeyConstraint (const std::vector< simba_uint16 > &in_primaryKeyColumns)
 Constructor.
virtual ~PrimaryKeyConstraint ()
 Destructor.

Detailed Description

Represents a primary key constraint on a table.

This class is used in TableSpecification to define the primary keys when creating a table.


Constructor & Destructor Documentation

PrimaryKeyConstraint ( const std::vector< simba_uint16 > &  in_primaryKeyColumns  ) 

Constructor.

Parameters:
in_primaryKeyColumns The indices of the columns included in the primary key.
virtual ~PrimaryKeyConstraint (  )  [virtual]

Destructor.


Member Function Documentation

virtual TableConstraint* Clone (  )  const [virtual]

Retrieve a clone of this constraint.

Returns:
A clone of the constraint. (OWN)

Implements TableConstraint.

virtual const PrimaryKeyConstraint* GetAsPrimaryKeyConstraint (  )  const [virtual]

Return this constraint as a PrimaryKeyConstraint object.

Returns:
This constraint as a PrimaryKeyConstraint. (NOT OWN)

Reimplemented from TableConstraint.

const std::vector<simba_uint16>& GetPrimaryKeyColumns (  )  const

Get the vector of column indices included in the primary key.

Returns:
Reference to the vector of column indices.

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

Generated on Wed May 17 14:21:18 2017 for SimbaEngine 10.1.3.1011 by simba