org.opencms.setup

类 CmsSetupDb

java.lang.Object

org.opencms.setup.CmsSetupDb

public class CmsSetupDb
extends java.lang.Object

Helper class to call database setup scripts.

从以下版本开始:

6.0.0

字段概要

字段

限定符和类型	字段和说明
static java.lang.String	SETUP_DATA_FOLDER The folder where to read the setup data from.
static java.lang.String	SETUP_FOLDER The folder where the setup wizard is located.

构造器概要

构造器

构造器和说明
CmsSetupDb(java.lang.String basePath) Creates a new CmsSetupDb object.

方法概要

方法

限定符和类型	方法和说明
java.lang.String	checkVariables(java.lang.String db) Returns an optional warning message if needed, null if not.
void	clearErrors() Clears the error messages stored internally.
void	closeConnection() Closes the internal connection to the database.
void	createDatabase(java.lang.String database, java.util.Map<java.lang.String,java.lang.String> replacer) Calls the create database script for the given database.
void	createDatabase(java.lang.String database, java.util.Map<java.lang.String,java.lang.String> replacer, boolean abortOnError) Calls the create database script for the given database.
void	createTables(java.lang.String database, java.util.Map<java.lang.String,java.lang.String> replacer) Calls the create tables script for the given database.
void	createTables(java.lang.String database, java.util.Map<java.lang.String,java.lang.String> replacer, boolean abortOnError) Calls the create tables script for the given database.
void	dropDatabase(java.lang.String database, java.util.Map<java.lang.String,java.lang.String> replacer) Calls the drop script for the given database.
void	dropDatabase(java.lang.String database, java.util.Map<java.lang.String,java.lang.String> replacer, boolean abortOnError) Calls the drop script for the given database.
void	dropTables(java.lang.String database) Calls the drop tables script for the given database.
void	dropTables(java.lang.String database, java.util.Map<java.lang.String,java.lang.String> replacer) Calls the drop tables script for the given database.
void	dropTables(java.lang.String database, java.util.Map<java.lang.String,java.lang.String> replacer, boolean abortOnError) Calls the drop tables script for the given database.
CmsSetupDBWrapper	executeSqlStatement(java.lang.String query, java.util.Map<java.lang.String,java.lang.String> replacer) Creates and executes a database statement from a String returning the result set.
CmsSetupDBWrapper	executeSqlStatement(java.lang.String query, java.util.Map<java.lang.String,java.lang.String> replacer, java.util.List<java.lang.Object> params) Creates and executes a database statement from a String returning the result set.
java.sql.Connection	getConnection() Returns the connection.
java.util.List<java.lang.String>	getErrors() Returns a Vector of Error messages.
boolean	hasTableOrColumn(java.lang.String table, java.lang.String column) Checks if the given table, column or combination of both is available in the database in case insensitive way.
boolean	hasTableOrColumnCaseSensitive(java.lang.String table, java.lang.String column) Checks if the given table, column or combination of both is available in the database in a case sensitive way.
boolean	noErrors() Checks if internal errors occurred.
void	setConnection(java.sql.Connection conn) Sets a new internal connection to the database.
void	setConnection(java.lang.String DbDriver, java.lang.String DbConStr, java.lang.String DbConStrParams, java.lang.String DbUser, java.lang.String DbPwd) Creates a new internal connection to the database.
void	updateDatabase(java.lang.String updateScript, java.util.Map<java.lang.String,java.lang.String> replacers) Calls an update script.
void	updateDatabase(java.lang.String updateScript, java.util.Map<java.lang.String,java.lang.String> replacers, boolean abortOnError) Calls an update script.
int	updateSqlStatement(java.lang.String query, java.util.Map<java.lang.String,java.lang.String> replacer, java.util.List<java.lang.Object> params) Creates and executes a database statment from a String.

从类继承的方法 java.lang.Object

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

字段详细资料

SETUP_DATA_FOLDER

public static final java.lang.String SETUP_DATA_FOLDER

The folder where to read the setup data from.

另请参阅:

常量字段值

SETUP_FOLDER

public static final java.lang.String SETUP_FOLDER

The folder where the setup wizard is located.

另请参阅:

常量字段值

构造器详细资料

CmsSetupDb

public CmsSetupDb(java.lang.String basePath)

Creates a new CmsSetupDb object.

参数:

basePath - the location of the setup scripts

方法详细资料

checkVariables

public java.lang.String checkVariables(java.lang.String db)

Returns an optional warning message if needed, null if not.

参数:

db - the selected database key

返回:

html warning, or null if no warning

clearErrors

public void clearErrors()

Clears the error messages stored internally.

closeConnection

public void closeConnection()

Closes the internal connection to the database.

createDatabase

public void createDatabase(java.lang.String database,
                  java.util.Map<java.lang.String,java.lang.String> replacer)

Calls the create database script for the given database.

参数:

database - the name of the database

replacer - the replacements to perform in the drop script

createDatabase

public void createDatabase(java.lang.String database,
                  java.util.Map<java.lang.String,java.lang.String> replacer,
                  boolean abortOnError)

Calls the create database script for the given database.

参数:

database - the name of the database

replacer - the replacements to perform in the drop script

abortOnError - indicates if the script is aborted if an error occurs

createTables

public void createTables(java.lang.String database,
                java.util.Map<java.lang.String,java.lang.String> replacer)

Calls the create tables script for the given database.

参数:

database - the name of the database

replacer - the replacements to perform in the drop script

createTables

public void createTables(java.lang.String database,
                java.util.Map<java.lang.String,java.lang.String> replacer,
                boolean abortOnError)

Calls the create tables script for the given database.

参数:

database - the name of the database

replacer - the replacements to perform in the drop script

abortOnError - indicates if the script is aborted if an error occurs

dropDatabase

public void dropDatabase(java.lang.String database,
                java.util.Map<java.lang.String,java.lang.String> replacer)

Calls the drop script for the given database.

参数:

database - the name of the database

replacer - the replacements to perform in the drop script

dropDatabase

public void dropDatabase(java.lang.String database,
                java.util.Map<java.lang.String,java.lang.String> replacer,
                boolean abortOnError)

Calls the drop script for the given database.

参数:

database - the name of the database

replacer - the replacements to perform in the drop script

abortOnError - indicates if the script is aborted if an error occurs

dropTables

public void dropTables(java.lang.String database)

Calls the drop tables script for the given database.

参数:

database - the name of the database

dropTables

public void dropTables(java.lang.String database,
              java.util.Map<java.lang.String,java.lang.String> replacer)

Calls the drop tables script for the given database.

参数:

database - the name of the database

replacer - the replacements to perform in the drop script

dropTables

public void dropTables(java.lang.String database,
              java.util.Map<java.lang.String,java.lang.String> replacer,
              boolean abortOnError)

Calls the drop tables script for the given database.

参数:

database - the name of the database

replacer - the replacements to perform in the drop script

abortOnError - indicates if the script is aborted if an error occurs

executeSqlStatement

public CmsSetupDBWrapper executeSqlStatement(java.lang.String query,
                                    java.util.Map<java.lang.String,java.lang.String> replacer)
                                      throws java.sql.SQLException

Creates and executes a database statement from a String returning the result set.

参数:

query - the query to execute

replacer - the replacements to perform in the script

返回:

the result set of the query

抛出:

java.sql.SQLException - if something goes wrong

executeSqlStatement

public CmsSetupDBWrapper executeSqlStatement(java.lang.String query,
                                    java.util.Map<java.lang.String,java.lang.String> replacer,
                                    java.util.List<java.lang.Object> params)
                                      throws java.sql.SQLException

Creates and executes a database statement from a String returning the result set.

参数:

query - the query to execute

replacer - the replacements to perform in the script

params - the list of parameters for the statement

返回:

the result set of the query

抛出:

java.sql.SQLException - if something goes wrong

getConnection

public java.sql.Connection getConnection()

Returns the connection.

返回:

the connection

getErrors

public java.util.List<java.lang.String> getErrors()

Returns a Vector of Error messages.

返回:

all error messages collected internally

hasTableOrColumn

public boolean hasTableOrColumn(java.lang.String table,
                       java.lang.String column)

Checks if the given table, column or combination of both is available in the database in case insensitive way.

参数:

table - the sought table

column - the sought column

返回:

true if the requested table/column is available, false if not

hasTableOrColumnCaseSensitive

public boolean hasTableOrColumnCaseSensitive(java.lang.String table,
                                    java.lang.String column)

Checks if the given table, column or combination of both is available in the database in a case sensitive way.

参数:

table - the sought table

column - the sought column

返回:

true if the requested table/column is available, false if not

noErrors

public boolean noErrors()

Checks if internal errors occurred.

返回:

true if internal errors occurred

setConnection

public void setConnection(java.sql.Connection conn)

Sets a new internal connection to the database.

参数:

conn - the connection to use

setConnection

public void setConnection(java.lang.String DbDriver,
                 java.lang.String DbConStr,
                 java.lang.String DbConStrParams,
                 java.lang.String DbUser,
                 java.lang.String DbPwd)

Creates a new internal connection to the database.

参数:

DbDriver - JDBC driver class name

DbConStr - JDBC connect URL

DbConStrParams - JDBC connect URL params, or null

DbUser - JDBC database user

DbPwd - JDBC database password

updateDatabase

public void updateDatabase(java.lang.String updateScript,
                  java.util.Map<java.lang.String,java.lang.String> replacers)

Calls an update script.

参数:

updateScript - the update script code

replacers - the replacers to use in the script code

updateDatabase

public void updateDatabase(java.lang.String updateScript,
                  java.util.Map<java.lang.String,java.lang.String> replacers,
                  boolean abortOnError)

Calls an update script.

参数:

updateScript - the update script code

replacers - the replacers to use in the script code

abortOnError - indicates if the script is aborted if an error occurs

updateSqlStatement

public int updateSqlStatement(java.lang.String query,
                     java.util.Map<java.lang.String,java.lang.String> replacer,
                     java.util.List<java.lang.Object> params)
                       throws java.sql.SQLException

Creates and executes a database statment from a String.

参数:

query - the query to execute

replacer - the replacements to perform in the script

params - the list of parameters for the statement

返回:

the result set of the query

抛出:

java.sql.SQLException - if something goes wrong