Skip to main content

Parameter Configuration

ParameterAccepted values / typeDefaultDescription and constraints
serverhost[:port][;host[:port]...]From URLHost segment from the JDBC URL. Supports host:port or host1:port;host2:port.
user / usernameStringNoneUsername for authentication. user takes precedence over username.
passwordStringEmptyPassword for authentication.
connectTimeoutInteger (milliseconds)Driver defaultConnection timeout (ms).
socketTimeoutInteger (milliseconds)Driver defaultSocket read timeout (ms).
timeZoneTime-zone ID or offset, e.g. UTC, +08:00UTCDriver time zone used for type conversion (for example +08:00).
indexRefreshtrue / falsefalseAppend refresh=true for write operations.
preReadtrue / falsetrueEnable pre-read mode. Expands document fields while retaining raw-document columns. Disabled mode returns dedicated raw-document columns.
preReadThresholdSize with B / KB / MB / GB suffix5MBPre-read threshold size. Accepts B/KB/MB/GB. Defaults to MB when no unit is supplied.
preReadMaxFileSizeSize with B / KB / MB / GB suffix20MBMaximum pre-read file size. Accepts B/KB/MB/GB. Defaults to MB when no unit is supplied.
preReadCacheDirDirectory pathjava.io.tmpdirCache directory for pre-read mode.
customElasticFully qualified class nameNoneFully qualified class name implementing CustomElastic.
adapterNameelasticFrom JDBC URLAdapter identifier supplied by the JDBC URL.