TConstraint (General SQL Parser Java Library Core 3.0.9.1 API)

Object
- gudusoft.gsqlparser.nodes.TParseTreeNode
- - gudusoft.gsqlparser.nodes.TConstraint

All Implemented Interfaces:

Visitable, Iterator<TSourceToken>
```
public class TConstraint
extends TParseTreeNode
```
Use a constraint to define an integrity constraint, a rule that restricts the values in a database.
Oracle Database lets you create six types of constraints and lets you declare them in two ways.
- A NOT NULL constraint prohibits a database value from being null.
- A unique constraint prohibits multiple rows from having the same value in the same column or combination of columns but allows some values to be null. call method getColumnList() to result columns of this unique key.
- A primary key constraint combines a NOT NULL constraint and a unique constraint in a single declaration. It prohibits multiple rows from having the same value in the same column or combination of columns and prohibits values from being null. call method getColumnList() to result columns of this primary key.
- A foreign key constraint requires values in one table to match values in another table. call method getColumnList() to result columns of this foreign key.
- A check constraint requires a value in the database to comply with a specified condition. call method getCheckCondition() to return this condition.
- A REF column by definition references an object in another object type or in a relational table. A REF constraint lets you further describe the relationship between the REF column and the object it references.
- default constraint is valid in sql server.
See Also:

EConstraintType.notnull, EConstraintType.unique, EConstraintType.primary_key, EConstraintType.foreign_key, EConstraintType.check, EConstraintType.reference, EConstraintType.default_value

Field Summary
- Fields inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode
  dbvendor, doubleLinkedTokenListToString, nodeActionAppend, nodeActionInsert, nodeActionRemove, nodeActionUnknown, nodeActionUpdate, nodeActionUpdateText, nodeChangeEndToken, nodeChangeStartToken

Constructor Summary

Constructors
Constructor and Description

TConstraint()

Constructors
Constructor and Description
`TConstraint()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`accept(TParseTreeVisitor v)` Accept a visitor
`void`	`acceptChildren(TParseTreeVisitor v)` Accept a visitor to iterate this class and sub-nodes of this class
`void`	`doParse(TCustomSqlStatement psql, ESqlClause plocation)` Analyze the sub-nodes inside this node.
`TPTNodeList<TAutomaticProperty>`	`getAutomaticProperties()`
`TExpression`	`getCheckCondition()`
`TColumnGeneratedClause`	`getColumnGeneratedClause()`
`TPTNodeList<TColumnWithSortOrder>`	`getColumnList()`
`TObjectName`	`getCommentObject()`
`EConstraintType`	`getConstraint_type()`
`int`	`getConstraintLevel()`
`TObjectName`	`getConstraintName()`
`TExpression`	`getDefaultExpression()`
`TObjectName`	`getForObjectName()`
`TExpression`	`getIncrement()` Used internal
`TPTNodeList<TIndexColName>`	`getIndexCols()` Deprecated. since 1.8.7.2, use `getColumnList()` instead.
`TObjectName`	`getIndexColumnName()` Snowflake index table constraint: CREATE TABLE t1 (c1 INT, c2 INT, CONSTRAINT c1_idx INDEX (c1));
`TObjectName`	`getIndexName()` SQL Server, index name of table index when `getConstraint_type()` is `EConstraintType.table_index` or index name of column index when `getConstraint_type()` is `EConstraintType.column_index`
`TPTNodeList<TKeyAction>`	`getKeyActions()`
`TDummy`	`getOnFilegroup()`
`TObjectNameList`	`getReferencedColumnList()`
`TObjectName`	`getReferencedObject()`
`TExpression`	`getSeed()` Used internal
`TDummy`	`getWithIndexoption()`
`void`	`init(Object arg1)` Initialize a query tree node.
`void`	`init(Object arg1, Object arg2)`
`void`	`init(Object arg1, Object arg2, Object arg3)`
`boolean`	`isClustered()`
`boolean`	`isNonClustered()`
`void`	`setAutomaticProperties(TPTNodeList<TAutomaticProperty> automaticProperties)`
`void`	`setCheckCondition(TExpression checkCondition)`
`void`	`setClustered(boolean clustered)`
`void`	`setClusteredToken(TSourceToken clusteredToken)`
`void`	`setColumnGeneratedClause(TColumnGeneratedClause columnGeneratedClause)`
`void`	`setColumnList(TPTNodeList<TColumnWithSortOrder> columnList)`
`void`	`setCommentObject(TObjectName commentObject)`
`void`	`setConstraint_type(EConstraintType constraint_type)`
`void`	`setConstraintLevel(int constraintLevel)`
`void`	`setConstraintName(TObjectName constraintName)`
`void`	`setDefaultExpression(TExpression defaultExpression)`
`void`	`setForObjectName(TObjectName forObjectName)`
`void`	`setIncrement(TExpression increment)`
`void`	`setIndexCols(TPTNodeList<TIndexColName> indexCols)`
`void`	`setKeyActions(TPTNodeList<TKeyAction> keyActions)`
`void`	`setNonClustered(boolean nonClustered)`
`void`	`setOnFilegroup(TDummy onFilegroup)`
`void`	`setReferencedColumnList(TObjectNameList referencedColumnList)`
`void`	`setReferencedObject(TObjectName referencedObject)`
`void`	`setSeed(TExpression seed)`
`void`	`setWithIndexoption(TDummy withIndexoption)`

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode
addAllMyTokensToTokenList, addToTokenChain, appendNewNode, calculateTokenCount, doAppendNewNode, fastSetString, getAnchorNode, getColumnNo, getCommentAfterNode, getCommentBeforeNode, getCompactString, getDummyTag, getEndToken, getEvaluateDatatype, getEvalValue, getGsqlparser, getLineNo, getLocation, getMd5, getNodeStatus, getNodeType, getParentObjectName, getPlainText, getStartToken, getTokenCount, hasNext, init, init, init, insertAfterAToken, insertNewNodeBeforeMe, isChanged, isTokensInChain, next, refreshAllNodesTokenCount, remove, removeAllMyTokensFromTokenList, removeTokens, removeTokensBetweenNodes, removeTokensBetweenToken, replaceWithNewNode, resetIterator, setAnchorNode, setChanged, setDummyTag, setEndToken, setEndToken, setEndToken, setEndToken, setEndToken, setEndTokenDirectly, setEvaluateDatatype, setEvalValue, setGsqlparser, setIncludingComment, setLocation, setNewSubNode, setNodeStatus, setNodeType, setParent, setPlainText, setStartToken, setStartToken, setStartToken, setStartToken, setStartTokenDirectly, setString, setString2, subNodeInNode, toScript, toString, toString2

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Iterator
forEachRemaining

- Constructor Detail
  - TConstraint
```
public TConstraint()
```
- Method Detail
  - setColumnGeneratedClause
```
public void setColumnGeneratedClause(TColumnGeneratedClause columnGeneratedClause)
```
  - getColumnGeneratedClause
```
public TColumnGeneratedClause getColumnGeneratedClause()
```
  - setOnFilegroup
```
public void setOnFilegroup(TDummy onFilegroup)
```
  - getOnFilegroup
```
public TDummy getOnFilegroup()
```
  - setWithIndexoption
```
public void setWithIndexoption(TDummy withIndexoption)
```
  - getWithIndexoption
```
public TDummy getWithIndexoption()
```
  - getIndexName
```
public TObjectName getIndexName()
```
    SQL Server, index name of table index when getConstraint_type() is EConstraintType.table_index or index name of column index when getConstraint_type() is EConstraintType.column_index
    
    Returns:
    
    index name
  - setCommentObject
```
public void setCommentObject(TObjectName commentObject)
```
  - setForObjectName
```
public void setForObjectName(TObjectName forObjectName)
```
  - getForObjectName
```
public TObjectName getForObjectName()
```
  - getCommentObject
```
public TObjectName getCommentObject()
```
  - setKeyActions
```
public void setKeyActions(TPTNodeList<TKeyAction> keyActions)
```
  - getKeyActions
```
public TPTNodeList<TKeyAction> getKeyActions()
```
  - setConstraintLevel
```
public void setConstraintLevel(int constraintLevel)
```
  - getConstraintLevel
```
public int getConstraintLevel()
```
    Returns:
    
    is this a columnn level constraint or table level constraint TBaseType.constraint_level_table or TBaseType.constraint_level_column.
  - setDefaultExpression
```
public void setDefaultExpression(TExpression defaultExpression)
```
  - getDefaultExpression
```
public TExpression getDefaultExpression()
```
    Returns:
    
    default expression of sql server.
  - setConstraintName
```
public void setConstraintName(TObjectName constraintName)
```
  - getConstraintName
```
public TObjectName getConstraintName()
```
    Returns:
    
    name for the constraint, it's optional.
  - setConstraint_type
```
public void setConstraint_type(EConstraintType constraint_type)
```
  - getConstraint_type
```
public EConstraintType getConstraint_type()
```
    Returns:
    
    type of constraints.
    
    See Also:
    
    EConstraintType.notnull, EConstraintType.unique, EConstraintType.primary_key, EConstraintType.foreign_key, EConstraintType.check, EConstraintType.reference, EConstraintType.default_value
  - setClustered
```
public void setClustered(boolean clustered)
```
  - setClusteredToken
```
public void setClusteredToken(TSourceToken clusteredToken)
```
  - isClustered
```
public boolean isClustered()
```
  - isNonClustered
```
public boolean isNonClustered()
```
  - setNonClustered
```
public void setNonClustered(boolean nonClustered)
```
  - setAutomaticProperties
```
public void setAutomaticProperties(TPTNodeList<TAutomaticProperty> automaticProperties)
```
  - getAutomaticProperties
```
public TPTNodeList<TAutomaticProperty> getAutomaticProperties()
```
    Returns:
    
    Automatic Initialization and Updating for TIMESTAMP in MySQL
  - getCheckCondition
```
public TExpression getCheckCondition()
```
    Returns:
    
    used in check constraint, requires a value in the database to comply with this specified condition.
  - getColumnList
```
public TPTNodeList<TColumnWithSortOrder> getColumnList()
```
    Returns:
    
    column name list used when constraint type is unique, primary key or foreign key.
  - setColumnList
```
public void setColumnList(TPTNodeList<TColumnWithSortOrder> columnList)
```
  - getIndexCols
```
public TPTNodeList<TIndexColName> getIndexCols()
```
    Deprecated. since 1.8.7.2, use getColumnList() instead.
    
    Returns:
  - init
```
public void init(Object arg1)
```
    Description copied from class: TParseTreeNode
    
    Initialize a query tree node. Used internally
    
    Overrides:
    
    init in class TParseTreeNode
    
    Parameters:
    
    arg1 - first argument
  - getIndexColumnName
```
public TObjectName getIndexColumnName()
```
    Snowflake index table constraint: CREATE TABLE t1 (c1 INT, c2 INT, CONSTRAINT c1_idx INDEX (c1));
    
    Returns:
  - init
```
public void init(Object arg1,
                 Object arg2,
                 Object arg3)
```
    Overrides:
    
    init in class TParseTreeNode
  - init
```
public void init(Object arg1,
                 Object arg2)
```
    Overrides:
    
    init in class TParseTreeNode
  - setReferencedColumnList
```
public void setReferencedColumnList(TObjectNameList referencedColumnList)
```
  - getReferencedColumnList
```
public TObjectNameList getReferencedColumnList()
```
    Returns:
    
    column name list of referenced object in reference clause when constraint type is REF constraint.
  - setReferencedObject
```
public void setReferencedObject(TObjectName referencedObject)
```
  - getReferencedObject
```
public TObjectName getReferencedObject()
```
    Returns:
    
    referenced object in reference clause when constraint type is REF constraint.
  - setIncrement
```
public void setIncrement(TExpression increment)
```
  - setSeed
```
public void setSeed(TExpression seed)
```
  - getIncrement
```
public TExpression getIncrement()
```
    Used internal
    
    Returns:
  - getSeed
```
public TExpression getSeed()
```
    Used internal
    
    Returns:
  - accept
```
public void accept(TParseTreeVisitor v)
```
    Description copied from class: TParseTreeNode
    
    Accept a visitor
    
    Specified by:
    
    accept in interface Visitable
    
    Overrides:
    
    accept in class TParseTreeNode
    
    Parameters:
    
    v - visitor is a descendant class of TParseTreeVisitor
  - acceptChildren
```
public void acceptChildren(TParseTreeVisitor v)
```
    Description copied from class: TParseTreeNode
    
    Accept a visitor to iterate this class and sub-nodes of this class
    
    Specified by:
    
    acceptChildren in interface Visitable
    
    Overrides:
    
    acceptChildren in class TParseTreeNode
    
    Parameters:
    
    v - visitor is a descendant class of TParseTreeVisitor
  - doParse
```
public void doParse(TCustomSqlStatement psql,
                    ESqlClause plocation)
```
    Description copied from class: TParseTreeNode
    
    Analyze the sub-nodes inside this node. Such as build the relationship between table and column.
    
    Overrides:
    
    doParse in class TParseTreeNode
    
    Parameters:
    
    psql - SQL statement this node belongs to
    
    plocation - SQL clause this node belongs to
  - setCheckCondition
```
public void setCheckCondition(TExpression checkCondition)
```
  - setIndexCols
```
public void setIndexCols(TPTNodeList<TIndexColName> indexCols)
```

Class TConstraint

Field Summary

Fields inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

Constructor Summary

Method Summary

Methods inherited from class gudusoft.gsqlparser.nodes.TParseTreeNode

Methods inherited from class Object

Methods inherited from interface Iterator

Constructor Detail

TConstraint

Method Detail

setColumnGeneratedClause

getColumnGeneratedClause

setOnFilegroup

getOnFilegroup

setWithIndexoption

getWithIndexoption

getIndexName

setCommentObject

setForObjectName

getForObjectName

getCommentObject

setKeyActions

getKeyActions

setConstraintLevel

getConstraintLevel

setDefaultExpression

getDefaultExpression

setConstraintName

getConstraintName

setConstraint_type

getConstraint_type

setClustered

setClusteredToken

isClustered

isNonClustered

setNonClustered

setAutomaticProperties

getAutomaticProperties

getCheckCondition

getColumnList

setColumnList

getIndexCols

init

getIndexColumnName

init

init

setReferencedColumnList

getReferencedColumnList

setReferencedObject

getReferencedObject

setIncrement

setSeed

getIncrement

getSeed

accept

acceptChildren

doParse

setCheckCondition

setIndexCols