Represents an identity constraint of a column within a table or schema. More...

#include <rw/db/identity.h>

Public Member Functions
	RWDBIdentityConstraint (bool valid=false)

	RWDBIdentityConstraint (const RWDBIdentityConstraint &idC)

	RWDBIdentityConstraint (const RWDBValue &startWith, const RWDBValue &incrementBy, const RWDBValue &maxValue, const RWDBValue &minValue, bool cycle)

bool	cycle () const

RWDBIdentityConstraint &	cycle (bool cycle)

RWDBValue	incrementBy () const

RWDBIdentityConstraint &	incrementBy (const RWDBValue &incrementBy)

bool	isValid () const

RWDBValue	maxValue () const

RWDBIdentityConstraint &	maxValue (const RWDBValue &max)

RWDBValue	minValue () const

RWDBIdentityConstraint &	minValue (const RWDBValue &min)

RWDBIdentityConstraint &	operator= (const RWDBIdentityConstraint &idC)

RWDBValue	startWith () const

RWDBIdentityConstraint &	startWith (const RWDBValue &startWith)

Detailed Description

An RWDBIdentityConstraint is used to represent an identity column in a database. It is used with RWDBColumn to define an identity column when building up an RWDBSchema in preparation for an RWDBDatabase::createTable() call.

An RWDBIdentityConstraint is also used with RWDBColumn instances in an RWDBSchema. An RWDBSchema is a collection of RWDBColumn objects used to describe a database table. If a column of the database table is an identity column, it is represented by an RWDBIdentityConstraint. The attributes of an identity column are available via the accessor methods in RWDBIdentityConstraint.

The identity column attributes supported by database vendors varies. If an attribute is not defined for the identity column, or not available, the returned RWDBValue will be NULL and of NoType.

Constructor & Destructor Documentation

◆ RWDBIdentityConstraint() [1/3]

RWDBIdentityConstraint::RWDBIdentityConstraint ( bool valid = false )

Default constructor. No attributes are set. The created identity constraint is not valid unless true is passed to the constructor.

◆ RWDBIdentityConstraint() [2/3]

RWDBIdentityConstraint::RWDBIdentityConstraint	(	const RWDBValue &	startWith,
		const RWDBValue &	incrementBy,
		const RWDBValue &	maxValue,
		const RWDBValue &	minValue,
		bool	cycle )

Constructs a new RWDBIdentityConstraint with the supplied parameters:

startWith — the first value for the identity column
incrementBy — the interval between consecutive values of the identity column
maxValue — the maximum value at which an ascending identity column either cycles or stops generating values, or a descending identity column cycles to after reaching the minimum value
minValue — the minimum value at which a descending identity column either cycles or stops generating values, or an ascending identity column cycles to after reaching the maximum value
cycle — bool that specifies whether values continue to be generated for this column after the maximum or minimum value has been reached. The maximum and minimum values for the identity column determine the range that is used for cycling.

◆ RWDBIdentityConstraint() [3/3]

RWDBIdentityConstraint::RWDBIdentityConstraint ( const RWDBIdentityConstraint & idC )

Copy constructor. The created constraint is a deep copy of idC.

Member Function Documentation

◆ cycle() [1/2]

bool RWDBIdentityConstraint::cycle ( ) const

Returns true if the CYCLE attribute is set.

◆ cycle() [2/2]

RWDBIdentityConstraint & RWDBIdentityConstraint::cycle ( bool cycle )

Sets the CYCLE value to cycle. When creating a table, if cycle() is true, the CYCLE clause is used during table creation. If not supported by the database vendor, it is silently ignored.

◆ incrementBy() [1/2]

RWDBValue RWDBIdentityConstraint::incrementBy ( ) const

Returns the INCREMENT BY value, if available, as an RWDBValue of the appropriate type and value; otherwise the returned RWDBValue is NULL and of NoType.

◆ incrementBy() [2/2]

RWDBIdentityConstraint & RWDBIdentityConstraint::incrementBy ( const RWDBValue & incrementBy )

Sets the INCREMENT BY value to incrementBy. When creating a table, if incrementBy() is set, then the INCREMENT BY incrementBy clause is used during table creation. If not supported by the database vendor, it is silently ignored.

◆ isValid()

bool RWDBIdentityConstraint::isValid ( ) const

Returns true if self is an identity column (or any properties for defining identity columns are set).

◆ maxValue() [1/2]

RWDBValue RWDBIdentityConstraint::maxValue ( ) const

Returns the MAXVALUE, if available, as an RWDBValue of the appropriate type and value; otherwise the returned RWDBValue is NULL and of NoType.

◆ maxValue() [2/2]

RWDBIdentityConstraint & RWDBIdentityConstraint::maxValue ( const RWDBValue & max )

Sets the MAXVALUE value to max. When creating a table, if maxValue() is set, the MAXVALUE max clause is used during table creation. If not supported by the database vendor, it is silently ignored.

◆ minValue() [1/2]

RWDBValue RWDBIdentityConstraint::minValue ( ) const

Returns the MINVALUE, if available, as an RWDBValue of the appropriate type and value; otherwise the returned RWDBValue is NULL and of NoType.

◆ minValue() [2/2]

RWDBIdentityConstraint & RWDBIdentityConstraint::minValue ( const RWDBValue & min )

Sets the MINVALUE to min. When creating a table, if minValue() is set, the MINVALUE min clause is used during table creation. If not supported by the database vendor, it is silently ignored.

◆ operator=()

RWDBIdentityConstraint & RWDBIdentityConstraint::operator= ( const RWDBIdentityConstraint & idC )

Assignment operator. Self copies the implementation of idC.

◆ startWith() [1/2]

RWDBValue RWDBIdentityConstraint::startWith ( ) const

Returns the START WITH value, if available, as an RWDBValue of the appropriate type and value; otherwise the returned RWDBValue is NULL and of NoType.

◆ startWith() [2/2]

RWDBIdentityConstraint & RWDBIdentityConstraint::startWith ( const RWDBValue & startWith )

Sets the START WITH value to startWith. When creating a table, if startWith() is set, the START WITH startWith clause is used during table creation. If not supported by the database vendor, it is silently ignored.

SourcePro® API Reference Guide

Public Member Functions