Name | Description | |
---|---|---|
![]() | authMode |
Authentication mode used when user/password is defined.
Default: INTERNAL |
![]() | batchPolicyDefault |
Default batch policy that is used when batch command's policy is null.
|
![]() | clusterName |
Expected cluster name. If populated, server nodes must return this cluster name in order to
join the client's view of the cluster. Should only be set when connecting to servers that
support the "cluster-name" info command.
|
![]() | connPoolsPerNode |
Number of synchronous connection pools used for each node. Machines with 8 cpu cores or
less usually need just one connection pool per node. Machines with a large number of cpu
cores may have their synchronous performance limited by contention for pooled connections.
Contention for pooled connections can be reduced by creating multiple mini connection pools
per node.
Default: 1 |
![]() | failIfNotConnected |
Throw exception if all seed connections fail on cluster instantiation. Default: true
|
![]() | infoPolicyDefault |
Default info policy that is used when info command's policy is null.
|
![]() | ipMap |
A IP translation table is used in cases where different clients use different server
IP addresses. This may be necessary when using clients from both inside and outside
a local area network. Default is no translation.
The key is the IP address returned from friend info requests to other servers. The value is the real IP address used to connect to the server. |
![]() | loginTimeout |
Login timeout in milliseconds. The timeout used when user authentication is enabled and
a node login is being performed.
Default: 5000ms |
![]() | maxConnsPerNode |
Maximum number of connections allowed per server node. Synchronous transactions
will go through retry logic and potentially fail with "ResultCode.NO_MORE_CONNECTIONS"
if the maximum number of connections would be exceeded.
The number of connections used per node depends on how many concurrent threads issue database commands plus sub-threads used for parallel multi-node commands (batch, scan, and query). One connection will be used for each thread. This field is ignored by asynchronous transactions since these transactions are already bound by asyncMaxCommands by default. Each async command has a one-to-one relationship with connections. Default: 300 |
![]() | maxSocketIdle |
Maximum socket idle in seconds. Socket connection pools will discard sockets
that have been idle longer than the maximum. The value is limited to 24 hours (86400).
It's important to set this value to a few seconds less than the server's proto-fd-idle-ms (default 60000 milliseconds or 1 minute), so the client does not attempt to use a socket that has already been reaped by the server. Default: 55 seconds |
![]() | password |
Password authentication to cluster. The password will be stored by the client and sent to server
in hashed format. Leave null for clusters running without restricted access.
|
![]() | queryPolicyDefault |
Default query policy that is used when query command's policy is null.
|
![]() | rackAware |
Track server rack data. This field is useful when directing read commands to the server node
that contains the key and exists on the same rack as the client. This serves to lower cloud
provider costs when nodes are distributed across different racks/data centers.
rackId, PREFER_RACK and server rack configuration must also be set to enable this functionality. Default: false |
![]() | rackId |
Rack where this client instance resides.
rackAware, PREFER_RACK and server rack configuration must also be set to enable this functionality. Default: 0 |
![]() | readPolicyDefault |
Default read policy that is used when read command's policy is null.
|
![]() | scanPolicyDefault |
Default scan policy that is used when scan command's policy is null.
|
![]() | tendInterval |
Interval in milliseconds between cluster tends by maintenance thread. Default: 1 second
|
![]() | timeout |
Initial host connection timeout in milliseconds. The timeout when opening a connection
to the server host for the first time.
Default: 1000ms |
![]() | tlsPolicy |
Secure connection policy for servers that require TLS connections.
Secure connections are only supported for AerospikeClient synchronous commands.
Secure connections are not supported for asynchronous commands because AsyncClient uses the best performing SocketAsyncEventArgs. Unfortunately, SocketAsyncEventArgs is not supported by the provided SslStream. Default: null (Use normal sockets) |
![]() | user |
User authentication to cluster. Leave null for clusters running without restricted access.
|
![]() | useServicesAlternate |
Should use "services-alternate" instead of "services" in info request during cluster
tending. "services-alternate" returns server configured external IP addresses that client
uses to talk to nodes. "services-alternate" can be used in place of providing a client "ipMap".
Default: false (use original "services" info request).
"services-alternate" is available with Aerospike Server versions >= 3.7.1. |
![]() | writePolicyDefault |
Default write policy that is used when write command's policy is null.
|