net.datenwerke.rs.base.service.datasources

Interface DatasourceHelperService

public interface DatasourceHelperService

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	copyTable(DatabaseDatasource sourceDatasource, java.lang.String sourceTable, DatabaseDatasource destinationDatasource, java.lang.String destinationTable, java.util.List<java.lang.String> primaryKeys, boolean copyPrimaryKeys, int batchSize)
java.util.Map<java.lang.String,java.lang.Object>	fetchDatasourceMetadata(DatabaseDatasource datasource, java.util.Map<java.lang.String,java.util.List<java.lang.String>> methodDescriptions) Dynamically calls a methods from the class DatabaseMetaData.
java.util.Map<java.lang.String,java.lang.Object>	fetchDatasourceMetadata(java.lang.String driverClass, java.lang.String jdbcUrl, java.lang.String jdbcUsername, java.lang.String jdbcPassword, java.util.Map<java.lang.String,java.util.List<java.lang.String>> methodDescriptions)
java.util.Map<java.lang.String,java.lang.Object>	fetchInfoDatasourceMetadata(DatasourceDefinition datasource, boolean datasourceInfo, boolean jdbcUrlInfo, boolean databaseFunctionsInfo, boolean databaseSupportsInfo) Fetches general metadata information about a given datasource.
java.util.Map<java.lang.String,java.lang.Object>	fetchInfoDatasourceMetadata(java.lang.String driverClass, java.lang.String jdbcUrl, java.lang.String jdbcUsername, java.lang.String jdbcPassword, boolean datasourceInfo, boolean jdbcUrlInfo, boolean databaseFunctionsInfo, boolean databaseSupportsInfo)
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	getColumnMetadata(DatabaseDatasource datasource, java.lang.String table)
java.util.List<java.util.Map<java.lang.String,java.lang.Object>>	getColumnMetadata(DatabaseDatasource datasource, java.lang.String table, java.util.List<java.lang.String> additionalColumns)
java.util.Map<DatasourceInfoType,java.util.Map<java.lang.String,java.lang.String>>	getDatasourceInfoDefinition() Provides a map containing what information is fetched when using fetchDatasourceMetadata().
java.util.Map<java.lang.String,java.lang.Object>	getGeneralInformation(DatasourceDefinition datasource)
java.util.List<java.lang.String>	getNonExistingColumns(DatabaseDatasource datasource, java.lang.String table, java.util.List<java.lang.String> columns) Returns the columns which do not exist in the given table.
java.lang.String	getQuery(DatasourceContainer datasourceContainer)
boolean	tableExists(DatabaseDatasource datasource, java.lang.String table)

Method Detail

copyTable

java.util.Map<java.lang.String,java.lang.Object> copyTable(DatabaseDatasource sourceDatasource,
                                                           java.lang.String sourceTable,
                                                           DatabaseDatasource destinationDatasource,
                                                           java.lang.String destinationTable,
                                                           java.util.List<java.lang.String> primaryKeys,
                                                           boolean copyPrimaryKeys,
                                                           int batchSize)

tableExists

boolean tableExists(DatabaseDatasource datasource,
                    java.lang.String table)

getNonExistingColumns

java.util.List<java.lang.String> getNonExistingColumns(DatabaseDatasource datasource,
                                                       java.lang.String table,
                                                       java.util.List<java.lang.String> columns)

Returns the columns which do not exist in the given table. This is a subset of the columns parameter. If the result is empty, all columns are found in the given table.

Parameters:

datasource - the datasource

table - the table to check

columns - the columns to check

Returns:

the non-existing columns in the table

getColumnMetadata

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getColumnMetadata(DatabaseDatasource datasource,
                                                                                   java.lang.String table)

getColumnMetadata

java.util.List<java.util.Map<java.lang.String,java.lang.Object>> getColumnMetadata(DatabaseDatasource datasource,
                                                                                   java.lang.String table,
                                                                                   java.util.List<java.lang.String> additionalColumns)

fetchDatasourceMetadata

java.util.Map<java.lang.String,java.lang.Object> fetchDatasourceMetadata(DatabaseDatasource datasource,
                                                                         java.util.Map<java.lang.String,java.util.List<java.lang.String>> methodDescriptions)
                                                                  throws java.sql.SQLException

Dynamically calls a methods from the class DatabaseMetaData. Any method is call-able. The call fails if argument count and name does not match exactly one method of said class. The call fails as well if the args cannot be converted into the needed parameter types. If "null" is passed as a String in args it will be evaluated to null as an Object. Boolean and Integer are converted using String.toBoolean() and String.toInteger()

Parameters:

datasource - the datasource

methodDescriptions - is a map with the structure keys:= method name as String | values:= parameters as List of String

Returns:

a map with the structure keys:= method name as String | values:= return-object of called method

Throws:

java.sql.SQLException

fetchDatasourceMetadata

java.util.Map<java.lang.String,java.lang.Object> fetchDatasourceMetadata(java.lang.String driverClass,
                                                                         java.lang.String jdbcUrl,
                                                                         java.lang.String jdbcUsername,
                                                                         java.lang.String jdbcPassword,
                                                                         java.util.Map<java.lang.String,java.util.List<java.lang.String>> methodDescriptions)
                                                                  throws java.sql.SQLException

Throws:

java.sql.SQLException

fetchInfoDatasourceMetadata

java.util.Map<java.lang.String,java.lang.Object> fetchInfoDatasourceMetadata(DatasourceDefinition datasource,
                                                                             boolean datasourceInfo,
                                                                             boolean jdbcUrlInfo,
                                                                             boolean databaseFunctionsInfo,
                                                                             boolean databaseSupportsInfo)
                                                                      throws java.sql.SQLException

Fetches general metadata information about a given datasource. Information about which data is acquired with getDatasourceInfoDefinition(), which provides a config map

Parameters:

datasource - the datasource

datasourceInfo - if true, fetches general information

jdbcUrlInfo - if true, fetches URL information

databaseFunctionsInfo - if true, fetches information on functions

databaseSupportsInfo - if true, fetches information on supports

Returns:

the map containing

Throws:

java.sql.SQLException

fetchInfoDatasourceMetadata

java.util.Map<java.lang.String,java.lang.Object> fetchInfoDatasourceMetadata(java.lang.String driverClass,
                                                                             java.lang.String jdbcUrl,
                                                                             java.lang.String jdbcUsername,
                                                                             java.lang.String jdbcPassword,
                                                                             boolean datasourceInfo,
                                                                             boolean jdbcUrlInfo,
                                                                             boolean databaseFunctionsInfo,
                                                                             boolean databaseSupportsInfo)
                                                                      throws java.sql.SQLException

Throws:

java.sql.SQLException

getDatasourceInfoDefinition

java.util.Map<DatasourceInfoType,java.util.Map<java.lang.String,java.lang.String>> getDatasourceInfoDefinition()

Provides a map containing what information is fetched when using fetchDatasourceMetadata(). This map has keys of type DatasourceInfoType. Each key points to another Map of type with the structure 'method description' -> 'method name'

Returns:

the config map

getQuery

java.lang.String getQuery(DatasourceContainer datasourceContainer)

getGeneralInformation

java.util.Map<java.lang.String,java.lang.Object> getGeneralInformation(DatasourceDefinition datasource)