AECreateIndex Class Reference

A class models the statement that creates an index on one or more columns. More...

Inherits AETerminalExprT< AERowCountStatement >.

List of all members.

Public Member Functions

virtual void AcceptVisitor (AENodeVisitor &in_visitor)
 Calls the correct method on the visitor.
 AECreateIndex (const AECreateIndex &in_other)
 Copy constructor.
 AECreateIndex (const simba_wstring &in_name, const std::vector< DSIExtIndexColumn > &in_columns, const simba_wstring &in_type, bool in_isUnique, const SharedPtr< DSIExtResultSet > &in_indexTable)
 Constructor.
virtual AECreateIndexClone () const
 Creates a clone of this node object.
virtual const AECreateIndexGetAsCreateIndex () const
 Gets the statement as an AECreateIndex object.
virtual AECreateIndexGetAsCreateIndex ()
 Gets the statement as an AECreateIndex object.
const std::vector
< DSIExtIndexColumn > & 
GetColumns () const
 Get the list of columns in the index.
virtual const
Simba::DSI::ExecutedSQLInfo
GetExecutedSQLInfo () const
 Return information about this statement.
virtual simba_wstring GetLogString () const
 Returns a string name for this node for the purpose of logging.
const simba_wstringGetName () const
 Get the name of the index.
virtual AENodeType GetNodeType () const
 Returns an integer that uniquely identifies the node class. See the definition of AENodeType for values defined.
SharedPtr< DSIExtResultSetGetTable () const
 Get the table that the index will be created on.
const simba_wstringGetType () const
 Get the type of the index.
bool IsUnique () const
 Returns true if the index is unique.
virtual void Validate ()
 Validates the node. If the function successfully returns, then the node is valid.
virtual ~AECreateIndex ()
 Destructor.

Detailed Description

A class models the statement that creates an index on one or more columns.

This statement is not defined the SQL-92 spec but is a widely used extension.

Will always have no children (GetChildCount() returns 0).


Constructor & Destructor Documentation

AECreateIndex ( const simba_wstring in_name,
const std::vector< DSIExtIndexColumn > &  in_columns,
const simba_wstring in_type,
bool  in_isUnique,
const SharedPtr< DSIExtResultSet > &  in_indexTable 
)

Constructor.

Parameters:
in_name The name of the index.
in_columns The columns included in the index.
in_type The type of the index, can be a NULL wstring.
in_isUnique True if the index is unique.
in_indexTable The table of the index.
AECreateIndex ( const AECreateIndex in_other  ) 

Copy constructor.

To support "cloning". See Clone() method.

Parameters:
in_other The other node to create copy from.
virtual ~AECreateIndex (  )  [virtual]

Destructor.


Member Function Documentation

virtual void AcceptVisitor ( AENodeVisitor in_visitor  )  [virtual]

Calls the correct method on the visitor.

Parameters:
in_visitor The visiting object.

Implements AENode.

virtual AECreateIndex* Clone (  )  const [virtual]

Creates a clone of this node object.

Returns:
A clone of this node object. (OWN)

Implements AERowCountStatement.

virtual const AECreateIndex* GetAsCreateIndex (  )  const [inline, virtual]

Gets the statement as an AECreateIndex object.

Returns:
this object as an AECreateIndex object. (NOT OWN)

Reimplemented from AEStatement.

virtual AECreateIndex* GetAsCreateIndex (  )  [inline, virtual]

Gets the statement as an AECreateIndex object.

Returns:
this object as an AECreateIndex object. (NOT OWN)

Reimplemented from AEStatement.

const std::vector<DSIExtIndexColumn>& GetColumns (  )  const

Get the list of columns in the index.

Returns:
The list of columns.
virtual const Simba::DSI::ExecutedSQLInfo& GetExecutedSQLInfo (  )  const [virtual]

Return information about this statement.

Returns:
The executed SQL information linked to this statement.

Implements AEStatement.

virtual simba_wstring GetLogString (  )  const [virtual]

Returns a string name for this node for the purpose of logging.

Returns:
A string representation of this node for logging purposes.

Implements AENode.

const simba_wstring& GetName (  )  const

Get the name of the index.

Returns:
The name of the index.
virtual AENodeType GetNodeType (  )  const [virtual]

Returns an integer that uniquely identifies the node class. See the definition of AENodeType for values defined.

Returns:
The ID that uniquely identifies this type of nodes.

Implements AENode.

SharedPtr<DSIExtResultSet> GetTable (  )  const

Get the table that the index will be created on.

Returns:
The table that the index will be created on.
const simba_wstring& GetType (  )  const

Get the type of the index.

Returns:
The type of index.
bool IsUnique (  )  const

Returns true if the index is unique.

Returns:
True if the index is unique.
virtual void Validate (  )  [virtual]

Validates the node. If the function successfully returns, then the node is valid.

Exceptions:
AEInvalidAetException if the node is not valid.

Reimplemented from AENode.


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

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