com.speedment.runtime.config

Interface Dbms

All Superinterfaces:

Document, HasAlias, HasChildren, HasEnabled, HasId, HasMainInterface, HasMutator<DbmsMutator<? extends Dbms>>, HasName, HasParent<Project>

public interface Dbms
extends Document, HasParent<Project>, HasEnabled, HasId, HasName, HasChildren, HasAlias, HasMainInterface, HasMutator<DbmsMutator<? extends Dbms>>

A typed Document that represents a dbms instance in the database. A Dbms is located inside a Project and can have multiple Schemas as children.

Since:

2.0.0

Author:

Emil Forslund

Field Summary

Fields

Modifier and Type	Field and Description
static String	CONNECTION_URL
static String	IP_ADDRESS
static String	PORT
static String	SCHEMAS
static String	TYPE_NAME
static String	USERNAME

Fields inherited from interface com.speedment.runtime.config.trait.HasEnabled

ENABLED, ENABLED_DEFAULT

Fields inherited from interface com.speedment.runtime.config.trait.HasId

ID

Fields inherited from interface com.speedment.runtime.config.trait.HasAlias

ALIAS

Method Summary

Modifier and Type	Method and Description
default Optional<String>	getConnectionUrl() Returns the explicit connection URL to use for this Dbms if the user has specified one, or an empty Optional if one should be generated automatically by the DbmsType.
default Optional<String>	getIpAddress() Returns the address of the database host if it is specified.
default OptionalInt	getPort() Returns the port number of the database on the database host.
default String	getTypeName() Returns the type name of the DbmsType of this Dbms.
default Optional<String>	getUsername() Returns the database username to use when connecting to the dbms.
default Class<Dbms>	mainInterface() Returns the Class of the interface of this node.
default DbmsMutator<? extends Dbms>	mutator() Returns a DocumentMutator for this Document.
Stream<? extends Schema>	schemas() Creates a stream of schemas located in this document.

Methods inherited from interface com.speedment.runtime.config.trait.HasParent

getParent, getParentOrThrow

Methods inherited from interface com.speedment.runtime.config.trait.HasEnabled

isEnabled, of, test

Methods inherited from interface com.speedment.runtime.config.trait.HasId

getId, of

Methods inherited from interface com.speedment.runtime.config.trait.HasChildren

defaultNameFor

Methods inherited from interface com.speedment.runtime.config.trait.HasAlias

getAlias, getJavaName, of

Field Detail

TYPE_NAME

static final String TYPE_NAME

See Also:

Constant Field Values

IP_ADDRESS

static final String IP_ADDRESS

See Also:

Constant Field Values

PORT

static final String PORT

See Also:

Constant Field Values

CONNECTION_URL

static final String CONNECTION_URL

See Also:

Constant Field Values

USERNAME

static final String USERNAME

See Also:

Constant Field Values

SCHEMAS

static final String SCHEMAS

See Also:

Constant Field Values

Method Detail

getTypeName

default String getTypeName()

Returns the type name of the DbmsType of this Dbms. This will be the fully qualified class name of the DbmsType implementing class.

Returns:

the type name

getIpAddress

default Optional<String> getIpAddress()

Returns the address of the database host if it is specified. The address could be an ip-address or a hostname. If no address is specified, empty will be returned.

Returns:

the address of the host or empty

getPort

default OptionalInt getPort()

Returns the port number of the database on the database host. If no port is specified, empty is returned.

Returns:

the port of the database or empty

getConnectionUrl

default Optional<String> getConnectionUrl()

Returns the explicit connection URL to use for this Dbms if the user has specified one, or an empty Optional if one should be generated automatically by the DbmsType.

Returns:

the explicit connection URL to use for this Dbms

getUsername

default Optional<String> getUsername()

Returns the database username to use when connecting to the dbms. If no username is specified, empty is returned.

Returns:

the database username or empty

schemas

Stream<? extends Schema> schemas()

Creates a stream of schemas located in this document.

Returns:

schemas

mainInterface

default Class<Dbms> mainInterface()

Description copied from interface: HasMainInterface

Returns the Class of the interface of this node.

This should not be overridden by implementing classes!

Specified by:

mainInterface in interface HasMainInterface

Returns:

the main interface class

mutator

default DbmsMutator<? extends Dbms> mutator()

Description copied from interface: HasMutator

Returns a DocumentMutator for this Document. A DocumentMutator allows a Document to be updated in a type safe way.

Specified by:

mutator in interface HasMutator<DbmsMutator<? extends Dbms>>

Returns:

a DocumentMutator for this Document