Skip to content

Commit

Permalink
#24 - README update
Browse files Browse the repository at this point in the history
  • Loading branch information
michalbiarda committed Jun 30, 2022
1 parent 47edc7f commit 0aa1c25
Showing 1 changed file with 10 additions and 13 deletions.
23 changes: 10 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,11 +87,15 @@ To tag an export with an issue number (or whatever is desired):

Connection information goes into a folder named `.driver`. The files that are recognized
inside these folders are:
* `pipelines.yaml`
* `anonymize.yaml`
* `commands.yaml`
* `engines.yaml`
* `connections.yaml`
* `config.yaml`
* `connections.yaml`
* `engines.yaml`
* `environments.yaml`
* `pipelines.yaml`
* `reduce.yaml`
* `update_values.yaml`

The filenames of these files serve no purpose other than a namespace. The delineation of the configuration
happens inside each file. For example, in `pipelines.yaml`, there is a `pipelines` node as the root element.
Expand Down Expand Up @@ -322,24 +326,19 @@ environments:

### Anonymizing Data

Tables can be anonyimized by creating `anonymize.yaml` in `.driver/`. The following type of anonymization entities are available in order to provide realistic data and types:
Tables can be anonymized by creating `anonymize.yaml` in `.driver/`. The following type of anonymization entities
are available in order to provide realistic data and types:

* `email`
* `company`
* `firstname`
* `lastname`
* `full_name`
* `general`
* `phone`
* `postcode`
* `street`
* `address`
* `city`
* `region_id`
* `region`
* `country_id`
* `phone`
* `ip`
* `general`
* `empty`

**Example File**
Expand All @@ -349,8 +348,6 @@ anonymize:
quote:
customer_email:
type: email
customer_name:
type: full_name
remote_ip:
type: ip
```
Expand Down

0 comments on commit 0aa1c25

Please sign in to comment.