ContextQMD
Back to Redis

FT.TAGVALS

content/commands/ft.tagvals.md

latest2.4 KB
Original Source

Return a distinct set of values indexed in a Tag field

Examples

Required arguments

<details open> <summary><code>index</code></summary>

is full-text index name. You must first create the index using [FT.CREATE]({{< relref "commands/ft.create/" >}}).

</details> <details open> <summary><code>field_name</code></summary>

is name of a Tag file defined in the schema.

</details>

Use FT.TAGVALS if your tag indexes things like cities, categories, and so on.

Limitations

FT.TAGVALS provides no paging or sorting, and the tags are not alphabetically sorted. FT.TAGVALS only operates on [tag fields]({{< relref "/develop/ai/search-and-query/advanced-concepts/tags" >}}). The returned strings are lowercase with whitespaces removed, but otherwise unchanged.

Examples

<details open> <summary><b>Return a set of values indexed in a Tag field</b></summary>

{{< highlight bash >}} 127.0.0.1:6379> FT.TAGVALS idx myTag

  1. "Hello"
  2. "World" {{< / highlight >}}
</details>

Redis Software and Redis Cloud compatibility

| Redis Software | Redis Cloud Flexible & Annual | Redis Cloud Free & Fixed | <span style="min-width: 9em; display: table-cell">Notes</span> | |:----------------------|:-----------------|:-----------------|:------| | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</span> | <span title="Supported">✅ Supported</nobr></span> | |

Return information

{{< multitabs id="ft-tagvals-return-info" tab1="RESP2" tab2="RESP3" >}}

One of the following:

  • [Array]({{< relref "/develop/reference/protocol-spec#arrays" >}}) of distinct tag values as [bulk strings]({{< relref "/develop/reference/protocol-spec#bulk-strings" >}}).
  • [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: no such index, not a tag field.

-tab-sep-

One of the following:

  • [Set]({{< relref "/develop/reference/protocol-spec#sets" >}}) of distinct tag values as [bulk strings]({{< relref "/develop/reference/protocol-spec#bulk-strings" >}}).
  • [Simple error reply]({{< relref "/develop/reference/protocol-spec#simple-errors" >}}) in these cases: no such index, not a tag field.

{{< /multitabs >}}

See also

[FT.CREATE]({{< relref "commands/ft.create/" >}})

  • [Tag fields]({{< relref "/develop/ai/search-and-query/advanced-concepts/tags" >}})
  • [RediSearch]({{< relref "/develop/ai/search-and-query/" >}})