Module metadata object
An object that represents Redis module metadata
Redis Enterprise Software |
---|
Represents a Redis module.
Name | Type/Value | Description |
---|---|---|
uid | string | Cluster unique ID of module |
architecture | string | Module was compiled under this architecture |
author | string | Module creator |
bigstore_version_2_support | boolean (default: false) | Whether the module supports bigstore_version_2 capability, bypassing capability validation (optional) |
capabilities | array of strings | List of capabilities supported by this module |
capability_name | string | Short description of module functionality |
command_line_args | string | Command-line arguments passed to the module |
compatible_redis_version | string | Redis version required by this module |
config_command | string | Name of command to configure module arguments at runtime |
crdb | CRDB object | CRDB-related information about the module CRDB object fields: name: string supported_featureset_versions: array of integers |
dependencies | dependencies object | Module dependencies |
description | string | Short description of the module |
display_name | string | Name of module for display purposes |
string | Author's email address | |
homepage | string | Module's homepage |
license | string | Module is distributed under this license |
min_redis_pack_version | string | Minimum Redis Enterprise Software cluster version required by this module |
min_redis_version | string | Minimum Redis database version required by this module. Only relevant for Redis databases earlier than v7.4. |
module_file | string | Module filename |
module_name | string | Module's name |
semantic_version | string | Module's semantic version |
sha256 | string | SHA256 of module binary |
version | integer | Module's version |