Skip to main content

Parameter Configuration

ParameterAccepted values / typeDefaultDescription and constraints
databaseStringSDK default databaseDefault database; the URL path takes precedence. Changing catalog/schema to another database after connection is unsupported.
tokenStringUnsetWhen nonblank, takes precedence over user/password.
user, passwordStringUnsetWithout token, both must be nonblank to be passed to the SDK.
securetrue / falsefalse; enabled by TLS optionstrue/false. Plaintext by default; certificate or serverName settings enable TLS automatically. Explicit false conflicts with TLS settings and fails; there is no plaintext fallback.
caPemPath, serverPemPathStringUnsetPEM trust certificates, mutually exclusive. caPemPath accepts a private CA/bundle; serverPemPath accepts a server certificate or CA bundle for one-way TLS. Omit both to use default system trust.
clientPemPath, clientKeyPathStringUnsetPEM client certificate chain and unencrypted private key (PKCS#8 recommended) for mutual TLS. Supply both together with caPemPath.
serverNameStringJDBC hostnameExpected TLS server name, defaulting to the JDBC host. An override must be a DNS name with caPemPath or serverPemPath (SDK 2.6.22 requirement). Both SDK and HTTPS verify this identity; verification is not disabled.
consistencyLevelStrong / Bounded / Session / EventuallySDK / collection defaultQuery consistency. QueryIterator uses collection-default consistency rather than this override; see consistency controls.
connectTimeoutInteger (milliseconds)SDK defaultSDK connection timeout in milliseconds; positive values override SDK defaults. Also used for Import HTTP connections.
rpcDeadlineInteger (milliseconds)SDK defaultPer-RPC deadline in milliseconds; positive values override SDK defaults. Also participates in Import HTTP timeouts.
keepAliveTimeInteger (milliseconds)SDK defaultInterval between keep-alive calls. Positive values override the SDK default.
keepAliveTimeoutInteger (milliseconds)SDK defaultTimeout waiting for a keep-alive response. Positive values override the SDK default.
idleTimeoutInteger (milliseconds)SDK defaultConnection idle timeout. Positive values override the SDK default.
keepAliveWithoutCallstrue / falseSDK defaultWhether to send keep-alive without calls: true/false.
maxRetryInteger3Default 3; maximum retries after the first failed write, 0 disables retries. Currently covers paged UPDATE partial upserts and DELETE writes.
customMilvusFully qualified class nameUnsetFactory implementing CustomMilvus; the JDBC connection closes the returned client. See custom client setup.
interceptorFully qualified class nameUnsetFull InvocationHandler class name with an instantiable no-argument constructor. Receives V2 SDK methods and must return SDK responses or delegate the call.
adapterNamemilvusFrom JDBC URLAdapter identifier supplied by the URL.
serverhost[:port]From JDBC URL; port 19530One endpoint per connection; IPv6 addresses are unsupported.
timeZoneTime-zone ID or offset, e.g. UTC, +08:00UTCCommon-driver property, not a Milvus server time-zone setting.