# HStore Mask

This is a [composite generator](https://docs.tonic.ai/app/generation/generators/generator-types/generators-composite).

Runs selected generators on specified key values in an HStore column in a PostgreSQL database. HStore columns contain a set of key-value pairs.

## Characteristics <a href="#hstore-mask-characteristics" id="hstore-mask-characteristics"></a>

<table data-header-hidden><thead><tr><th valign="top"></th><th valign="top"></th></tr></thead><tbody><tr><td valign="top"><strong>Consistency</strong></td><td valign="top">Determined by the selected sub-generators.</td></tr><tr><td valign="top"><strong>Linking</strong></td><td valign="top">Determined by the selected sub-generators.</td></tr><tr><td valign="top"><strong>Differential privacy</strong></td><td valign="top">Determined by the selected sub-generators.</td></tr><tr><td valign="top"><strong>Data-free</strong></td><td valign="top">Determined by the selected sub-generators.</td></tr><tr><td valign="top"><strong>Allowed for primary keys</strong></td><td valign="top">No</td></tr><tr><td valign="top"><strong>Allowed for unique columns</strong></td><td valign="top">No</td></tr><tr><td valign="top"><strong>Uses format-preserving encryption (FPE)</strong></td><td valign="top">No</td></tr><tr><td valign="top"><strong>Privacy ranking</strong></td><td valign="top">5</td></tr><tr><td valign="top"><strong>Generator ID (for the API)</strong></td><td valign="top"><a href="../../../api/quick-start-guide/tonic-api-generator-assignment/generator-api-reference/generator-api-ref-hstore-mask"><code>HStoreMaskGenerator</code></a></td></tr></tbody></table>

## How to configure <a href="#hstore-mask-configure" id="hstore-mask-configure"></a>

### Adding a sub-generator <a href="#hstore-mask-add-subgenerator" id="hstore-mask-add-subgenerator"></a>

To assign a generator to a key:

1. Under **Sub-generators**, click **Add Generator**.\
   \
   On the sub-generator configuration panel, the **Cell HStore** field contains a sample value from the source database. You can use the previous and next icons to page through different values.
2. Under **Enter a key**, enter the name of a key from the column value.\
   \
   For example, for the column value:\
   \
   &#x20;`"pages"=>"446", "title"=>"The Iliad", "category"=>"mythology"`\
   \
   To apply a generator to the title, you would enter `title` as the key.\
   \
   **Matched HStore Values** shows the result from the value in **Cell HStore**.
3. From the **Generator Configuration** dropdown list, select the generator to apply to the key value.\
   \
   You cannot select another composite generator.
4. Configure the selected generator.\
   \
   You cannot configure the selected generator to be consistent with another column.
5. To save the configuration and immediately add a generator for another key, click **Save and Add Another**.\
   \
   To save the configuration and close the add generator panel, click **Save**.

### Managing the sub-generators list <a href="#hstore-mask-manage-sub-generators" id="hstore-mask-manage-sub-generators"></a>

From the **Sub-Generators** list:

* To edit a generator assignment, click the edit icon.
* To remove a generator assignment, click the delete icon.
* To move a generator assignment up or down in the list, click the up or down arrow.
