Package rife.database.queries

Class AlterTable

java.lang.Object

rife.database.queries.AlterTable

All Implemented Interfaces:

Cloneable, Query

public class AlterTable
extends Object
implements Cloneable

Object representation of a SQL "ALTER TABLE" query.

This object may be used to dynamically construct a SQL statement in a database-independent fashion. After it is finished, it may be executed using DbQueryManager.executeUpdate().

Each AlterTable instance performs exactly one alteration, since that is the only form that all the databases support. When you need several alterations, you simply execute them as a series of AlterTable queries.

The alterColumnType alteration restates the complete column definition on the databases that require it, like MySQL and Oracle, so that the nullability and the default that you provide with it become part of the restated definition. Databases that alter the type in isolation only change the type, which means that you have to alter the nullability and the default there with the dedicated alterColumnNullable and alterColumnDefault alterations.

Since:

1.10

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AlterTable.Alteration	Provides the alterations that an AlterTable query can perform.

Field Summary

Fields

Modifier and Type	Field	Description
static final CreateTable.ViolationAction	CASCADE
protected Datasource	datasource_
protected boolean	excludeUnsupportedCapabilities_
static final CreateTable.ViolationAction	NOACTION
static final CreateTable.Nullable	NOTNULL
static final CreateTable.Nullable	NULL
static final CreateTable.ViolationAction	RESTRICT
static final CreateTable.ViolationAction	SETDEFAULT
static final CreateTable.ViolationAction	SETNULL
protected String	sql_

Constructor Summary

Constructors

Constructor	Description
AlterTable(Datasource datasource)

Method Summary

Modifier and Type	Method	Description
AlterTable	addCheck(String expression)
AlterTable	addCheck(String name, String expression)
AlterTable	addColumn(Class beanClass, String propertyName)
AlterTable	addColumn(String name, Class type)
AlterTable	addColumn(String name, Class type, int precision)
AlterTable	addColumn(String name, Class type, int precision, int scale)
AlterTable	addColumn(String name, Class type, int precision, int scale, String typeAttribute)
AlterTable	addColumn(String name, Class type, int precision, int scale, String typeAttribute, CreateTable.Nullable nullable)
AlterTable	addColumn(String name, Class type, int precision, int scale, CreateTable.Nullable nullable)
AlterTable	addColumn(String name, Class type, int precision, String typeAttribute)
AlterTable	addColumn(String name, Class type, int precision, String typeAttribute, CreateTable.Nullable nullable)
AlterTable	addColumn(String name, Class type, int precision, CreateTable.Nullable nullable)
AlterTable	addColumn(String name, Class type, String typeAttribute)
AlterTable	addColumn(String name, Class type, String typeAttribute, CreateTable.Nullable nullable)
AlterTable	addColumn(String name, Class type, CreateTable.Nullable nullable)
AlterTable	addColumn(String name, String customType)
AlterTable	addColumn(String name, String customType, CreateTable.Nullable nullable)
AlterTable	addForeignKey(String foreignTable, String[] columnsMapping)
AlterTable	addForeignKey(String foreignTable, String[] columnsMapping, CreateTable.ViolationAction onUpdate, CreateTable.ViolationAction onDelete)
AlterTable	addForeignKey(String foreignTable, String localColumn, String foreignColumn)
AlterTable	addForeignKey(String name, String foreignTable, String[] columnsMapping)
AlterTable	addForeignKey(String name, String foreignTable, String[] columnsMapping, CreateTable.ViolationAction onUpdate, CreateTable.ViolationAction onDelete)
AlterTable	addForeignKey(String name, String foreignTable, String localColumn, String foreignColumn)
AlterTable	addForeignKey(String name, String foreignTable, String localColumn, String foreignColumn, CreateTable.ViolationAction onUpdate, CreateTable.ViolationAction onDelete)
AlterTable	addForeignKey(String foreignTable, String localColumn, String foreignColumn, CreateTable.ViolationAction onUpdate, CreateTable.ViolationAction onDelete)
AlterTable	addPrimaryKey(String column)
AlterTable	addPrimaryKey(String[] columns)
AlterTable	addPrimaryKey(String name, String column)
AlterTable	addPrimaryKey(String name, String[] columns)
AlterTable	addUnique(String column)
AlterTable	addUnique(String[] columns)
AlterTable	addUnique(String name, String column)
AlterTable	addUnique(String name, String[] columns)
AlterTable	alterColumnDefault(Class beanClass, String propertyName, Object value)
AlterTable	alterColumnDefault(String name, boolean value)
AlterTable	alterColumnDefault(String name, Object value)
AlterTable	alterColumnDefaultFunction(String name, String defaultFunction)
AlterTable	alterColumnNullable(Class beanClass, String propertyName, CreateTable.Nullable nullable)
AlterTable	alterColumnNullable(String name, CreateTable.Nullable nullable)
AlterTable	alterColumnType(Class beanClass, String propertyName)
AlterTable	alterColumnType(String name, Class type)
AlterTable	alterColumnType(String name, Class type, int precision)
AlterTable	alterColumnType(String name, Class type, int precision, int scale)
AlterTable	alterColumnType(String name, Class type, int precision, int scale, String typeAttribute)
AlterTable	alterColumnType(String name, Class type, int precision, int scale, String typeAttribute, CreateTable.Nullable nullable)
AlterTable	alterColumnType(String name, Class type, int precision, int scale, CreateTable.Nullable nullable)
AlterTable	alterColumnType(String name, Class type, int precision, String typeAttribute)
AlterTable	alterColumnType(String name, Class type, int precision, String typeAttribute, CreateTable.Nullable nullable)
AlterTable	alterColumnType(String name, Class type, int precision, CreateTable.Nullable nullable)
AlterTable	alterColumnType(String name, Class type, String typeAttribute)
AlterTable	alterColumnType(String name, Class type, String typeAttribute, CreateTable.Nullable nullable)
AlterTable	alterColumnType(String name, Class type, CreateTable.Nullable nullable)
AlterTable	alterColumnType(String name, String customType)
AlterTable	alterColumnType(String name, String customType, CreateTable.Nullable nullable)
void	clear()
protected void	clearGenerated()
AlterTable	clone()
AlterTable	customAttribute(String name, String attribute)
AlterTable	defaultFunction(String name, String defaultFunction)
AlterTable	defaultValue(String name, boolean value)
AlterTable	defaultValue(String name, Object value)
AlterTable	dropColumn(Class beanClass, String propertyName)
AlterTable	dropColumn(String name)
AlterTable	dropColumnDefault(Class beanClass, String propertyName)
AlterTable	dropColumnDefault(String name)
AlterTable	dropConstraint(String name)
AlterTable	dropPrimaryKey()
AlterTable.Alteration	getAlteration()
rife.database.capabilities.Capabilities	getCapabilities()
CreateTable.CheckConstraint	getCheckConstraint()
CreateTable.Column	getColumn()
String	getColumnName()
String	getConstraintName()
Datasource	getDatasource()
String	getDefault()
CreateTable.ForeignKey	getForeignKey()
String	getNewName()
CreateTable.Nullable	getNullable()
QueryParameters	getParameters()
CreateTable.PrimaryKey	getPrimaryKey()
String	getSql()
String	getTable()
CreateTable.UniqueConstraint	getUniqueConstraint()
AlterTable	nullable(String name, CreateTable.Nullable nullable)
AlterTable	precision(String name, int precision)
AlterTable	precision(String name, int precision, int scale)
AlterTable	renameColumn(String name, String newName)
AlterTable	renameTo(String newName)
void	setExcludeUnsupportedCapabilities(boolean flag)
AlterTable	table(String table)
String	toString()

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

NULL

public static final CreateTable.Nullable NULL

NOTNULL

public static final CreateTable.Nullable NOTNULL

NOACTION

public static final CreateTable.ViolationAction NOACTION

RESTRICT

public static final CreateTable.ViolationAction RESTRICT

CASCADE

public static final CreateTable.ViolationAction CASCADE

SETNULL

public static final CreateTable.ViolationAction SETNULL

SETDEFAULT

public static final CreateTable.ViolationAction SETDEFAULT

datasource_

protected Datasource datasource_

sql_

protected String sql_

excludeUnsupportedCapabilities_

protected boolean excludeUnsupportedCapabilities_

Constructor Details

AlterTable

public AlterTable(Datasource datasource)

Method Details

clear

public void clear()

Specified by:

clear in interface Query

getCapabilities

public rife.database.capabilities.Capabilities getCapabilities()

Specified by:

getCapabilities in interface Query

getTable

public String getTable()

getAlteration

public AlterTable.Alteration getAlteration()

getColumnName

public String getColumnName()

getNewName

public String getNewName()

getConstraintName

public String getConstraintName()

getNullable

public CreateTable.Nullable getNullable()

getDefault

public String getDefault()

getColumn

public CreateTable.Column getColumn()

getPrimaryKey

public CreateTable.PrimaryKey getPrimaryKey()

getForeignKey

public CreateTable.ForeignKey getForeignKey()

getUniqueConstraint

public CreateTable.UniqueConstraint getUniqueConstraint()

getCheckConstraint

public CreateTable.CheckConstraint getCheckConstraint()

table

public AlterTable table(String table)

addColumn

public AlterTable addColumn(String name,
 Class type)

addColumn

public AlterTable addColumn(String name,
 Class type,
 String typeAttribute)

addColumn

public AlterTable addColumn(String name,
 Class type,
 int precision)

addColumn

public AlterTable addColumn(String name,
 Class type,
 int precision,
 String typeAttribute)

addColumn

public AlterTable addColumn(String name,
 Class type,
 int precision,
 int scale)

addColumn

public AlterTable addColumn(String name,
 Class type,
 int precision,
 int scale,
 String typeAttribute)

addColumn

public AlterTable addColumn(String name,
 Class type,
 CreateTable.Nullable nullable)

addColumn

public AlterTable addColumn(String name,
 Class type,
 String typeAttribute,
 CreateTable.Nullable nullable)

addColumn

public AlterTable addColumn(String name,
 Class type,
 int precision,
 CreateTable.Nullable nullable)

addColumn

public AlterTable addColumn(String name,
 Class type,
 int precision,
 String typeAttribute,
 CreateTable.Nullable nullable)

addColumn

public AlterTable addColumn(String name,
 Class type,
 int precision,
 int scale,
 CreateTable.Nullable nullable)

addColumn

public AlterTable addColumn(String name,
 Class type,
 int precision,
 int scale,
 String typeAttribute,
 CreateTable.Nullable nullable)

addColumn

public AlterTable addColumn(String name,
 String customType)

addColumn

public AlterTable addColumn(String name,
 String customType,
 CreateTable.Nullable nullable)

addColumn

public AlterTable addColumn(Class beanClass,
 String propertyName)
                     throws DbQueryException

Throws:

DbQueryException

precision

public AlterTable precision(String name,
 int precision)

precision

public AlterTable precision(String name,
 int precision,
 int scale)

nullable

public AlterTable nullable(String name,
 CreateTable.Nullable nullable)

defaultValue

public AlterTable defaultValue(String name,
 boolean value)

defaultValue

public AlterTable defaultValue(String name,
 Object value)

defaultFunction

public AlterTable defaultFunction(String name,
 String defaultFunction)

customAttribute

public AlterTable customAttribute(String name,
 String attribute)

dropColumn

public AlterTable dropColumn(String name)

dropColumn

public AlterTable dropColumn(Class beanClass,
 String propertyName)

renameColumn

public AlterTable renameColumn(String name,
 String newName)

alterColumnType

public AlterTable alterColumnType(String name,
 Class type)

alterColumnType

public AlterTable alterColumnType(String name,
 Class type,
 String typeAttribute)

alterColumnType

public AlterTable alterColumnType(String name,
 Class type,
 int precision)

alterColumnType

public AlterTable alterColumnType(String name,
 Class type,
 int precision,
 String typeAttribute)

alterColumnType

public AlterTable alterColumnType(String name,
 Class type,
 int precision,
 int scale)

alterColumnType

public AlterTable alterColumnType(String name,
 Class type,
 int precision,
 int scale,
 String typeAttribute)

alterColumnType

public AlterTable alterColumnType(String name,
 Class type,
 CreateTable.Nullable nullable)

alterColumnType

public AlterTable alterColumnType(String name,
 Class type,
 String typeAttribute,
 CreateTable.Nullable nullable)

alterColumnType

public AlterTable alterColumnType(String name,
 Class type,
 int precision,
 CreateTable.Nullable nullable)

alterColumnType

public AlterTable alterColumnType(String name,
 Class type,
 int precision,
 String typeAttribute,
 CreateTable.Nullable nullable)

alterColumnType

public AlterTable alterColumnType(String name,
 Class type,
 int precision,
 int scale,
 CreateTable.Nullable nullable)

alterColumnType

public AlterTable alterColumnType(String name,
 Class type,
 int precision,
 int scale,
 String typeAttribute,
 CreateTable.Nullable nullable)

alterColumnType

public AlterTable alterColumnType(String name,
 String customType)

alterColumnType

public AlterTable alterColumnType(String name,
 String customType,
 CreateTable.Nullable nullable)

alterColumnType

public AlterTable alterColumnType(Class beanClass,
 String propertyName)

alterColumnNullable

public AlterTable alterColumnNullable(String name,
 CreateTable.Nullable nullable)

alterColumnNullable

public AlterTable alterColumnNullable(Class beanClass,
 String propertyName,
 CreateTable.Nullable nullable)

alterColumnDefault

public AlterTable alterColumnDefault(String name,
 boolean value)

alterColumnDefault

public AlterTable alterColumnDefault(String name,
 Object value)

alterColumnDefaultFunction

public AlterTable alterColumnDefaultFunction(String name,
 String defaultFunction)

alterColumnDefault

public AlterTable alterColumnDefault(Class beanClass,
 String propertyName,
 Object value)

dropColumnDefault

public AlterTable dropColumnDefault(String name)

dropColumnDefault

public AlterTable dropColumnDefault(Class beanClass,
 String propertyName)

addPrimaryKey

public AlterTable addPrimaryKey(String column)

addPrimaryKey

public AlterTable addPrimaryKey(String[] columns)

addPrimaryKey

public AlterTable addPrimaryKey(String name,
 String column)

addPrimaryKey

public AlterTable addPrimaryKey(String name,
 String[] columns)

addForeignKey

public AlterTable addForeignKey(String foreignTable,
 String localColumn,
 String foreignColumn)

addForeignKey

public AlterTable addForeignKey(String foreignTable,
 String localColumn,
 String foreignColumn,
 CreateTable.ViolationAction onUpdate,
 CreateTable.ViolationAction onDelete)

addForeignKey

public AlterTable addForeignKey(String foreignTable,
 String[] columnsMapping)

addForeignKey

public AlterTable addForeignKey(String foreignTable,
 String[] columnsMapping,
 CreateTable.ViolationAction onUpdate,
 CreateTable.ViolationAction onDelete)

addForeignKey

public AlterTable addForeignKey(String name,
 String foreignTable,
 String localColumn,
 String foreignColumn)

addForeignKey

public AlterTable addForeignKey(String name,
 String foreignTable,
 String localColumn,
 String foreignColumn,
 CreateTable.ViolationAction onUpdate,
 CreateTable.ViolationAction onDelete)

addForeignKey

public AlterTable addForeignKey(String name,
 String foreignTable,
 String[] columnsMapping)

addForeignKey

public AlterTable addForeignKey(String name,
 String foreignTable,
 String[] columnsMapping,
 CreateTable.ViolationAction onUpdate,
 CreateTable.ViolationAction onDelete)

addUnique

public AlterTable addUnique(String column)

addUnique

public AlterTable addUnique(String[] columns)

addUnique

public AlterTable addUnique(String name,
 String column)

addUnique

public AlterTable addUnique(String name,
 String[] columns)

addCheck

public AlterTable addCheck(String expression)

addCheck

public AlterTable addCheck(String name,
 String expression)

dropConstraint

public AlterTable dropConstraint(String name)

dropPrimaryKey

public AlterTable dropPrimaryKey()

renameTo

public AlterTable renameTo(String newName)

getSql

public String getSql()
              throws DbQueryException

Specified by:

getSql in interface Query

Throws:

DbQueryException

clone

public AlterTable clone()

getDatasource

public Datasource getDatasource()

getParameters

public QueryParameters getParameters()

Specified by:

getParameters in interface Query

setExcludeUnsupportedCapabilities

public void setExcludeUnsupportedCapabilities(boolean flag)

Specified by:

setExcludeUnsupportedCapabilities in interface Query

clearGenerated

protected void clearGenerated()

toString

public String toString()

Overrides:

toString in class Object