com.speedment.runtime.core.db

Interface DbmsMetadataHandler

public interface DbmsMetadataHandler

A DbmsMetadataHandler provides the interface between Speedment and an underlying Dbms for when initially loading the metadata.

Since:

2.0.0

Author:

Per Minborg, Emil Forslund

Method Summary

Modifier and Type	Method and Description
String	getDbmsInfoString(com.speedment.runtime.config.Dbms dbms) Returns a string with information on the current dbms.
CompletableFuture<com.speedment.runtime.config.Project>	readSchemaMetadata(com.speedment.runtime.config.Dbms dbms, ProgressMeasure progressListener, Predicate<String> filterCriteria) Reads the schema metadata with populated Schemas that are available in this database.

Method Detail

readSchemaMetadata

CompletableFuture<com.speedment.runtime.config.Project> readSchemaMetadata(com.speedment.runtime.config.Dbms dbms,
                                                                           ProgressMeasure progressListener,
                                                                           Predicate<String> filterCriteria)

Reads the schema metadata with populated Schemas that are available in this database. The schemas are populated by all their sub-items such as tables, columns etc. Schemas that are a part of the getDbms().getType().getSchemaExcludSet() set are excluded from the model or that does not match the given filter will be excluded from the Stream.

Parameters:

dbms - the dbms to read it from

progressListener - the progress listener

filterCriteria - criteria that schema names must fulfill

Returns:

the handle for this task

getDbmsInfoString

String getDbmsInfoString(com.speedment.runtime.config.Dbms dbms)
                  throws SQLException

Returns a string with information on the current dbms.

Parameters:

dbms - to get information on

Returns:

a string with information on the current dbms

Throws:

SQLException - if an error occurs