= Cheatsheets

[[BitFieldGetCommand]]
== BitFieldGetCommand


[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[offset]]`@offset`|`Number (long)`|-
|[[type]]`@type`|`String`|-
|===

[[BitFieldIncrbyCommand]]
== BitFieldIncrbyCommand


[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[increment]]`@increment`|`Number (long)`|-
|[[offset]]`@offset`|`Number (long)`|-
|[[type]]`@type`|`String`|-
|===

[[BitFieldOptions]]
== BitFieldOptions


[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[get]]`@get`|`link:dataobjects.html#BitFieldGetCommand[BitFieldGetCommand]`|-
|[[incrby]]`@incrby`|`link:dataobjects.html#BitFieldIncrbyCommand[BitFieldIncrbyCommand]`|-
|[[set]]`@set`|`link:dataobjects.html#BitFieldSetCommand[BitFieldSetCommand]`|-
|===

[[BitFieldSetCommand]]
== BitFieldSetCommand


[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[offset]]`@offset`|`Number (long)`|-
|[[type]]`@type`|`String`|-
|[[value]]`@value`|`Number (long)`|-
|===

[[GeoMember]]
== GeoMember

++++
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[latitude]]`@latitude`|`Number (Double)`|+++
Set Latitude as per EPSG:900913 / EPSG:3785 / OSGEO:41001
+++
|[[longitude]]`@longitude`|`Number (Double)`|+++
Set Longitude as per EPSG:900913 / EPSG:3785 / OSGEO:41001
+++
|[[member]]`@member`|`String`|+++
Set the member name.
+++
|===

[[GeoRadiusOptions]]
== GeoRadiusOptions

++++
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[count]]`@count`|`Number (Long)`|+++
Set the radius options limit the result count.
+++
|[[withCoord]]`@withCoord`|`Boolean`|+++
Set the radius options to be coordinate based.
+++
|[[withDist]]`@withDist`|`Boolean`|+++
Set the radius options to be distance based.
+++
|[[withHash]]`@withHash`|`Boolean`|+++
Set the radius options to be hash based.
+++
|===

[[KillFilter]]
== KillFilter

++++
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[addr]]`@addr`|`String`|+++
Set ADDR filter
+++
|[[id]]`@id`|`String`|+++
Set ID filter
+++
|[[skipme]]`@skipme`|`Boolean`|+++
Set SKIPME filter
+++
|[[type]]`@type`|`link:enums.html#Type[Type]`|+++
Set TYPE filter
+++
|===

[[LimitOptions]]
== LimitOptions

++++
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[count]]`@count`|`Number (Long)`|-
|[[offset]]`@offset`|`Number (Long)`|-
|===

[[MigrateOptions]]
== MigrateOptions

++++
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[copy]]`@copy`|`Boolean`|-
|[[replace]]`@replace`|`Boolean`|-
|===

[[RangeLimitOptions]]
== RangeLimitOptions

++++
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[count]]`@count`|`Number (Long)`|-
|[[offset]]`@offset`|`Number (Long)`|-
|[[withscores]]`@withscores`|`Boolean`|-
|===

[[RedisOptions]]
== RedisOptions

++++
This object controls the connection setting to the Redis Server. There is no need to specify most of the settings
since it has built the following sensible defaults:
<p>
* `encoding`: `UTF-8`
* `host`: `localhost`
* `port`: 6379
* `tcpKeepAlive`: true
* `tcpNoDelay`: true
* `binary`: false
<p>
However there are two extra properties that have no defaults since they are optional:
<p>
* `auth`
* `select`
<p>
The usage of this two extra properties is to setup required authentication and optionally the selection of the active
database at connection time. If you define this extra properties on every connection to Redis server this client
will perform the authentication handshake and database selection, however if you don't do this and call link
yourself in case of connection failure the client will not be able to perform the correct authentication handshake.
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[address]]`@address`|`String`|+++
Set the eventbus address prefix for `PUB/SUB`.
* @param address address prefix.
+++
|[[auth]]`@auth`|`String`|+++
Set the password for authentication at connection time.
+++
|[[binary]]`@binary`|`Boolean`|+++
Set the messages to/from redis as binary, default `false`.
* @param binary use binary messages
+++
|[[connectTimeout]]`@connectTimeout`|`Number (int)`|-
|[[crlPaths]]`@crlPaths`|`Array of String`|-
|[[crlValues]]`@crlValues`|`Array of Buffer`|-
|[[domainSocket]]`@domainSocket`|`Boolean`|+++
Set the domain socket enabled option, default `false`.
+++
|[[domainSocketAddress]]`@domainSocketAddress`|`String`|+++
Set the domain socket address where the Redis server is listening.
+++
|[[enabledCipherSuites]]`@enabledCipherSuites`|`Array of String`|-
|[[enabledSecureTransportProtocols]]`@enabledSecureTransportProtocols`|`Array of String`|-
|[[encoding]]`@encoding`|`String`|+++
Set the user defined character encoding, e.g.: `iso-8859-1`.
* @param encoding the user character encoding
+++
|[[host]]`@host`|`String`|+++
Set the host name where the Redis server is listening.
* @param host host name
+++
|[[hostnameVerificationAlgorithm]]`@hostnameVerificationAlgorithm`|`String`|-
|[[idleTimeout]]`@idleTimeout`|`Number (int)`|-
|[[idleTimeoutUnit]]`@idleTimeoutUnit`|`link:enums.html#TimeUnit[TimeUnit]`|-
|[[jdkSslEngineOptions]]`@jdkSslEngineOptions`|`link:dataobjects.html#JdkSSLEngineOptions[JdkSSLEngineOptions]`|-
|[[keyStoreOptions]]`@keyStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|-
|[[localAddress]]`@localAddress`|`String`|-
|[[logActivity]]`@logActivity`|`Boolean`|-
|[[masterName]]`@masterName`|`String`|+++
Set name of Redis master (used with Sentinel).
+++
|[[metricsName]]`@metricsName`|`String`|-
|[[openSslEngineOptions]]`@openSslEngineOptions`|`link:dataobjects.html#OpenSSLEngineOptions[OpenSSLEngineOptions]`|-
|[[pemKeyCertOptions]]`@pemKeyCertOptions`|`link:dataobjects.html#PemKeyCertOptions[PemKeyCertOptions]`|-
|[[pemTrustOptions]]`@pemTrustOptions`|`link:dataobjects.html#PemTrustOptions[PemTrustOptions]`|-
|[[pfxKeyCertOptions]]`@pfxKeyCertOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|-
|[[pfxTrustOptions]]`@pfxTrustOptions`|`link:dataobjects.html#PfxOptions[PfxOptions]`|-
|[[port]]`@port`|`Number (int)`|+++
Set the tcp port where the Redis server is listening.
+++
|[[proxyOptions]]`@proxyOptions`|`link:dataobjects.html#ProxyOptions[ProxyOptions]`|-
|[[receiveBufferSize]]`@receiveBufferSize`|`Number (int)`|-
|[[reconnectAttempts]]`@reconnectAttempts`|`Number (int)`|-
|[[reconnectInterval]]`@reconnectInterval`|`Number (long)`|-
|[[reuseAddress]]`@reuseAddress`|`Boolean`|-
|[[reusePort]]`@reusePort`|`Boolean`|-
|[[select]]`@select`|`Number (Integer)`|+++
Set the database to select at connection time.
* @param select database id
+++
|[[sendBufferSize]]`@sendBufferSize`|`Number (int)`|-
|[[sentinels]]`@sentinels`|`Array of String`|+++
Set the list of Sentinels.
+++
|[[soLinger]]`@soLinger`|`Number (int)`|-
|[[ssl]]`@ssl`|`Boolean`|-
|[[tcpCork]]`@tcpCork`|`Boolean`|-
|[[tcpFastOpen]]`@tcpFastOpen`|`Boolean`|-
|[[tcpKeepAlive]]`@tcpKeepAlive`|`Boolean`|-
|[[tcpNoDelay]]`@tcpNoDelay`|`Boolean`|-
|[[tcpQuickAck]]`@tcpQuickAck`|`Boolean`|-
|[[trafficClass]]`@trafficClass`|`Number (int)`|-
|[[trustAll]]`@trustAll`|`Boolean`|-
|[[trustStoreOptions]]`@trustStoreOptions`|`link:dataobjects.html#JksOptions[JksOptions]`|-
|[[useAlpn]]`@useAlpn`|`Boolean`|-
|[[usePooledBuffers]]`@usePooledBuffers`|`Boolean`|-
|===

[[ScanOptions]]
== ScanOptions

++++
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[count]]`@count`|`Number (int)`|-
|[[match]]`@match`|`String`|-
|===

[[SetOptions]]
== SetOptions

++++
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[ex]]`@ex`|`Number (long)`|-
|[[nx]]`@nx`|`Boolean`|-
|[[px]]`@px`|`Number (long)`|-
|[[xx]]`@xx`|`Boolean`|-
|===

[[SortOptions]]
== SortOptions

++++
++++
'''

[cols=">25%,25%,50%"]
[frame="topbot"]
|===
^|Name | Type ^| Description
|[[alpha]]`@alpha`|`Boolean`|-
|[[by]]`@by`|`String`|-
|[[descending]]`@descending`|`Boolean`|-
|[[gets]]`@gets`|`Array of String`|-
|[[store]]`@store`|`String`|-
|===