java.lang.Object
- io.ebean.docker.commands.BaseConfig
- - io.ebean.docker.commands.DbConfig

All Implemented Interfaces:

ContainerConfig

Direct Known Subclasses:

ClickHouseConfig, CockroachConfig, HanaConfig, MySqlConfig, NuoDBConfig, OracleConfig, PostgresConfig, SqlServerConfig
```
public abstract class DbConfig
extends BaseConfig
```
Configuration for an DBMS like Postgres, MySql, Oracle, SQLServer

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Connection`	`createAdminConnection()`	Return a DB connection using the admin user.
`Connection`	`createAdminConnection(String url)`	Return a Connection to the database using the admin user.
`Connection`	`createConnection()`	Return a Connection to the database (make sure you close it).
`Connection`	`createConnectionNoSchema()`	Return a DB connection without schema (as it maybe is not created yet).
`String`	`getAdminPassword()`
`String`	`getAdminUsername()`
`String`	`getDbName()`
`String`	`getExtensions()`
`String`	`getExtraDb()`
`String`	`getExtraDbInitSqlFile()`
`String`	`getExtraDbPassword()`
`String`	`getExtraDbSeedSqlFile()`
`String`	`getExtraDbUser()`
`String`	`getInitSqlFile()`
`String`	`getPassword()`
`String`	`getSchema()`
`String`	`getSeedSqlFile()`
`String`	`getTmpfs()`
`String`	`getUsername()`
`void`	`initDefaultSchema()`	Set the schema if it hasn't already set.
`boolean`	`isFastStartMode()`
`boolean`	`isInMemory()`
`DbConfig`	`setAdminPassword(String adminPassword)`	Set the password for the DB admin user.
`DbConfig`	`setAdminUser(String dbAdminUser)`	Set the password for the DB admin user.
`DbConfig`	`setDbName(String dbName)`	Set the DB name.
`DbConfig`	`setExtensions(String extensions)`	Set the DB extensions to install (Postgres hstore, pgcrypto etc)
`DbConfig`	`setExtraDb(String extraDb)`	Set the name of an extra database to create.
`DbConfig`	`setExtraDbInitSqlFile(String extraDbInitSqlFile)`	Set a file to execute after creating the extra database.
`DbConfig`	`setExtraDbPassword(String extraDbPassword)`	Set the password for an extra user.
`DbConfig`	`setExtraDbSeedSqlFile(String extraDbSeedSqlFile)`	Set a file to execute after creating the extra database.
`DbConfig`	`setExtraDbUser(String extraDbUser)`	Set the name of an extra user to create.
`DbConfig`	`setFastStartMode(boolean fastStartMode)`	Set to true to use fast start mode.
`DbConfig`	`setInitSqlFile(String initSqlFile)`	Set the SQL file to execute after creating the database.
`DbConfig`	`setInMemory(boolean inMemory)`	Set to true to run using in memory storage for data via tmpfs.
`DbConfig`	`setPassword(String password)`	Set the DB password.
`DbConfig`	`setProperties(Properties properties)`	Load configuration from properties.
`DbConfig`	`setSchema(String schema)`	Set the DB schema.
`DbConfig`	`setSeedSqlFile(String seedSqlFile)`	Set the SQL file to execute after creating the database and initSqlFile.
`DbConfig`	`setTmpfs(String tmpfs)`	Set the temp fs for in-memory use.
`DbConfig`	`setUser(String user)`	Set the DB user.
`String`	`startDescription()`	Return a description of the configuration.
`String`	`summary()`	Return summary of the port db name and other details.

Methods inherited from class io.ebean.docker.commands.BaseConfig
clearStopMode, containerName, getAdminInternalPort, getAdminPort, getCharacterSet, getCollation, getDocker, getImage, getInternalPort, getMaxReadyAttempts, getPort, getStartMode, getStopMode, isDefaultCollation, isExplicitCollation, isStopModeNone, jdbcAdminUrl, jdbcUrl, platform, setAdminInternalPort, setAdminPort, setCharacterSet, setCollation, setContainerName, setDocker, setImage, setInternalPort, setMaxReadyAttempts, setPort, setShutdownMode, setStartMode, setStopMode, shutdownMode, stopDescription, version

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - startDescription
```
public String startDescription()
```
    Return a description of the configuration.
    
    Specified by:
    
    startDescription in interface ContainerConfig
    
    Overrides:
    
    startDescription in class BaseConfig
  - summary
```
public String summary()
```
    Return summary of the port db name and other details.
  - initDefaultSchema
```
public void initDefaultSchema()
```
    Set the schema if it hasn't already set. Some databases (NuoDB) effectively require a default schema and it is reasonable for this to default to the username.
  - createConnection
```
public Connection createConnection()
                            throws SQLException
```
    Return a Connection to the database (make sure you close it).
    
    Specified by:
    
    createConnection in interface ContainerConfig
    
    Overrides:
    
    createConnection in class BaseConfig
    
    Throws:
    
    SQLException
  - createConnectionNoSchema
```
public Connection createConnectionNoSchema()
                                    throws SQLException
```
    Description copied from interface: ContainerConfig
    
    Return a DB connection without schema (as it maybe is not created yet).
    
    Specified by:
    
    createConnectionNoSchema in interface ContainerConfig
    
    Overrides:
    
    createConnectionNoSchema in class BaseConfig
    
    Throws:
    
    SQLException
  - createAdminConnection
```
public Connection createAdminConnection(String url)
                                 throws SQLException
```
    Return a Connection to the database using the admin user.
    
    Throws:
    
    SQLException
  - createAdminConnection
```
public Connection createAdminConnection()
                                 throws SQLException
```
    Description copied from interface: ContainerConfig
    
    Return a DB connection using the admin user.
    
    Specified by:
    
    createAdminConnection in interface ContainerConfig
    
    Overrides:
    
    createAdminConnection in class BaseConfig
    
    Throws:
    
    SQLException
  - setProperties
```
public DbConfig setProperties(Properties properties)
```
    Load configuration from properties.
    
    Overrides:
    
    setProperties in class BaseConfig
  - setAdminUser
```
public DbConfig setAdminUser(String dbAdminUser)
```
    Set the password for the DB admin user.
  - setAdminPassword
```
public DbConfig setAdminPassword(String adminPassword)
```
    Set the password for the DB admin user.
  - setTmpfs
```
public DbConfig setTmpfs(String tmpfs)
```
    Set the temp fs for in-memory use.
  - setFastStartMode
```
public DbConfig setFastStartMode(boolean fastStartMode)
```
    Set to true to use fast start mode.
  - setDbName
```
public DbConfig setDbName(String dbName)
```
    Set the DB name.
  - setUser
```
public DbConfig setUser(String user)
```
    Set the DB user.
  - setPassword
```
public DbConfig setPassword(String password)
```
    Set the DB password.
  - setSchema
```
public DbConfig setSchema(String schema)
```
    Set the DB schema.
  - setExtensions
```
public DbConfig setExtensions(String extensions)
```
    Set the DB extensions to install (Postgres hstore, pgcrypto etc)
  - setInitSqlFile
```
public DbConfig setInitSqlFile(String initSqlFile)
```
    Set the SQL file to execute after creating the database.
  - setSeedSqlFile
```
public DbConfig setSeedSqlFile(String seedSqlFile)
```
    Set the SQL file to execute after creating the database and initSqlFile.
  - setExtraDb
```
public DbConfig setExtraDb(String extraDb)
```
    Set the name of an extra database to create.
  - setExtraDbUser
```
public DbConfig setExtraDbUser(String extraDbUser)
```
    Set the name of an extra user to create. If an extra database is also created this would be the owner of that extra database.
  - setExtraDbPassword
```
public DbConfig setExtraDbPassword(String extraDbPassword)
```
    Set the password for an extra user. If nothing is set this would default to be the same as the main users password.
  - setExtraDbInitSqlFile
```
public DbConfig setExtraDbInitSqlFile(String extraDbInitSqlFile)
```
    Set a file to execute after creating the extra database.
  - setExtraDbSeedSqlFile
```
public DbConfig setExtraDbSeedSqlFile(String extraDbSeedSqlFile)
```
    Set a file to execute after creating the extra database.
  - setInMemory
```
public DbConfig setInMemory(boolean inMemory)
```
    Set to true to run using in memory storage for data via tmpfs.
  - isInMemory
```
public boolean isInMemory()
```
  - getTmpfs
```
public String getTmpfs()
```
  - getAdminUsername
```
public String getAdminUsername()
```
  - getAdminPassword
```
public String getAdminPassword()
```
  - getDbName
```
public String getDbName()
```
  - getUsername
```
public String getUsername()
```
  - getPassword
```
public String getPassword()
```
  - getSchema
```
public String getSchema()
```
  - getExtensions
```
public String getExtensions()
```
  - getInitSqlFile
```
public String getInitSqlFile()
```
  - getSeedSqlFile
```
public String getSeedSqlFile()
```
  - getExtraDb
```
public String getExtraDb()
```
  - getExtraDbUser
```
public String getExtraDbUser()
```
  - getExtraDbPassword
```
public String getExtraDbPassword()
```
  - getExtraDbInitSqlFile
```
public String getExtraDbInitSqlFile()
```
  - getExtraDbSeedSqlFile
```
public String getExtraDbSeedSqlFile()
```
  - isFastStartMode
```
public boolean isFastStartMode()
```

Class DbConfig

Method Summary

Methods inherited from class io.ebean.docker.commands.BaseConfig

Methods inherited from class java.lang.Object

Method Detail

startDescription

summary

initDefaultSchema

createConnection

createConnectionNoSchema

createAdminConnection

createAdminConnection

setProperties

setAdminUser

setAdminPassword

setTmpfs

setFastStartMode

setDbName

setUser

setPassword

setSchema

setExtensions

setInitSqlFile

setSeedSqlFile

setExtraDb

setExtraDbUser

setExtraDbPassword

setExtraDbInitSqlFile

setExtraDbSeedSqlFile

setInMemory

isInMemory

getTmpfs

getAdminUsername

getAdminPassword

getDbName

getUsername

getPassword

getSchema

getExtensions

getInitSqlFile

getSeedSqlFile

getExtraDb

getExtraDbUser

getExtraDbPassword

getExtraDbInitSqlFile

getExtraDbSeedSqlFile

isFastStartMode