H2EmbeddedDataSourceConfig (dbpool 0.207 API)

java.lang.Object
- com.facebook.airlift.dbpool.ManagedDataSourceConfig<H2EmbeddedDataSourceConfig>
- - com.facebook.airlift.dbpool.H2EmbeddedDataSourceConfig

public class H2EmbeddedDataSourceConfig
extends ManagedDataSourceConfig<H2EmbeddedDataSourceConfig>

Configuration for H2EmbeddedDataSource.

The configuration options can be chained as follows:

 
     H2EmbeddedDataSourceConfig config = new H2EmbeddedDataSourceConfig()
             .setUsername("username")
             .setPassword("password")
             .setMaxConnections(20)
             .setMaxConnectionWait(new Duration(20, TimeUnit.MILLISECONDS)),
             .setFilename(fileName)
             .setInitScript("src/test/db/h2.ddl");

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`H2EmbeddedDataSourceConfig.AllowLiterals`
`static class`	`H2EmbeddedDataSourceConfig.Cipher`
`static class`	`H2EmbeddedDataSourceConfig.CompressLob`

Constructor Summary

Constructors
Constructor and Description

H2EmbeddedDataSourceConfig()

Constructors
Constructor and Description
`H2EmbeddedDataSourceConfig()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`H2EmbeddedDataSourceConfig.AllowLiterals`	`getAllowLiterals()` This setting can help solve the SQL injection problem.
`int`	`getCacheSize()` Sets the size of the cache in KB (each KB being 1024 bytes) for the current database.
`H2EmbeddedDataSourceConfig.Cipher`	`getCipher()` Sets the cipher algorithm to encrypt the database file.
`H2EmbeddedDataSourceConfig.CompressLob`	`getCompressLob()` Sets the compression algorithm for BLOB and CLOB data.
`@NotNull String`	`getFilename()` Database filename
`String`	`getFilePassword()` Password for the encrypted database file
`String`	`getInitScript()` Initialization script run at startup
`long`	`getMaxLengthInplaceLob()` Sets the maximum size of an in-place LOB object.
`long`	`getMaxMemoryRows()` The maximum number of rows in a result set that are kept in-memory.
`boolean`	`isMvccEnabled()`
`H2EmbeddedDataSourceConfig`	`setAllowLiterals(H2EmbeddedDataSourceConfig.AllowLiterals allowLiterals)`
`H2EmbeddedDataSourceConfig`	`setCacheSize(int cacheSize)`
`H2EmbeddedDataSourceConfig`	`setCipher(H2EmbeddedDataSourceConfig.Cipher cipher)`
`H2EmbeddedDataSourceConfig`	`setCompressLob(H2EmbeddedDataSourceConfig.CompressLob compressLob)`
`H2EmbeddedDataSourceConfig`	`setFilename(String filename)`
`H2EmbeddedDataSourceConfig`	`setFilePassword(String filePassword)`
`H2EmbeddedDataSourceConfig`	`setInitScript(String initScript)`
`H2EmbeddedDataSourceConfig`	`setMaxLengthInplaceLob(long maxLengthInplaceLob)`
`H2EmbeddedDataSourceConfig`	`setMaxMemoryRows(long maxMemoryRows)`
`H2EmbeddedDataSourceConfig`	`setMvccEnabled(boolean mvccEnabled)`

Methods inherited from class com.facebook.airlift.dbpool.ManagedDataSourceConfig
getMaxConnections, getMaxConnectionWait, setMaxConnections, setMaxConnectionWait

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

- Constructor Detail
  - H2EmbeddedDataSourceConfig
```
public H2EmbeddedDataSourceConfig()
```
- Method Detail
  - getFilename
```
@NotNull
public @NotNull String getFilename()
```
    Database filename
  - setFilename
```
@Config(value="db.filename")
public H2EmbeddedDataSourceConfig setFilename(String filename)
```
  - getFilePassword
```
public String getFilePassword()
```
    Password for the encrypted database file
  - setFilePassword
```
@Config(value="db.file-password")
public H2EmbeddedDataSourceConfig setFilePassword(String filePassword)
```
  - getInitScript
```
public String getInitScript()
```
    Initialization script run at startup
  - setInitScript
```
@Config(value="db.init-script")
public H2EmbeddedDataSourceConfig setInitScript(String initScript)
```
  - getAllowLiterals
```
public H2EmbeddedDataSourceConfig.AllowLiterals getAllowLiterals()
```
    This setting can help solve the SQL injection problem. By default, text and number literals are allowed in SQL statements. However, this enables SQL injection if the application dynamically builds SQL statements. SQL injection is not possible if user data is set using parameters ('?').
    NONE means literals of any kind are not allowed, only parameters and constants are allowed. NUMBERS mean only numerical and boolean literals are allowed. ALL means all literals are allowed (default).
  - setAllowLiterals
```
@Config(value="db.allow-literals")
public H2EmbeddedDataSourceConfig setAllowLiterals(H2EmbeddedDataSourceConfig.AllowLiterals allowLiterals)
```
  - getCompressLob
```
public H2EmbeddedDataSourceConfig.CompressLob getCompressLob()
```
    Sets the compression algorithm for BLOB and CLOB data. Compression is usually slower, but needs less disk space. LZF is faster but uses more space.
    Allowed values are "NO", "LZF" and "DEFLATE"
  - setCompressLob
```
@Config(value="db.compress-lob")
public H2EmbeddedDataSourceConfig setCompressLob(H2EmbeddedDataSourceConfig.CompressLob compressLob)
```
  - getCipher
```
public H2EmbeddedDataSourceConfig.Cipher getCipher()
```
    Sets the cipher algorithm to encrypt the database file.
  - setCipher
```
@Config(value="db.cipher")
public H2EmbeddedDataSourceConfig setCipher(H2EmbeddedDataSourceConfig.Cipher cipher)
```
  - getCacheSize
```
public int getCacheSize()
```
    Sets the size of the cache in KB (each KB being 1024 bytes) for the current database. The default value is 16384 (16 MB). The value is rounded to the next higher power of two. Depending on the virtual machine, the actual memory required may be higher.
  - setCacheSize
```
@Config(value="db.cache-size")
public H2EmbeddedDataSourceConfig setCacheSize(int cacheSize)
```
  - getMaxLengthInplaceLob
```
public long getMaxLengthInplaceLob()
```
    Sets the maximum size of an in-place LOB object. LOB objects larger that this size are stored in a separate file, otherwise stored directly in the database (in-place). The default max size is 1024. This setting has no effect for in-memory databases.
  - setMaxLengthInplaceLob
```
@Config(value="db.inplace.lob.length.max")
public H2EmbeddedDataSourceConfig setMaxLengthInplaceLob(long maxLengthInplaceLob)
```
  - getMaxMemoryRows
```
public long getMaxMemoryRows()
```
    The maximum number of rows in a result set that are kept in-memory. If more rows are read, then the rows are buffered to disk. The default value is 10000.
  - setMaxMemoryRows
```
@Config(value="db.rows.memory.max")
public H2EmbeddedDataSourceConfig setMaxMemoryRows(long maxMemoryRows)
```
  - isMvccEnabled
```
public boolean isMvccEnabled()
```
  - setMvccEnabled
```
@Config(value="db.mvcc.enabled")
public H2EmbeddedDataSourceConfig setMvccEnabled(boolean mvccEnabled)
```

Class H2EmbeddedDataSourceConfig

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class com.facebook.airlift.dbpool.ManagedDataSourceConfig

Methods inherited from class java.lang.Object

Constructor Detail

H2EmbeddedDataSourceConfig

Method Detail

getFilename

setFilename

getFilePassword

setFilePassword

getInitScript

setInitScript

getAllowLiterals

setAllowLiterals

getCompressLob

setCompressLob

getCipher

setCipher

getCacheSize

setCacheSize

getMaxLengthInplaceLob

setMaxLengthInplaceLob

getMaxMemoryRows

setMaxMemoryRows

isMvccEnabled

setMvccEnabled