com.anylogic.engine.database.ModelDBConnectivity

com.anylogic.engine.database.ModelDatabase

public class ModelDatabase
extends ModelDBConnectivity

This class represents the built-in AnyLogic Model Database. Almost all the methods of this class are internal. The database object may be accessed from getEngine().getModelDatabase() and may be used for import / export with external data sources.

Author:: AnyLogic North America, LLC https://anylogic.com

Field Summary

Fields inherited from class com.anylogic.engine.database.ModelDBConnectivity

AL_DB_OBJECTS, AL_ID_COLUMN_NAME, AL_LOG_TYPE_TABLE, AL_LOG_TYPE_VIEW, AL_OBJECT_NAME, AL_OBJECT_TYPE, AL_OBJECT_USAGE, AL_OBJECT_USAGE_LOG, AL_SELECTED_LOG_OBJECT_NAME, AL_SELECTED_LOG_OBJECT_TYPE, AL_SELECTED_LOG_OBJECTS, AL_VIEW_DEFINITION, AL_VIEW_NAME, AL_VIEWS_TABLE_NAME, CREATE_VIEW_SQL, CURRENT_VERSION, DATABASE_DB_PATH, DATABASE_DIRECTORY, DROP_SQL_OBJECT, LOG_OBJECT_SUFFIX, PUBLIC_SCHEMA_NAME, SQL_FUNCTION, UNIQUE_AUTOINC_COLUMN_NAME

Constructor Summary

Constructor	Description
`ModelDatabase(Engine engine, ModelProperties modelProperties, DatabaseLogState logState)`	This constructor is internal and shouldn't be called by user. it may be removed/renamed in future.

Method Summary

Modifier and Type	Method	Description
`ResultSet`	`execute(String sqlStatement)`	This method is internal and shouldn't be called by user. it may be removed/renamed in future.
`void`	`exportToExternalDB(String sourceTableName, Connection targetConnection, String targetTableName, boolean clearTargetTable, boolean autoCommit)`	Exports a single table data from this database to an external database.
`void`	`importFromExternalDB(Connection sourceConnection, String sourceTableName, String targetTableName, boolean clearTargetTable, boolean autoCommit)`	Imports a single table data from an external database.
`ModelDBConfiguration`	`initConfiguration()`	This method is internal and shouldn't be called by user. it may be removed/renamed in future.
`boolean`	`isLoggingOn(LoggingType loggingType)`
`void`	`log(ILogEntry logEntry)`	This method is internal and shouldn't be called by user. it may be removed/renamed in future.
`void`	`resetBeforeStart()`	This method is internal and shouldn't be called by user. it may be removed/renamed in future.
`ResultSet`	`select(String sqlQuery)`	This method is internal and shouldn't be called by user. it may be removed/renamed in future.
`ResultSet`	`selectFrom(String tableName)`	This method is internal and shouldn't be called by user. it may be removed/renamed in future.
`ResultSet`	`wrapResultSet(ResultSet results)`	This method is internal and shouldn't be called by user. it may be removed/renamed in future.

Methods inherited from class com.anylogic.engine.database.ModelDBConnectivity

disconnect, getConnection, getCreateTableSQL, getDSLConfiguration, getLogStatements, getQuerySupport, setConfiguration

Methods inherited from class java.lang.Object

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

Constructor Details

ModelDatabase

@AnyLogicInternalAPI
public ModelDatabase(Engine engine,
 ModelProperties modelProperties,
 DatabaseLogState logState)

This constructor is internal and shouldn't be called by user.
it may be removed/renamed in future.

Method Details

initConfiguration

@AnyLogicInternalAPI
public ModelDBConfiguration initConfiguration()

Description copied from class: ModelDBConnectivity

This method is internal and shouldn't be called by user.
it may be removed/renamed in future.

Overrides:

initConfiguration in class ModelDBConnectivity

Returns:

default implementation does nothing and returns null

See Also:

ModelDBConnectivity.setConfiguration(ModelDBConfiguration)

resetBeforeStart

@AnyLogicInternalAPI
public void resetBeforeStart()
                      throws Exception

This method is internal and shouldn't be called by user.
it may be removed/renamed in future.

Throws:: Exception

isLoggingOn

public boolean isLoggingOn(LoggingType loggingType)

log

@AnyLogicInternalAPI
public void log(ILogEntry logEntry)

This method is internal and shouldn't be called by user.
it may be removed/renamed in future.

select

@AnyLogicInternalAPI
public ResultSet select(String sqlQuery)

This method is internal and shouldn't be called by user.
it may be removed/renamed in future.

execute

@AnyLogicInternalAPI
public ResultSet execute(String sqlStatement)

This method is internal and shouldn't be called by user.
it may be removed/renamed in future.

selectFrom

@AnyLogicInternalAPI
public ResultSet selectFrom(String tableName)

This method is internal and shouldn't be called by user.
it may be removed/renamed in future.

importFromExternalDB

public void importFromExternalDB(Connection sourceConnection,
 String sourceTableName,
 String targetTableName,
 boolean clearTargetTable,
 boolean autoCommit)

Imports a single table data from an external database. Column types should match or be convertible.

Parameters:

sourceConnection - Connection object for external database to copy data from

sourceTableName - name of the table in external database to copy data from

targetTableName - table in this database where the data should be copied to

clearTargetTable - if true the target table will be cleared before data is copied

autoCommit - if this parameter is false, this action will not open or commit any transaction (which may decrease performance in some cases).
Usage example (performing multiple operations in a single transaction)

 ModelDatabase modelDB = getEngine().getModelDatabase();
 Connection targetConnection = modelDB.getConnection();
 targetConnection.setAutoCommit(false);
 try {
        modelDB.importFromExternalDB( ... , false);
        modelDB.importFromExternalDB( ... , false);
        modelDB.importFromExternalDB( ... , false);
        targetConnection.commit();
 } catch (Exception e) {
        targetConnection.rollback();
 } finally {
        targetConnection.setAutoCommit(true);
 }

exportToExternalDB

public void exportToExternalDB(String sourceTableName,
 Connection targetConnection,
 String targetTableName,
 boolean clearTargetTable,
 boolean autoCommit)

Exports a single table data from this database to an external database. Column types should match or be convertible.
When exporting to Database.getConnection(), depending on the external database implementation, the data may be actually saved when the model is stopped (when Engine will automatically call Database.disconnect() at the end). For custom experiment this requires calling engine.stop() at the end.

Parameters:

sourceTableName - table in this database to copy data from

targetConnection - Connection object for external database to copy data to

targetTableName - table in external database where the data should be copied to

clearTargetTable - if true the target table will be cleared before data is copied

autoCommit - if this parameter is false, this action will not open or commit any transaction (which may decrease performance in some cases).
Usage example (performing multiple operations in a single transaction)

 ModelDatabase modelDB = getEngine().getModelDatabase();
 Connection targetConnection = targetDB.getConnection();
 targetConnection.setAutoCommit(false);
 try {
        modelDB.exportToExternalDB( ... , false);
        modelDB.exportToExternalDB( ... , false);
        modelDB.exportToExternalDB( ... , false);
        targetConnection.commit();
 } catch (Exception e) {
        targetConnection.rollback();
 } finally {
        targetConnection.setAutoCommit(true);
 }

wrapResultSet

@AnyLogicInternalAPI
public ResultSet wrapResultSet(ResultSet results)

This method is internal and shouldn't be called by user.
it may be removed/renamed in future.

Class ModelDatabase

Field Summary

Fields inherited from class com.anylogic.engine.database.ModelDBConnectivity

Constructor Summary

Method Summary

Methods inherited from class com.anylogic.engine.database.ModelDBConnectivity

Methods inherited from class java.lang.Object

Constructor Details

ModelDatabase

Method Details

initConfiguration

resetBeforeStart

isLoggingOn

log

select

execute

selectFrom

importFromExternalDB

exportToExternalDB

wrapResultSet