net.sf.jailer.api

Class Subsetter

java.lang.Object

net.sf.jailer.api.Subsetter

public class Subsetter
extends java.lang.Object

Generates a subset of a relational database that respects foreign key constraints.

Author:

Ralf Wisser

Constructor Summary

Constructors

Constructor and Description
Subsetter() Default constructor.
Subsetter(javax.sql.DataSource dataSource, DBMS dbms, java.io.File dataModel, java.io.File extractionModel, ScriptFormat scriptFormat) Creates a new Subsetter with all mandatory attributes.
Subsetter(javax.sql.DataSource dataSource, DBMS dbms, java.net.URL dataModel, java.net.URL extractionModel, ScriptFormat scriptFormat) Creates a new Subsetter with all mandatory attributes.
Subsetter(Subsetter other) Copy constructor.

Method Summary

Modifier and Type	Method and Description
ExportStatistic	execute(java.lang.String whereClause, java.io.File exportScriptFile) Generates the export-script.
ExportStatistic	execute(java.lang.String whereClause, java.io.File exportScriptFile, java.io.File deleteScriptFile) Generates the export- and/or delete-script.
java.net.URL	getDataModelURL() Gets URL of the current data model (the datamodel's base folder)
javax.sql.DataSource	getDataSource() Gets the data-source to connect with the database.
DBMS	getDbms() Gets the DBMS of the database.
ExecutionContext	getExecutionContext() Gets the ExecutionContext.
java.net.URL	getExtractionModelURL() Gets the URL of the extraction model.
java.lang.String	getImportFilterMappingTableSchema() Gets schema in which the import-filter mapping tables will be created
java.lang.Integer	getIsolationLevel() Gets IsolationLevel.
java.lang.String	getLocalDatabaseStorage()
int	getModelPoolSize()
boolean	getNoRowid() Deprecated. use getUseRowid()
boolean	getNoSorting() If true, The exported rows will not be sorted according to foreign key constraints
int	getNumberOfEntities() Gets maximum number of entities per insert-statement (in export-file, default is 10)
int	getNumberOfThreads() Gets number of parallel threads (default is 1) to be used.
java.util.Map<java.lang.String,java.lang.String>	getParameters() Gets parameters.
java.util.Map<java.lang.String,java.lang.String>	getSchemaMapping() Gets schema map for destination database.
WorkingTableScope	getScope() Gets scope of working tables, GLOBAL, SESSION_LOCAL or LOCAL_DATABASE Default is GLOBAL.
ScriptFormat	getScriptFormat() Gets the script format.
java.util.Map<java.lang.String,java.lang.String>	getSourceSchemaMapping() Gets schema map for source database.
DBMS	getTargetDBMS() Gets target-DBMS.
boolean	getTransactional() If true, export rows in a single transaction.
boolean	getUpsertOnly() If true, Generate 'upsert'-statements for all entities (in export-file)
boolean	getUseRowid() If true, use rowid/ctid-column to determine row identity (instead of primary keys)
boolean	getUseRowIdsOnlyForTablesWithoutPK() If true, use rowid/ctid-column only for tables without primary key.
boolean	getUTF8() If true, Use uTF-8 encoding
java.lang.String	getWorkingTableSchema() Gets schema in which the working tables will be created
java.lang.String	getXmlDatePattern() Gets pattern for dates in XML and LIQUIBASE_XML export file
java.lang.String	getXmlRootTag() Gets root tag of XML export file
java.lang.String	getXmlTimePattern() Gets pattern for times in XML and LIQUIBASE_XML export file
java.lang.String	getXmlTimeStampPattern() Gets pattern for time-stamps in XML and LIQUIBASE_XML export file
boolean	isAbortInCaseOfInconsistency()
boolean	isDisallowNonAggregated()
boolean	isIgnoreNonAggregated()
boolean	isIncludeNonAggregated()
boolean	isSingleRoot()
boolean	isUnformatted()
void	setAbortInCaseOfInconsistency(boolean abortInCaseOfInconsitency)
void	setDataModelBaseFolder(java.io.File datamodelBaseFolder) Sets the current data model as File
void	setDataModelURL(java.net.URL datamodelURL) Sets URL of the current data model (the datamodel's base folder)
void	setDataSource(javax.sql.DataSource dataSource) Sets the data-source to connect with the database.
void	setDbms(DBMS dbms) Sets the DBMS of the database.
void	setDisallowNonAggregated(boolean disallowNonAggregated)
void	setExtractionModelURL(java.net.URL extractionModelURL) Sets the URL of the extraction model.
void	setIgnoreNonAggregated(boolean ignoreNonAggregated)
void	setImportFilterMappingTableSchema(java.lang.String importFilterMappingTableSchema) Sets schema in which the import-filter mapping tables will be created
void	setIncludeNonAggregated(boolean includeNonAggregated)
void	setIsolationLevel(java.lang.Integer isolationLevel) Sets IsolationLevel.
void	setLocalDatabaseStorage(java.io.File localDatabaseStorage) Sets the folder where the local database will be stored.
void	setLocalDatabaseStorage(java.lang.String localDatabaseStorage) Sets the folder where the local database will be stored.
void	setModelPoolSize(int modelPoolSize)
void	setNoRowid(boolean noRowid) Deprecated. use setUseRowid(boolean)
void	setNoSorting(boolean noSorting) If true, The exported rows will not be sorted according to foreign key constraints
void	setNumberOfEntities(int numberOfEntities) Sets maximum number of entities per insert-statement (in export-file, default is 10)
void	setNumberOfThreads(int numberOfThreads) Sets number of parallel threads (default is 1) to be used
void	setParameter(java.lang.String name, java.lang.String value) Sets a parameter.
void	setSchemaMapping(java.util.Map<java.lang.String,java.lang.String> schemaMapping) Sets schema map for destination database.
void	setScope(WorkingTableScope scope) Sets scope of working tables, GLOBAL, SESSION_LOCAL or LOCAL_DATABASE
void	setScriptFormat(ScriptFormat scriptFormat) Sets the script format.
void	setSingleRoot(boolean singleRoot)
void	setSourceSchemaMapping(java.util.Map<java.lang.String,java.lang.String> sourceSchemaMapping) Sets schema map for source database.
void	setTargetDBMS(DBMS targetDBMS) Sets target-DBMS.
void	setTransactional(boolean transactional) If true, export rows in a single transaction.
void	setUnformatted(boolean unformatted)
void	setUpsertOnly(boolean upsertOnly) If true, Generate 'upsert'-statements for all entities (in export-file)
void	setUseRowid(boolean useRowid) If true, use rowid/ctid-column to determine row identity (instead of primary keys)
void	setUseRowIdsOnlyForTablesWithoutPK(boolean useRowIdsOnlyForTablesWithoutPK) If true, use rowid/ctid-column only for tables without primary key.
void	setUTF8(boolean uTF8) If true, use UTF-8 encoding
void	setWorkingTableSchema(java.lang.String workingTableSchema) Sets schema in which the working tables will be created
void	setXmlDatePattern(java.lang.String xmlDatePattern) Sets pattern for dates in XML and LIQUIBASE_XML export file
void	setXmlRootTag(java.lang.String xmlRootTag) Sets root tag of XML export file
void	setXmlTimePattern(java.lang.String xmlTimePattern) Sets pattern for times in XML and LIQUIBASE_XML export file
void	setXmlTimeStampPattern(java.lang.String xmlTimeStampPattern) Sets pattern for time-stamps in XML and LIQUIBASE_XML export file

Methods inherited from class java.lang.Object

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

Constructor Detail

Subsetter

public Subsetter()

Default constructor.

Subsetter

public Subsetter(Subsetter other)

Copy constructor.

Subsetter

public Subsetter(javax.sql.DataSource dataSource,
                 DBMS dbms,
                 java.net.URL dataModel,
                 java.net.URL extractionModel,
                 ScriptFormat scriptFormat)

Creates a new Subsetter with all mandatory attributes.

Parameters:

dataSource - the data-source to connect with the source database

dbms - the DBMS of the source database

dataModel - URL of the current data model folder. Use Class.getResource(String) if the data model is available as a resource.

extractionModel - URL of the extraction model. Use Class.getResource(String) if the extraction model is available as a resource.

scriptFormat - script format

Subsetter

public Subsetter(javax.sql.DataSource dataSource,
                 DBMS dbms,
                 java.io.File dataModel,
                 java.io.File extractionModel,
                 ScriptFormat scriptFormat)

Creates a new Subsetter with all mandatory attributes.

Parameters:

dataSource - the data-source to connect with the source database

dbms - the DBMS of the source database

dataModel - the current data model (the datamodel's base folder)

extractionModel - the extraction model

scriptFormat - script format

Method Detail

execute

public ExportStatistic execute(java.lang.String whereClause,
                               java.io.File exportScriptFile)
                        throws java.sql.SQLException,
                               java.io.IOException

Generates the export-script.

Parameters:

whereClause - if not null, overrides the extraction model's subject condition

exportScriptFile - the export-script file (compressed if it ends with '.zip' or '.gz')

Returns:

export statistic

Throws:

InconsistentSubsettingResultException - if ExecutionContext.isAbortInCaseOfInconsistency() and the number of exported rows differs from that of the collected ones

java.sql.SQLException

java.io.IOException

execute

public ExportStatistic execute(java.lang.String whereClause,
                               java.io.File exportScriptFile,
                               java.io.File deleteScriptFile)
                        throws java.sql.SQLException,
                               java.io.IOException

Generates the export- and/or delete-script.

Parameters:

whereClause - if not null, overrides the extraction model's subject condition

exportScriptFile - the export-script file (compressed if it ends with '.zip' or '.gz'), optional

deleteScriptFile - the delete-script file (compressed if it ends with '.zip' or '.gz'), optional

Returns:

export statistic

Throws:

InconsistentSubsettingResultException - if ExecutionContext.isAbortInCaseOfInconsistency() and the number of exported rows differs from that of the collected ones

java.sql.SQLException

java.io.IOException

getDataSource

public javax.sql.DataSource getDataSource()

Gets the data-source to connect with the database.

Returns:

the data-source to connect with the database

setDataSource

public void setDataSource(javax.sql.DataSource dataSource)

Sets the data-source to connect with the database.

Parameters:

dataSource - the data-source to connect with the database

getDbms

public DBMS getDbms()

Gets the DBMS of the database.

Returns:

the DBMS

setDbms

public void setDbms(DBMS dbms)

Sets the DBMS of the database.
Note that it's not necessary to set the DBMS if BasicDataSource is used.

Parameters:

dbms - the DBMS

getDataModelURL

public java.net.URL getDataModelURL()

Gets URL of the current data model (the datamodel's base folder)

setDataModelURL

public void setDataModelURL(java.net.URL datamodelURL)

Sets URL of the current data model (the datamodel's base folder)

setDataModelBaseFolder

public void setDataModelBaseFolder(java.io.File datamodelBaseFolder)

Sets the current data model as File

Parameters:

datamodelBaseFolder - represents the folder. Will be converted to an URL an set as datamodel URL

See Also:

setDataModelURL(URL)

getExtractionModelURL

public java.net.URL getExtractionModelURL()

Gets the URL of the extraction model.

Returns:

the URL of the extraction model

setExtractionModelURL

public void setExtractionModelURL(java.net.URL extractionModelURL)

Sets the URL of the extraction model.

Parameters:

extractionModelURL - the URL of the extraction model

getScriptFormat

public ScriptFormat getScriptFormat()

Gets the script format.

Returns:

the script format

setScriptFormat

public void setScriptFormat(ScriptFormat scriptFormat)

Sets the script format.

getUTF8

public boolean getUTF8()

If true, Use uTF-8 encoding

Returns:

true if use UTF-8 encoding

setUTF8

public void setUTF8(boolean uTF8)

If true, use UTF-8 encoding

Parameters:

uTF8 - true if use UTF-8 encoding

getTargetDBMS

public DBMS getTargetDBMS()

Gets target-DBMS.

Returns:

target-DBMS

setTargetDBMS

public void setTargetDBMS(DBMS targetDBMS)

Sets target-DBMS.

Parameters:

targetDBMS - target-DBMS. If it's null, target DBMS is assumed to be the same as getDbms()

getXmlRootTag

public java.lang.String getXmlRootTag()

Gets root tag of XML export file

Returns:

root tag of XML export file

setXmlRootTag

public void setXmlRootTag(java.lang.String xmlRootTag)

Sets root tag of XML export file

Parameters:

xmlRootTag - root tag of XML export file

getXmlDatePattern

public java.lang.String getXmlDatePattern()

Gets pattern for dates in XML and LIQUIBASE_XML export file

Returns:

pattern for dates in XML and LIQUIBASE_XML export file

setXmlDatePattern

public void setXmlDatePattern(java.lang.String xmlDatePattern)

Sets pattern for dates in XML and LIQUIBASE_XML export file

Parameters:

xmlDatePattern - pattern for dates in XML and LIQUIBASE_XML export file

getXmlTimePattern

public java.lang.String getXmlTimePattern()

Gets pattern for times in XML and LIQUIBASE_XML export file

Returns:

pattern for times in XML and LIQUIBASE_XML export file

setXmlTimePattern

public void setXmlTimePattern(java.lang.String xmlTimePattern)

Sets pattern for times in XML and LIQUIBASE_XML export file

Parameters:

xmlTimePattern - pattern for times in XML and LIQUIBASE_XML export file

getXmlTimeStampPattern

public java.lang.String getXmlTimeStampPattern()

Gets pattern for time-stamps in XML and LIQUIBASE_XML export file

Returns:

pattern for time-stamps in XML and LIQUIBASE_XML export file

setXmlTimeStampPattern

public void setXmlTimeStampPattern(java.lang.String xmlTimeStampPattern)

Sets pattern for time-stamps in XML and LIQUIBASE_XML export file

Parameters:

xmlTimeStampPattern - pattern for time-stamps in XML and LIQUIBASE_XML export file

isUnformatted

public boolean isUnformatted()

Returns:

true: don't format JSON/YAML/XML export files

setUnformatted

public void setUnformatted(boolean unformatted)

Parameters:

unformatted - true: don't format JSON/YAML/XML export files

isSingleRoot

public boolean isSingleRoot()

Returns:

allow only a single root/subject object to be written out into JSON/YAML/XML export file

setSingleRoot

public void setSingleRoot(boolean singleRoot)

Parameters:

singleRoot - allow only a single root/subject object to be written out into JSON/YAML/XML export file

isDisallowNonAggregated

public boolean isDisallowNonAggregated()

Returns:

allow only a single root/subject object to be written out into JSON/YAML/XML export file

setDisallowNonAggregated

public void setDisallowNonAggregated(boolean disallowNonAggregated)

Parameters:

disallowNonAggregated - allow only a single root/subject object to be written out into JSON/YAML/XML export file

isIncludeNonAggregated

public boolean isIncludeNonAggregated()

Returns:

write out all objects that are not aggregated in any other object at root level into JSON/YAML/XML export file

setIncludeNonAggregated

public void setIncludeNonAggregated(boolean includeNonAggregated)

Parameters:

includeNonAggregated - write out all objects that are not aggregated in any other object at root level into JSON/YAML/XML export file

isIgnoreNonAggregated

public boolean isIgnoreNonAggregated()

Returns:

don't write out any object that are not aggregated in any other object into JSON/YAML/XML export file

setIgnoreNonAggregated

public void setIgnoreNonAggregated(boolean ignoreNonAggregated)

Parameters:

ignoreNonAggregated - don't write out any object that are not aggregated in any other object into JSON/YAML/XML export file

getNumberOfThreads

public int getNumberOfThreads()

Gets number of parallel threads (default is 1) to be used.

Returns:

number of threads (default is 1)

setNumberOfThreads

public void setNumberOfThreads(int numberOfThreads)

Sets number of parallel threads (default is 1) to be used

Parameters:

numberOfThreads - number of threads

getTransactional

public boolean getTransactional()

If true, export rows in a single transaction. (default is false)

Returns:

true if Import rows in a single transaction

setTransactional

public void setTransactional(boolean transactional)

If true, export rows in a single transaction. (default is false)

Parameters:

transactional - true if import rows in a single transaction

getIsolationLevel

public java.lang.Integer getIsolationLevel()

Gets IsolationLevel.

See Also:

Connection.setTransactionIsolation(int)

setIsolationLevel

public void setIsolationLevel(java.lang.Integer isolationLevel)

Sets IsolationLevel.

See Also:

Connection.setTransactionIsolation(int)

getNumberOfEntities

public int getNumberOfEntities()

Gets maximum number of entities per insert-statement (in export-file, default is 10)

Returns:

maximum number of entities per insert-statement (in export-file, default is 10)

setNumberOfEntities

public void setNumberOfEntities(int numberOfEntities)

Sets maximum number of entities per insert-statement (in export-file, default is 10)

Parameters:

numberOfEntities - maximum number of entities per insert-statement (in export-file, default is 10)

getUpsertOnly

public boolean getUpsertOnly()

If true, Generate 'upsert'-statements for all entities (in export-file)

Returns:

true if Generate 'upsert'-statements for all entities (in export-file)

setUpsertOnly

public void setUpsertOnly(boolean upsertOnly)

If true, Generate 'upsert'-statements for all entities (in export-file)

Parameters:

upsertOnly - true if Generate 'upsert'-statements for all entities (in export-file)

getScope

public WorkingTableScope getScope()

Gets scope of working tables, GLOBAL, SESSION_LOCAL or LOCAL_DATABASE
Default is GLOBAL.

Returns:

scope of working tables, GLOBAL, SESSION_LOCAL or LOCAL_DATABASE

setScope

public void setScope(WorkingTableScope scope)

Sets scope of working tables, GLOBAL, SESSION_LOCAL or LOCAL_DATABASE

Parameters:

scope - scope of working tables, GLOBAL, SESSION_LOCAL or LOCAL_DATABASE

getWorkingTableSchema

public java.lang.String getWorkingTableSchema()

Gets schema in which the working tables will be created

Returns:

schema in which the working tables will be created

setWorkingTableSchema

public void setWorkingTableSchema(java.lang.String workingTableSchema)

Sets schema in which the working tables will be created

Parameters:

workingTableSchema - schema in which the working tables will be created

getNoSorting

public boolean getNoSorting()

If true, The exported rows will not be sorted according to foreign key constraints

Returns:

true if The exported rows will not be sorted according to foreign key constraints

setNoSorting

public void setNoSorting(boolean noSorting)

If true, The exported rows will not be sorted according to foreign key constraints

Parameters:

noSorting - true if The exported rows will not be sorted according to foreign key constraints

getNoRowid

public boolean getNoRowid()

Deprecated. use getUseRowid()

setNoRowid

public void setNoRowid(boolean noRowid)

Deprecated. use setUseRowid(boolean)

getUseRowid

public boolean getUseRowid()

If true, use rowid/ctid-column to determine row identity (instead of primary keys)

Returns:

if true use rowid/ctid-column to determine row identity (instead of primary keys)

setUseRowid

public void setUseRowid(boolean useRowid)

If true, use rowid/ctid-column to determine row identity (instead of primary keys)

Parameters:

useRowid - if true use rowid/ctid-column to determine row identity (instead of primary keys)

getUseRowIdsOnlyForTablesWithoutPK

public boolean getUseRowIdsOnlyForTablesWithoutPK()

If true, use rowid/ctid-column only for tables without primary key.

Returns:

true if use rowid/ctid-column only for tables without primary key

See Also:

getUseRowIdsOnlyForTablesWithoutPK()

setUseRowIdsOnlyForTablesWithoutPK

public void setUseRowIdsOnlyForTablesWithoutPK(boolean useRowIdsOnlyForTablesWithoutPK)

If true, use rowid/ctid-column only for tables without primary key.

Parameters:

useRowIdsOnlyForTablesWithoutPK - true if use rowid/ctid-column only for tables without primary key

See Also:

setUseRowid(boolean)

getImportFilterMappingTableSchema

public java.lang.String getImportFilterMappingTableSchema()

Gets schema in which the import-filter mapping tables will be created

Returns:

schema in which the import-filter mapping tables will be created

setImportFilterMappingTableSchema

public void setImportFilterMappingTableSchema(java.lang.String importFilterMappingTableSchema)

Sets schema in which the import-filter mapping tables will be created

Parameters:

importFilterMappingTableSchema - schema in which the import-filter mapping tables will be created

getParameters

public java.util.Map<java.lang.String,java.lang.String> getParameters()

Gets parameters.

Returns:

parameters

setParameter

public void setParameter(java.lang.String name,
                         java.lang.String value)

Sets a parameter.

Parameters:

name - parameter name

value - value

getSchemaMapping

public java.util.Map<java.lang.String,java.lang.String> getSchemaMapping()

Gets schema map for destination database.

Returns:

schema map

setSchemaMapping

public void setSchemaMapping(java.util.Map<java.lang.String,java.lang.String> schemaMapping)

Sets schema map for destination database.

Parameters:

schemaMapping - schema map

setSourceSchemaMapping

public void setSourceSchemaMapping(java.util.Map<java.lang.String,java.lang.String> sourceSchemaMapping)

Sets schema map for source database.

Parameters:

sourceSchemaMapping - the sourceSchemaMapping to set

getSourceSchemaMapping

public java.util.Map<java.lang.String,java.lang.String> getSourceSchemaMapping()

Gets schema map for source database.

Returns:

the sourceSchemaMapping to set

isAbortInCaseOfInconsistency

public boolean isAbortInCaseOfInconsistency()

Returns:

if true, the Subsetter throws an exception if the result is inconsistent due to insufficient transaction isolation

setAbortInCaseOfInconsistency

public void setAbortInCaseOfInconsistency(boolean abortInCaseOfInconsitency)

Parameters:

abortInCaseOfInconsitency - if true, abort the process if the result is inconsistent due to insufficient transaction isolation

getModelPoolSize

public int getModelPoolSize()

Returns:

the size of extraction-model pool (default is 10)

setModelPoolSize

public void setModelPoolSize(int modelPoolSize)

Parameters:

modelPoolSize - size of extraction-model pool (default is 10)

getLocalDatabaseStorage

public java.lang.String getLocalDatabaseStorage()

Returns:

the folder where the local database will be stored. If null, default temp folder is used.

setLocalDatabaseStorage

public void setLocalDatabaseStorage(java.io.File localDatabaseStorage)

Sets the folder where the local database will be stored.

Parameters:

localDatabaseStorage - the folder where the local database will be stored. If null, default temp folder is used.

setLocalDatabaseStorage

public void setLocalDatabaseStorage(java.lang.String localDatabaseStorage)

Sets the folder where the local database will be stored.

Parameters:

localDatabaseStorage - the folder where the local database will be stored. If null, default temp folder is used.

getExecutionContext

public ExecutionContext getExecutionContext()

Gets the ExecutionContext.
Use this to set parameters that are not accessible via this facade.

Returns:

the ExecutionContext