Migration

Instance Constructors

new Migration()

Abstract Value Members

abstract def down(): Unit

Concrete migration classes must define this method to back out of this migration.
Concrete migration classes must define this method to back out of this migration. If the migration cannot be reversed, then a IrreversibleMigrationException should be thrown.
abstract def up(): Unit

Concrete migration classes must define this method to migrate the database up to a new migration.

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def addCheck(on: On, expr: String, options: CheckOption*): Unit

Add a CHECK constraint on a table and one or more columns.
Add a CHECK constraint on a table and one or more columns. The constraint name is automatically generated unless Name() is given as an option.
on
the table and columns to add the CHECK constraint on
expr
the expression to check
options
a possibly empty list of check options to customize the creation of the CHECK constraint
final def addColumn(tableName: String, columnName: String, columnType: SqlType, options: ColumnOption*): Unit
def addForeignKey(references: References, on: On, options: ForeignKeyOption*): Unit

Add a foreign key to a table.
Add a foreign key to a table. The name of the foreign key is automatically generated unless Name() is given as an option.
references
the table and column name(s) that the foreign key references
on
the table and column name(s) to place the foreign key on
options
a possibly empty list of foreign key options to customize the creation of the foreign key
def addForeignKey(on: On, references: References, options: ForeignKeyOption*): Unit

Add a foreign key to a table.
Add a foreign key to a table. The name of the foreign key is automatically generated unless Name() is given as an option.
on
the table and column name(s) to place the foreign key on
references
the table and column name(s) that the foreign key references
options
a possibly empty list of foreign key options to customize the creation of the foreign key
final def addIndex(tableName: String, columnName: String, options: IndexOption*): Unit

Add an index to a table on a column.
Add an index to a table on a column. The name of the index is automatically generated unless Name() is given as an option.
tableName
the table to add the index to
columnName
the name of the column that the index will be on
options
a possibly empty list of index options to customize the creation of the index
final def addIndex(tableName: String, columnNames: Array[String], options: IndexOption*): Unit

Add an index to a table on a non-empty list of column names.
Add an index to a table on a non-empty list of column names. The name of the index is automatically generated unless Name() is given as an option.
tableName
the table to add the index to
columnNames
a list of one or more column names that the index will be on
options
a possibly empty list of index options to customize the creation of the index
def addTrigger(tableName: String, triggerName: String, options: TriggerOption*)(f: ⇒ String): Unit

add trigger
def addingForeignKeyConstraintCreatesIndex: Boolean

This value is true if the database implicitly adds an index on the column that has a foreign key constraint added to it.
This value is true if the database implicitly adds an index on the column that has a foreign key constraint added to it.
The following SQL can be used to test the database. The last statement will fail with a message that there already is an index on the column.
create table parent (pk int primary key); create table child (pk int primary key, pk_parent int not null); alter table child add constraint idx_child_pk_parent foreign key (pk_parent) references parent (pk); create index idx_child_pk_parent on child (pk_parent);
final def alterColumn(tableName: String, columnName: String, columnType: SqlType, options: ColumnOption*): Unit

Alter the definition of an existing column.
Alter the definition of an existing column.
NOTE: if the original column definition uses CharacterSet() then it must be used here again, unless the base SQL data type is being changed. For example, on Oracle, creating a column without CharacterSet uses VARCHAR2 while using CharacterSet(Unicode) uses NVARCHAR2, so if the original column used CharacterSet(Unicode) and #alterColumn() is not passed CharacterSet(Unicode), then the column's data type will be change from NVARCHAR2 to VARCHAR2.
tableName
the name of the table with the column
columnName
the name of the column
columnType
the type the column is being altered to
options
a possibly empty array of column options to customize the column
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def commentColumn(tableName: String, columnName: String, comment: String): Unit

comment column
comment column
tableName
table name
columnName
column name
comment
comment
final def commentTable(tableName: String, comment: String): Unit

comment table
comment table
tableName
table name
comment
comment
def connection: Connection

Get the connection to the database the migration can use for any custom work.
Get the connection to the database the migration can use for any custom work. This connection logs all operations performed on it. The Migration subclass must be careful with this connection and leave it in a good state, as all of the other migration methods defined in Migration use the same connection.
final def createTable(tableName: String, options: TableOption*)(body: (TableDefinition) ⇒ Unit): Unit
def databaseVendor: Vendor

The vendor of the database the migration is being run on.
final def dropSequence(name: String): Unit

删除序列
删除序列
name
序列的名称
final def dropTable(tableName: String): Unit
def dropTrigger(triggerName: String): Unit

droper some trigger
droper some trigger
triggerName
trigger name
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def execute(sql: String*): Unit

Execute the given SQL string using the migration's connection.
Execute the given SQL string using the migration's connection.
sql
the SQL to execute
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def grant(tableName: String, grantee: String, privileges: GrantPrivilegeType*): Unit

Add a grant on a table to a grantee.
Add a grant on a table to a grantee.
tableName
the table name to add the grants to
grantee
the grantee to grant the privileges to
privileges
a non-empty array of privileges to grant to the grantee
final def grant(tableName: String, grantee: User, privileges: GrantPrivilegeType*): Unit

Add a grant on a table to a grantee.
Add a grant on a table to a grantee.
tableName
the table name to add the grants to
grantee
the grantee to grant the privileges to
privileges
a non-empty array of privileges to grant to the grantee
final def grant(tableName: String, grantees: Array[String], privileges: GrantPrivilegeType*): Unit

Add a grant on a table to one or more grantees.
Add a grant on a table to one or more grantees.
tableName
the table name to add the grants to
grantees
a non-empty array of grantees
privileges
a non-empty array of privileges to grant to the grantees
final def grant(tableName: String, grantees: Array[User], privileges: GrantPrivilegeType*): Unit

Add a grant on a table to one or more grantees.
Add a grant on a table to one or more grantees.
tableName
the table name to add the grants to
grantees
a non-empty array of grantees
privileges
a non-empty array of privileges to grant to the grantees
final def grantSchemaPrivilege(grantee: String, privileges: SchemaPrivilege*): Unit

Grant one or more privileges to a schema.
Grant one or more privileges to a schema.
grantee
the grantee to grant the privileges to
privileges
a non-empty array of privileges to grant to the grantee
final def grantSchemaPrivilege(grantee: User, privileges: SchemaPrivilege*): Unit

Grant one or more privileges to a schema.
Grant one or more privileges to a schema.
grantee
the grantee to grant the privileges to
privileges
a non-empty array of privileges to grant to the grantee
final def grantSchemaPrivilege(grantees: Array[String], privileges: SchemaPrivilege*): Unit

Grant one or more privileges to a schema.
Grant one or more privileges to a schema.
grantees
a non-empty array of grantees
privileges
a non-empty array of privileges to grant to the grantees
final def grantSchemaPrivilege(grantees: Array[User], privileges: SchemaPrivilege*): Unit

Grant one or more privileges to a schema.
Grant one or more privileges to a schema.
grantees
a non-empty array of grantees
privileges
a non-empty array of privileges to grant to the grantees
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def on(definition: TableColumnDefinition): On

Convert a table and column name definition into a On foreign key instance.
def rawConnection: Connection

Get the raw connection to the database the migration can use for any custom work.
Get the raw connection to the database the migration can use for any custom work. This connection is the raw connection that underlies the logging connection and does not log any operations performed on it. It should only be used when the logging connection does not provide a required feature. The Migration subclass must be careful with this connection and leave it in a good state, as all of the other migration methods defined in Migration use the same connection.
def references(definition: TableColumnDefinition): References

Convert a table and column name definition into a References foreign key instance.
def removeCheck(on: On, options: Name*): Unit

Remove a CHECK constraint on a table and one or more columns.
Remove a CHECK constraint on a table and one or more columns. The constraint name is automatically generated unless Name() is given as an option.
on
the table and columns to remove the CHECK constraint from
options
a possibly empty list of check options to customize the removal of the CHECK constraint
final def removeColumn(tableName: String, columnName: String): Unit
def removeForeignKey(references: References, on: On, options: Name*): Unit

Remove a foreign key from a table.
Remove a foreign key from a table. The name of the foreign key is automatically generated unless Name() is given as an option.
references
the table and column name(s) that the foreign key references
on
the table and column name(s) to remove the foreign key from
options
a possibly empty list of foreign key options to customize the removal of the foreign key
def removeForeignKey(on: On, references: References, options: Name*): Unit

Remove a foreign key from a table.
Remove a foreign key from a table. The name of the foreign key is automatically generated unless Name() is given as an option.
on
the table and column name(s) to remove the foreign key from
references
the table and column name(s) that the foreign key references
options
a possibly empty list of foreign key options to customize the removal of the foreign key
final def removeIndex(tableName: String, columnName: String, options: Name*): Unit

Remove an index on a column in a table.
Remove an index on a column in a table. The name of the index to remove is automatically generated unless Name() is given as an option.
tableName
the table to remove the index from
columnName
the name of the column the index is on
options
a possibly empty list of index options to customize the removal of the index
final def removeIndex(tableName: String, columnNames: Array[String], options: Name*): Unit

Remove an index on a table that is composed of a non-empty list of column names.
Remove an index on a table that is composed of a non-empty list of column names. The name of the index to remove is automatically generated unless Name() is given as an option.
tableName
the table to remove the index from
columnNames
a list of one or more column names that the index is on
options
a possibly empty list of index options to customize the removal of the index
final def revoke(tableName: String, grantee: String, privileges: GrantPrivilegeType*): Unit

Remove privileges on a table from a grantee.
Remove privileges on a table from a grantee.
tableName
the table name to remove the grants from
grantee
the grantee to revoke privileges from
privileges
a non-empty array of privileges to remove from the grantee
final def revoke(tableName: String, grantee: User, privileges: GrantPrivilegeType*): Unit

Remove privileges on a table from a grantee.
Remove privileges on a table from a grantee.
tableName
the table name to remove the grants from
grantee
the grantee to revoke privileges from
privileges
a non-empty array of privileges to remove from the grantee
final def revoke(tableName: String, grantees: Array[String], privileges: GrantPrivilegeType*): Unit

Remove privileges on a table from one or more grantees.
Remove privileges on a table from one or more grantees.
tableName
the table name to remove the grants from
grantees
a non-empty array of grantees
privileges
a non-empty array of privileges to remove from the grantees
final def revoke(tableName: String, grantees: Array[User], privileges: GrantPrivilegeType*): Unit

Remove privileges on a table from one or more grantees.
Remove privileges on a table from one or more grantees.
tableName
the table name to remove the grants from
grantees
a non-empty array of grantees
privileges
a non-empty array of privileges to remove from the grantees
final def revokeSchemaPrivilege(grantee: String, privileges: SchemaPrivilege*): Unit

Revoke one or more privileges from a schema.
Revoke one or more privileges from a schema.
grantee
the grantee to revoke the privileges from
privileges
a non-empty array of privileges to revoke from the grantee
final def revokeSchemaPrivilege(grantee: User, privileges: SchemaPrivilege*): Unit

Revoke one or more privileges from a schema.
Revoke one or more privileges from a schema.
grantee
the grantee to revoke the privileges from
privileges
a non-empty array of privileges to revoke from the grantee
final def revokeSchemaPrivilege(grantees: Array[String], privileges: SchemaPrivilege*): Unit

Revoke one or more privileges from a schema.
Revoke one or more privileges from a schema.
grantees
a non-empty array of grantees
privileges
a non-empty array of privileges to revoke from the grantees
final def revokeSchemaPrivilege(grantees: Array[User], privileges: SchemaPrivilege*): Unit

Revoke one or more privileges from a schema.
Revoke one or more privileges from a schema.
grantees
a non-empty array of grantees
privileges
a non-empty array of privileges to revoke from the grantees
final def sequence(name: String): Unit

创建序列
创建序列
name
序列名称
implicit def stringToMigrationArrowAssoc(s: String): MigrationArrowAssoc

Override the -> implicit definition to create a MigrationArrowAssoc instead of a scala.Predef.ArrowAssoc.
Override the -> implicit definition to create a MigrationArrowAssoc instead of a scala.Predef.ArrowAssoc. See the above comment on the MigrationArrowAssoc class why this is done.
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

Definition Classes
AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def withPreparedStatement(sql: String)(f: (PreparedStatement) ⇒ Unit): Unit

Given a SQL string and a Function1[PreparedStatement,Unit], start a new transaction by turning off auto-commit mode on the connection then create a new prepared statement with the SQL string and pass the prepared statement to the closure argument.
Given a SQL string and a Function1[PreparedStatement,Unit], start a new transaction by turning off auto-commit mode on the connection then create a new prepared statement with the SQL string and pass the prepared statement to the closure argument. The closure should not perform the commit as this method will commit the transaction. If the closure throws an exception then the transaction is rolled back and the exception that caused the rollback is re-thrown. Finally, the auto-commit state is reset to the value the connection had before this method was called.
sql
the SQL text that will be prepared
f
the Function1[PreparedStatement,Unit] that will be given a new prepared statement
final def withResultSet[R](rs: ResultSet)(f: (ResultSet) ⇒ R): R

Given a SQL result set and a Function1[ResultSet,R], pass the result set to the closure.
Given a SQL result set and a Function1[ResultSet,R], pass the result set to the closure. After the closure has completed, either normally via a return or by throwing an exception, close the result set.
rs
the SQL result set
f
the Function1[ResultSet,R] that will be given the result set
returns
the result of f if f returns normally

Related Doc: package migration

abstract class Migration extends AnyRef

Instance Constructors

new Migration()

Abstract Value Members

abstract def down(): Unit

abstract def up(): Unit

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def addCheck(on: On, expr: String, options: CheckOption*): Unit

final def addColumn(tableName: String, columnName: String, columnType: SqlType, options: ColumnOption*): Unit

def addForeignKey(references: References, on: On, options: ForeignKeyOption*): Unit

def addForeignKey(on: On, references: References, options: ForeignKeyOption*): Unit

final def addIndex(tableName: String, columnName: String, options: IndexOption*): Unit

final def addIndex(tableName: String, columnNames: Array[String], options: IndexOption*): Unit

def addTrigger(tableName: String, triggerName: String, options: TriggerOption*)(f: ⇒ String): Unit

def addingForeignKeyConstraintCreatesIndex: Boolean

final def alterColumn(tableName: String, columnName: String, columnType: SqlType, options: ColumnOption*): Unit

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def commentColumn(tableName: String, columnName: String, comment: String): Unit

final def commentTable(tableName: String, comment: String): Unit

def connection: Connection

final def createTable(tableName: String, options: TableOption*)(body: (TableDefinition) ⇒ Unit): Unit

def databaseVendor: Vendor

final def dropSequence(name: String): Unit

final def dropTable(tableName: String): Unit

def dropTrigger(triggerName: String): Unit

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

final def execute(sql: String*): Unit

def finalize(): Unit

final def getClass(): Class[_]

final def grant(tableName: String, grantee: String, privileges: GrantPrivilegeType*): Unit

final def grant(tableName: String, grantee: User, privileges: GrantPrivilegeType*): Unit

final def grant(tableName: String, grantees: Array[String], privileges: GrantPrivilegeType*): Unit

final def grant(tableName: String, grantees: Array[User], privileges: GrantPrivilegeType*): Unit

final def grantSchemaPrivilege(grantee: String, privileges: SchemaPrivilege*): Unit

final def grantSchemaPrivilege(grantee: User, privileges: SchemaPrivilege*): Unit

final def grantSchemaPrivilege(grantees: Array[String], privileges: SchemaPrivilege*): Unit

final def grantSchemaPrivilege(grantees: Array[User], privileges: SchemaPrivilege*): Unit

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def on(definition: TableColumnDefinition): On

def rawConnection: Connection

def references(definition: TableColumnDefinition): References

def removeCheck(on: On, options: Name*): Unit

final def removeColumn(tableName: String, columnName: String): Unit

def removeForeignKey(references: References, on: On, options: Name*): Unit

def removeForeignKey(on: On, references: References, options: Name*): Unit

final def removeIndex(tableName: String, columnName: String, options: Name*): Unit

final def removeIndex(tableName: String, columnNames: Array[String], options: Name*): Unit

final def revoke(tableName: String, grantee: String, privileges: GrantPrivilegeType*): Unit

final def revoke(tableName: String, grantee: User, privileges: GrantPrivilegeType*): Unit

final def revoke(tableName: String, grantees: Array[String], privileges: GrantPrivilegeType*): Unit

final def revoke(tableName: String, grantees: Array[User], privileges: GrantPrivilegeType*): Unit

final def revokeSchemaPrivilege(grantee: String, privileges: SchemaPrivilege*): Unit

final def revokeSchemaPrivilege(grantee: User, privileges: SchemaPrivilege*): Unit

final def revokeSchemaPrivilege(grantees: Array[String], privileges: SchemaPrivilege*): Unit

final def revokeSchemaPrivilege(grantees: Array[User], privileges: SchemaPrivilege*): Unit

final def sequence(name: String): Unit

implicit def stringToMigrationArrowAssoc(s: String): MigrationArrowAssoc

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

final def withPreparedStatement(sql: String)(f: (PreparedStatement) ⇒ Unit): Unit

final def withResultSet[R](rs: ResultSet)(f: (ResultSet) ⇒ R): R

Inherited from AnyRef

Inherited from Any

Ungrouped