net.sf.jailer.api

Class Subsetter

java.lang.Object

net.sf.jailer.api.Subsetter

public class Subsetter
extends 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(DataSource dataSource, DBMS dbms, File dataModel, File extractionModel, ScriptFormat scriptFormat) Creates a new Subsetter with all mandatory attributes.
Subsetter(DataSource dataSource, DBMS dbms, URL dataModel, URL extractionModel, ScriptFormat scriptFormat) Creates a new Subsetter with all mandatory attributes.
Subsetter(Subsetter other) Copy constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	execute(String whereClause, File exportScriptFile) Generates the export-script.
void	execute(String whereClause, File exportScriptFile, File deleteScriptFile) Generates the export- and/or delete-script.
URL	getDataModelURL() Gets URL of the current data model (the datamodel's base folder)
DataSource	getDataSource() Gets the data-source to connect with the database.
DBMS	getDbms() Gets the DBMS of the database.
URL	getExtractionModelURL() Gets the URL of the extraction model.
String	getImportFilterMappingTableSchema() Gets schema in which the import-filter mapping tables will be created
int	getModelPoolSize()
boolean	getNoRowid() If true, Use primary keys to determine row identity (instead of rowid-column)
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.
Map<String,String>	getParameters() Gets parameters TODO
Map<String,String>	getSchemaMapping()
WorkingTableScope	getScope() Gets scope of working tables, GLOBAL, SESSION_LOCAL or LOCAL_DATABASE Default is GLOBAL.
ScriptFormat	getScriptFormat() Gets the script format.
Map<String,String>	getSourceSchemaMapping()
DBMS	getTargetDBMS() Gets target-DBMS.
boolean	getUpsertOnly() If true, Generate 'upsert'-statements for all entities (in export-file)
boolean	getUTF8() If true, Use uTF-8 encoding
String	getWorkingTableSchema() Gets schema in which the working tables will be created
String	getXmlDatePattern() Gets pattern for dates in XML and LIQUIBASE_XML export file
String	getXmlRootTag() Gets root tag of XML export file
String	getXmlTimePattern() Gets pattern for times in XML and LIQUIBASE_XML export file
String	getXmlTimeStampPattern() Gets pattern for time-stamps in XML and LIQUIBASE_XML export file
void	setDataModelBaseFolder(File datamodelBaseFolder) Sets the current data model as File
void	setDataModelURL(URL datamodelURL) Sets URL of the current data model (the datamodel's base folder)
void	setDataSource(DataSource dataSource) Sets the data-source to connect with the database.
void	setDbms(DBMS dbms) Sets the DBMS of the database.
void	setExtractionModelURL(URL extractionModelURL) Sets the URL of the extraction model.
void	setImportFilterMappingTableSchema(String importFilterMappingTableSchema) Sets schema in which the import-filter mapping tables will be created
void	setModelPoolSize(int modelPoolSize)
void	setNoRowid(boolean noRowid) If true, Use primary keys to determine row identity (instead of rowid-column)
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(String name, String value) Sets a parameter.
void	setSchemaMapping(Map<String,String> schemaMapping) Sets source schema map TODO
void	setScope(WorkingTableScope scope) Sets scope of working tables, GLOBAL, SESSION_LOCAL or LOCAL_DATABASE
void	setScriptFormat(ScriptFormat scriptFormat) Sets the script format.
void	setSourceSchemaMapping(Map<String,String> sourceSchemaMapping) TODO
void	setTargetDBMS(DBMS targetDBMS) Sets target-DBMS.
void	setUpsertOnly(boolean upsertOnly) If true, Generate 'upsert'-statements for all entities (in export-file)
void	setUTF8(boolean uTF8) If true, use UTF-8 encoding
void	setWorkingTableSchema(String workingTableSchema) Sets schema in which the working tables will be created
void	setXmlDatePattern(String xmlDatePattern) Sets pattern for dates in XML and LIQUIBASE_XML export file
void	setXmlRootTag(String xmlRootTag) Sets root tag of XML export file
void	setXmlTimePattern(String xmlTimePattern) Sets pattern for times in XML and LIQUIBASE_XML export file
void	setXmlTimeStampPattern(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(DataSource dataSource,
         DBMS dbms,
         URL dataModel,
         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 (the datamodel's base folder)

extractionModel - URL of the extraction model

scriptFormat - script format

Subsetter

public Subsetter(DataSource dataSource,
         DBMS dbms,
         File dataModel,
         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 void execute(String whereClause,
           File exportScriptFile)
             throws SQLException,
                    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')

Throws:

SQLException

IOException

execute

public void execute(String whereClause,
           File exportScriptFile,
           File deleteScriptFile)
             throws SQLException,
                    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

Throws:

SQLException

IOException

getDataSource

public DataSource getDataSource()

Gets the data-source to connect with the database.

Returns:

the data-source to connect with the database

setDataSource

public void setDataSource(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 URL getDataModelURL()

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

setDataModelURL

public void setDataModelURL(URL datamodelURL)

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

setDataModelBaseFolder

public void setDataModelBaseFolder(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 URL getExtractionModelURL()

Gets the URL of the extraction model.

Returns:

the URL of the extraction model

setExtractionModelURL

public void setExtractionModelURL(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 String getXmlRootTag()

Gets root tag of XML export file

Returns:

root tag of XML export file

setXmlRootTag

public void setXmlRootTag(String xmlRootTag)

Sets root tag of XML export file

Parameters:

xmlRootTag - root tag of XML export file

getXmlDatePattern

public 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(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 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(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 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(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

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

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 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(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()

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

Returns:

true if Use primary keys to determine row identity (instead of rowid-column)

setNoRowid

public void setNoRowid(boolean noRowid)

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

Parameters:

noRowid - true if Use primary keys to determine row identity (instead of rowid-column)

getImportFilterMappingTableSchema

public 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(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 Map<String,String> getParameters()

Gets parameters TODO

Returns:

parameters

setParameter

public void setParameter(String name,
                String value)

Sets a parameter.

Parameters:

name - parameter name

value - value

getSchemaMapping

public Map<String,String> getSchemaMapping()

setSchemaMapping

public void setSchemaMapping(Map<String,String> schemaMapping)

Sets source schema map TODO

Parameters:

rawsourceschemamapping - source schema map

setSourceSchemaMapping

public void setSourceSchemaMapping(Map<String,String> sourceSchemaMapping)

TODO

Parameters:

sourceSchemaMapping - the sourceSchemaMapping to set

getSourceSchemaMapping

public Map<String,String> getSourceSchemaMapping()

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)