Skip to content
This repository has been archived by the owner on Nov 14, 2024. It is now read-only.

Commit

Permalink
[TTT] [no release notes] Document behaviour regarding index rows (#2658)
Browse files Browse the repository at this point in the history
* [no release notes] Document behaviour regarding index rows

* fix compile bug

* ``List``
  • Loading branch information
jeremyk-91 authored Nov 13, 2017
1 parent a953328 commit 8fdd50b
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/source/schemas/tables_and_indices.rst
Original file line number Diff line number Diff line change
Expand Up @@ -495,6 +495,17 @@ succeeded by a ``partitioner()`` call, in the exact same manner as for
table rows. For more information, see the Partitioners subsection of
Table Rows.

.. note::

Internally, index rows are stored including a reference to the source column,
but this is stripped out in the generated code before being returned to the user.
Thus, if one uses a ``List`` of results returned from an index table (e.g. through ``getRowColumns``,
one may encounter multiple values that appear to be the same). The standard workaround is to use
a ``Set`` to deduplicate the results.

Please see discussion on `issue 604 <https://github.com/palantir/atlasdb/issues/604>`__ for more details
regarding this behaviour.

Constraints
-----------

Expand Down

0 comments on commit 8fdd50b

Please sign in to comment.