Skip to content

Commit e1efad9

Browse files
authored
Document searching for tuples on the Tuples tab in TCM (#5554)
Fixes #5337
1 parent 62ee1f0 commit e1efad9

File tree

2 files changed

+55
-0
lines changed

2 files changed

+55
-0
lines changed
218 KB
Loading

doc/tooling/tcm/tcm_ui_overview.rst

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -348,6 +348,61 @@ On this page, you can:
348348

349349
- view the list of user spaces, their size, and engines
350350
- view and edit tuples stored in user spaces
351+
- search for tuples by entering *search condition* in the **Search** bar
352+
353+
Search by condition
354+
^^^^^^^^^^^^^^^^^^^
355+
356+
TCM supports the following comparison operators:
357+
358+
- ``==`` -- equal to
359+
- ``>`` -- greater than
360+
- ``<`` -- less than
361+
- ``>=`` -- greater than or equal to
362+
- ``<=`` -- less than or equal to
363+
364+
Search condition has the following structure:
365+
366+
.. code-block:: text
367+
368+
index_name comparator value
369+
370+
where:
371+
372+
- ``index_name`` -- the name of the index. This is the left-hand side of the expression.
373+
- ``comparator`` -- a comparison operator (``>``, ``>=``, ``==``, ``<=``, ``<``). It must be separated by spaces on both sides of the expression.
374+
- ``value`` -- a string, numeric, or boolean value. This is the right-hand side of the expression.
375+
String values must be enclosed in double quotes (``""``).
376+
377+
.. note::
378+
379+
TCM does not support plain text search. For example, to search for customers named Ivan in a
380+
space, use the index name and a comparison operator to specify the expression:
381+
382+
- correct: typing ``name == "Ivan"`` in the **Search** bar
383+
- incorrect: typing ``Ivan`` in the **Search** bar
384+
385+
**Examples**
386+
387+
The search expression below returns tuples with IDs greater than 9990:
388+
389+
.. code-block:: text
390+
391+
id > 9990
392+
393+
In TCM, the result might look as follows:
394+
395+
.. image:: _images/tcm_ui_search_bar.png
396+
:align: left
397+
:width: 700
398+
:alt: TCM Tuples page
399+
400+
In the example below, the search returns tuples with the ``name`` index equal to ``Ivan``:
401+
402+
.. code-block:: text
403+
404+
name == "Ivan"
405+
351406
352407
.. _tcm_ui_cluster_tcf:
353408

0 commit comments

Comments
 (0)