{{ partial "docs-nav.html" . }} {{ partial "breadcrumbs" . }}

{{- .Title }} {{- if (and (isset .Params "doc_flags") (in .Params.doc_flags "deprecated")) }} Deprecated {{- end }}

{{ if (isset .Params "deprecated_since") }}

As of {{ $component }} version {{ .Params.deprecated_since }}, this command is regarded as deprecated.

{{- if (isset .Params "replaced_by") }}

It can be replaced by {{ .Params.replaced_by | markdownify }} when migrating or writing new code.

{{- end }} {{ end }} {{ if .Params.bannerText }} {{ partial "banner-article.html" . }} {{ end }} {{ $syntax := .Params.syntax_fmt }} {{ if isset .Params "syntax" }} {{ if .Params.syntax }} {{ $syntax = .Params.syntax }} {{ else }} {{ $syntax = "" }} {{ end }} {{ end }} {{ if (gt (len $syntax) 0) }} {{ $railroad_path := printf "images/railroad/%s.svg" (.Title | lower | replaceRE " " "-") }} {{ $railroad_file_path := printf "static/%s" $railroad_path }} {{ if fileExists $railroad_file_path }} {{/* Build API methods tab content */}} {{ $apiMethodsContent := partial "components/api-methods-tab.html" (dict "commandName" .Title) }} {{ $tabs := slice (dict "title" "Syntax text" "content" (printf "

%s

" ($syntax | htmlEscape | replaceRE "\\_" " " | safeHTML))) (dict "title" "Syntax diagram" "content" (printf " " ($railroad_path | relURL) .Title)) (dict "title" "API methods" "content" $apiMethodsContent) }} {{ partial "components/generic-tabs.html" (dict "id" "syntax-tabs" "tabs" $tabs) }} {{ else }} Syntax

{{- $syntax | htmlEscape | replaceRE "\\\\_" " " | safeHTML -}}

{{ end }} {{ end }} {{ if not $isModule }} Available since:Redis Open Source {{ .Params.since }} {{ else }} Available in: Redis Open Source / {{ .Params.module }} {{ .Params.since }} {{ end }} Time complexity:{{ replace .Params.complexity "*" "\*" | markdownify }} {{ if .Params.acl_categories }} ACL categories: {{ range .Params.acl_categories }} {{ printf "%s," . | markdownify }} {{ end}} {{ end }} {{ if (findRE "## Redis Software and Redis Cloud compatibility" .RawContent) }} Compatibility:Redis Software and Redis Cloud compatibility {{ end }} {{ .Content }} {{ if isset .Params "history" }}

History

{{ range .Params.history }} - Starting with Redis version {{ index . 0 }}: {{ index . 1 | markdownify }} {{ end }} {{ end }} {{ partial "feedback.html" . }} {{ partial "scripts.html" . }}