Skip to content

Commit 653f511

Browse files
committed
DOC-5663 Added search, probalistic, and timeseries module configuration object links to RS REST API reference for BDB object
1 parent d2828b6 commit 653f511

File tree

1 file changed

+4
-1
lines changed
  • content/operate/rs/references/rest-api/objects/bdb

1 file changed

+4
-1
lines changed

content/operate/rs/references/rest-api/objects/bdb/_index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ An API object that represents a managed database in the cluster.
112112
| memory_size | integer (default: 0); Database memory limit (0 is unlimited), expressed in bytes. |
113113
| metrics_export_all | boolean; Enable/disable exposing all shard metrics through the metrics exporter |
114114
| mkms | boolean (default: true); Are MKMS (Multi Key Multi Slots) commands supported? |
115-
| module_list | {{<code>}}[{<br /> "module_id": string,<br /> "module_args": [<br /> u'string',<br /> u'null'],<br /> "module_name": string,<br /> "semantic_version": string<br />}, ...]{{</code>}} List of modules associated with the database<br /><br />**module_id**: Module UID (deprecated; use `module_name` instead)<br />**module_args**: Module command-line arguments (pattern does not allow special characters &,\<,>,")<br />**module_name**: Module's name<br />**semantic_version**: Module's semantic version (deprecated; use `module_args` instead)<br /><br />**module_id** and **semantic_version** are optional as of Redis Enterprise Software v7.4.2 and deprecated as of v7.8.2. |
115+
| module_list | {{<code>}}[{<br /> "module_id": string,<br /> "module_args": [<br /> u'string',<br /> u'null'],<br /> "module_name": string,<br /> "semantic_version": string<br />}, ...]{{</code>}} List of modules associated with the database<br /><br />**module_id**: Module UID (deprecated; use `module_name` instead)<br />**module_args**: Module command-line arguments (deprecated; use the module objects for [search]({{<relref "/operate/rs/references/rest-api/objects/bdb/search">}}), [timeseries]({{<relref "/operate/rs/references/rest-api/objects/bdb/timeseries">}}), and [probabilistic]({{<relref "/operate/rs/references/rest-api/objects/bdb/probabilistic">}}) instead)<br />**module_name**: Module's name<br />**semantic_version**: Module's semantic version (deprecated; use `module_args` instead)<br /><br />**module_id** and **semantic_version** are optional as of Redis Enterprise Software v7.4.2 and deprecated as of v7.8.2.<br />**module_args** is deprecated as of Redis Enterprise Software v8.0. |
116116
| mtls_allow_outdated_certs | boolean; An optional mTLS relaxation flag for certs verification |
117117
| mtls_allow_weak_hashing | boolean; An optional mTLS relaxation flag for certs verification |
118118
| multi_commands_opt | If set to `batch`, it reduces the overhead of transaction management by batching multiple commands into a single transaction.<br />Values:<br />**disabled**: Turns off the optimization.<br />**batch**: Enables the optimization.<br />**auto**: Uses the [cluster's `multi_commands_opt` setting]({{<relref "/operate/rs/references/rest-api/objects/cluster">}}). |
@@ -122,6 +122,7 @@ An API object that represents a managed database in the cluster.
122122
| <span class="break-all">oss_cluster_api_preferred_ip_type</span> | Internal/external IP type in OSS cluster API. Default value for new endpoints<br />Values:<br />**'internal'** <br />'external' |
123123
| oss_sharding | boolean (default:&nbsp;false); An alternative to `shard_key_regex` for using the common case of the OSS shard hashing policy |
124124
| port | integer; TCP port on which the database is available. Generated automatically if omitted and returned as 0 |
125+
| probabilistic | [complex object]({{< relref "/operate/rs/references/rest-api/objects/bdb/probabilistic" >}}); Configuration fields for probabilistic data structures. |
125126
| proxy_policy | The default policy used for proxy binding to endpoints<br />Values:<br />'single'<br />'all-master-shards'<br />'all-nodes' |
126127
| rack_aware | boolean (default:&nbsp;false); Require the database to always replicate across multiple racks |
127128
| recovery_wait_time | integer (default:&nbsp;-1); Defines how many seconds to wait for the persistence file to become available during auto recovery. After the wait time expires, auto recovery completes with potential data loss. The default `-1` means to wait forever. |
@@ -137,6 +138,7 @@ An API object that represents a managed database in the cluster.
137138
| resp3 | boolean (default:&nbsp;true); Enables or deactivates RESP3 support |
138139
| roles_permissions | {{<code>}}[{<br /> "role_uid": integer,<br /> "redis_acl_uid": integer<br />}, ...]{{</code>}} |
139140
| sched_policy | Controls how server-side connections are used when forwarding traffic to shards.<br />Values:<br />**cmp**: Closest to max_pipelined policy. Pick the connection with the most pipelined commands that has not reached the max_pipelined limit.<br />**mru**: Try to use most recently used connections.<br />**spread**: Try to use all connections.<br />**mnp**: Minimal pipeline policy. Pick the connection with the least pipelined commands. |
141+
| search | [complex object]({{< relref "/operate/rs/references/rest-api/objects/bdb/search" >}}); Configuration fields for search and query. |
140142
| shard_block_crossslot_keys | boolean (default:&nbsp;false); In Lua scripts, prevent use of keys from different hash slots within the range owned by the current shard |
141143
| shard_block_foreign_keys | boolean (default:&nbsp;true); In Lua scripts, `foreign_keys` prevent use of keys which could reside in a different shard (foreign keys) |
142144
| shard_key_regex | Custom keyname-based sharding rules.<br />`[{"regex": string}, ...]`<br />To use the default rules you should set the value to: <br />`[{"regex": ".*\\{(?<tag>.*)\\}.*"}, {"regex": "(?<tag>.*)"}]` |
@@ -158,6 +160,7 @@ An API object that represents a managed database in the cluster.
158160
| syncer_log_level | Minimum syncer log level to log. Only logs with this level or higher will be logged.<br />Values:<br />‘crit’<br />‘error’<br />‘warn’<br />**‘info’**<br />‘trace’<br />‘debug’ |
159161
| syncer_mode | The syncer for replication between database instances is either on a single node (centralized) or on each node that has a proxy according to the proxy policy (distributed). (read-only)<br />Values:<br />'distributed'<br />'centralized' |
160162
| tags | {{<code>}}[{<br /> "key": string,<br /> "value": string<br />}, ...]{{</code>}} Optional list of tag objects attached to the database. Each tag requires a key-value pair.<br />**key**: Represents the tag's meaning and must be unique among tags (pattern does not allow special characters &,\<,>,")<br />**value**: The tag's value.|
163+
| timeseries | [complex object]({{< relref "/operate/rs/references/rest-api/objects/bdb/timeseries" >}}); Configuration fields for timeseries. |
161164
| tls_mode | Require TLS-authenticated and encrypted connections to the database<br />Values:<br />'enabled'<br /> **'disabled'** <br />'replica_ssl' |
162165
| tracking_table_max_keys | integer; The client-side caching invalidation table size. 0 makes the cache unlimited. |
163166
| type | Type of database<br />Values:<br />**'redis'** <br />'memcached' |

0 commit comments

Comments
 (0)