Skip to content

Commit

Permalink
doc: Reviewed RandomUuid transformer
Browse files Browse the repository at this point in the history
  • Loading branch information
wwoytenko committed May 15, 2024
1 parent e0ff104 commit febd114
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions docs/built_in_transformers/standard_transformers/random_uuid.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,19 @@ Generate random unique user ID using version 4.

## Parameters

| Name | Description | Default | Required | Supported DB types |
|-----------|------------------------------------------------------------------------------|---------|----------|---------------------|
| column | The name of the column to be affected | | Yes | text, varchar, uuid |
| keep_null | Indicates whether NULL values should be replaced with transformed values or not | `true` | No | - |
| Name | Description | Default | Required | Supported DB types |
|-----------|-------------------------------------------------------------------------------------------------|----------|----------|---------------------|
| column | The name of the column to be affected | | Yes | text, varchar, uuid |
| keep_null | Indicates whether NULL values should be replaced with transformed values or not | `true` | No | - |
| engine | The engine used for generating the values [random, hash]. Use hash for deterministic generation | `random` | No | - |

## Description

The `RandomUuid` transformer generates a random UUID. The behaviour for NULL values can be configured using the `keep_null` parameter.
The `RandomUuid` transformer generates a random UUID. The behaviour for NULL values can be configured using
the `keep_null` parameter.

The `engine` parameter allows you to choose between random and hash engines for generating values. Read more about the
engines in the [Transformation engines](../transformation_engines.md) section.

## Example: Updating the `rowguid` column

Expand All @@ -25,7 +30,7 @@ The following example replaces original UUID values of the `rowguid` column to r
keep_null: false
```

```bash title="Expected result"
```title="Expected result"
| column name | original value | transformed |
|-------------|--------------------------------------|--------------------------------------|
Expand Down

0 comments on commit febd114

Please sign in to comment.