diff --git a/docs/docs/transformers/system/card-number.mdx b/docs/docs/transformers/system/card-number.mdx deleted file mode 100644 index 43d6c9dd6e..0000000000 --- a/docs/docs/transformers/system/card-number.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: Card Number -id: card-number -hide_title: true -slug: /transformers/system/card-number ---- - -import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx'; - -import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx'; - - - -## Definition - -The card number transformer can anonymize an existing email address or completely generate a new one. A card number can be quite complex but we make it easy to generate valid luhn-check card numbers. - -By default, the card number transformer generates a random 16 digit card number that is _not_ luhn valid. If you want luhn validation, please set the luhn-check config to `true`. - -## Configurations - -Depending on your validations, you may want to configure the output card number. The card number transformer has the following configurations: - - - -## Examples - -Here are some examples of an output card number: - - diff --git a/docs/docs/transformers/system/city.mdx b/docs/docs/transformers/system/city.mdx deleted file mode 100644 index eb59addb93..0000000000 --- a/docs/docs/transformers/system/city.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: City -id: city -hide_title: true -slug: /transformers/system/city ---- - -import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx'; - -import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx'; - - - -## Definition - -The city transformer generates a randomly selected US city. You can see the complete list of cities that are available to be randomly selected [here.](https://github.com/nucleuscloud/neosync/blob/main/worker/internal/benthos/transformers/data-sets/addresses.json). - -If you'd rather not get back a real city value, you can use the [Random String Transformer](/transformers/system/random-string) to generate a random string value. - -## Configurations - -There are no configurations for the city transformer. - -## Examples - -Here are some examples of what an output City value may look like. - - diff --git a/docs/docs/transformers/system/email.mdx b/docs/docs/transformers/system/email.mdx deleted file mode 100644 index 6159324876..0000000000 --- a/docs/docs/transformers/system/email.mdx +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: Email -id: email -hide_title: true -slug: /transformers/system/email ---- - -import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx'; - -import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx'; - - - -## Definition - -The email transformer can anonymize an existing email address or completely generate a new one. An email is made up of three parts: - -`@.` - -By default, the transformer randomizes the username, domain and top-level domain while always preserving the email format by retaining the @ and . characters. - -For example, the following input value: -`john@acme.com` - -Would produce the following ouput value: -`ytvub873@ksh0293.com` - -You can see we generated new privacy-safe values for the username and the domain. You can update this structure using the configurations below. Lastly, the email transformer takes in a `string` and returns a `string`. - -## Configurations - -Depending on your validations, you may want to configure the output email. The email transformer has the following configurations: - - - -## Examples - -There are several ways you can mix-and-match configurations to get different potential email formats. Here are some possible combinations: - - diff --git a/docs/docs/transformers/system/first-name.mdx b/docs/docs/transformers/system/first-name.mdx deleted file mode 100644 index 6908eab3e2..0000000000 --- a/docs/docs/transformers/system/first-name.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: First Name -id: first-name -hide_title: true -slug: /transformers/system/first-name ---- - -import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx'; - -import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx'; - - - -## Definition - -The first name transformer generates a valid first name from a list of predefined first name values. You can see the entire list of first name value [here.](https://github.com/nucleuscloud/neosync/blob/main/worker/internal/benthos/transformers/data-sets/first-names.json). - -By default, the first name transformer generates a first name of random length. To preserve the length of the input first name, you can set the `preserveLength` config. - -## Configurations - -Depending on your validations, you may want to configure the output first name. The first name transformer has the following configurations: - - - -## Examples - -There are several ways you can mix-and-match configurations to get different first name formats. Here are some possible combinations: - - diff --git a/docs/docs/transformers/system/full-address.mdx b/docs/docs/transformers/system/full-address.mdx deleted file mode 100644 index eaa2e25885..0000000000 --- a/docs/docs/transformers/system/full-address.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Full Address -id: full-address -hide_title: true -slug: /transformers/system/full-address ---- - -import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx'; - -import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx'; - - - -## Definition - -The full address transformer generates a randomly selects a real full address that exists in the United States. You can see the complete list of full addresses that are available to be randomly selected [here.](https://github.com/nucleuscloud/neosync/blob/main/worker/internal/benthos/transformers/data-sets/addresses.json). - -The full address transformer returns a valid United States address. For example: -`123 Main Street Boston, Massachusetts, 02169` - -## Configurations - -There are no configurations for the full adddress transformer. - -## Examples - -Here are some examples of what an output full address value may look like. - - diff --git a/docs/docs/transformers/system/full-name.mdx b/docs/docs/transformers/system/full-name.mdx deleted file mode 100644 index 38ac2b9e91..0000000000 --- a/docs/docs/transformers/system/full-name.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: Full Name -id: full-name -hide_title: true -slug: /transformers/system/full-name ---- - -import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx'; - -import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx'; - - - -## Definition - -The full name transformer generates a valid full name from a list of predefined full name values. The generated full name is made from a combination of the [first](/transformers/system/first-name) and [last](/transformers/system/last-name) names transformers. - -By default, the full name transformer generates a full name of random length. To preserve the length of the input full name, you can set the `preserveLength` config. - -## Configurations - -Depending on your validations, you may want to configure the output full name. The full name transformer has the following configurations: - - - -## Examples - -There are several ways you can mix-and-match configurations to get different full name formats. Here are some possible combinations: - - diff --git a/docs/docs/transformers/system/gender.mdx b/docs/docs/transformers/system/gender.mdx deleted file mode 100644 index 6df48089b6..0000000000 --- a/docs/docs/transformers/system/gender.mdx +++ /dev/null @@ -1,84 +0,0 @@ ---- -title: Gender -id: gender -hide_title: true -slug: /transformers/system/gender ---- - -import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx'; - -import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx'; - - - -## Definition - -The gender transformer randomly selects a gender value from a predefined list of genders. Here is the list: - - - -By default, the gender transformer does not abbreviate the gender. If you'd like to return an abbreviated gender, pass in the `abbreviate` config. - -## Configurations - -Depending on your validations, you may want to configure the output gender. The gender transformer has the following configurations: - - - -## Examples - -There are several ways you can mix-and-match configurations to get different full name formats. Here are some possible combinations: - - diff --git a/docs/docs/transformers/system/int-phone.mdx b/docs/docs/transformers/system/int-phone.mdx deleted file mode 100644 index 7b1ef2f9c6..0000000000 --- a/docs/docs/transformers/system/int-phone.mdx +++ /dev/null @@ -1,73 +0,0 @@ ---- -title: Phone (integer) -id: int-phone -hide_title: true -slug: /transformers/system/int-phone ---- - -import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx'; - -import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx'; - - - -## Definition - -The phone transformer can anonymize an existing phone number or completely generate a new one. There are two phone number transformers that differ by type and the configurations that are available to customize the transformer. This transformer specifically takes an integer value and returns an integer value. The [Phone (string) transformer](/transformers/system/string-phone) takes in a string value, returns a string and has more configurations available. - -By default, the phone (integer) transformer generates a random 10 digit phone number. - -For example, the following input value: -`7829828714` - -Would produce the following ouput value: -`5698437232` - -You can see we generated a new phone integer value that can be used as an integer phone number. Also, note that we don't include hyphens in this transformer since the output type is an `integer`. - -Phone numbers also vary in length with some international phone numbers reaching up to 15 digits in length. You can set this transformer to respect the length of the input value if you're working with phone numbers longer than 10 digits in length. - -## Configurations - -Depending on your validations, you may want to configure the output phone number. As we discussed above, some phone numbers may be longer than the default 10 digits in length. The phone number (integer) transformer has the following configurations: - - - -## Examples - -There are several ways you can mix-and-match configurations to get different potential phone number formats. Here are some possible combinations: - - diff --git a/docs/docs/transformers/system/last-name.mdx b/docs/docs/transformers/system/last-name.mdx deleted file mode 100644 index dff6c417b7..0000000000 --- a/docs/docs/transformers/system/last-name.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -title: Last Name -id: last-name -hide_title: true -slug: /transformers/system/last-name ---- - -import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx'; - -import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx'; - - - -## Definition - -The last name transformer generates a valid last name from a list of predefined last name values. You can see the entire list of last name value [here.](https://github.com/nucleuscloud/neosync/blob/main/worker/internal/benthos/transformers/data-sets/last-names.json). - -By default, the last name transformer generates a last name of random length. To preserve the length of the input last name, you can set the `preserveLength` config. - -## Configurations - -Depending on your validations, you may want to configure the output last name. The last name transformer has the following configurations: - - - -## Examples - -There are several ways you can mix-and-match configurations to get different last name formats. Here are some possible combinations: - - diff --git a/docs/docs/transformers/system/null.mdx b/docs/docs/transformers/system/null.mdx deleted file mode 100644 index fb5cf8dc74..0000000000 --- a/docs/docs/transformers/system/null.mdx +++ /dev/null @@ -1,37 +0,0 @@ ---- -title: Null Value -id: null-t -hide_title: true -slug: /transformers/system/null-t ---- - -import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx'; - -import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx'; - - - -## Definition - -The null transformer simply returns a null value. This may be useful if you a column that can't be null but don't have a specific value that you want to insert. - -## Configurations - -There are no configurations for the null transformer. - -## Examples - -Here are some examples of what an output null value may look like. - - diff --git a/docs/docs/transformers/system/random-bool.mdx b/docs/docs/transformers/system/random-bool.mdx deleted file mode 100644 index c027452fa2..0000000000 --- a/docs/docs/transformers/system/random-bool.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: Random Boolean -id: random-bool -hide_title: true -slug: /transformers/system/random-bool ---- - -import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx'; - -import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx'; - - - -## Definition - -The random boolean transformer randomly generates a boolean value. - -## Configurations - -There are no configurations for the random boolean transformer. - -## Examples - -Here are some examples of what an output random boolean value may look like. - - diff --git a/docs/docs/transformers/system/random-float.mdx b/docs/docs/transformers/system/random-float.mdx deleted file mode 100644 index 137072c354..0000000000 --- a/docs/docs/transformers/system/random-float.mdx +++ /dev/null @@ -1,93 +0,0 @@ ---- -title: Random Float -id: random-float -hide_title: true -slug: /transformers/system/random-float ---- - -import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx'; - -import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx'; - - - -## Definition - -The random float transformer generates a random floating point number. - -For example: -`32.2432` - -By default, the random float transformer generates a floating point number with 2 digits before the decimal point and 3 digits after the decimal point. - -## Configurations - -Depending on your validations, you may want to configure the output float. The random float transformer has the following configurations: - - - -## Examples - -There are several ways you can mix-and-match configurations to get different potential random float formats. Here are some possible combinations: - - diff --git a/docs/docs/transformers/system/reference.mdx b/docs/docs/transformers/system/reference.mdx index d6b9706dcd..9b193b8e34 100644 --- a/docs/docs/transformers/system/reference.mdx +++ b/docs/docs/transformers/system/reference.mdx @@ -360,19 +360,19 @@ There are no configurations for this transformer. **Examples** @@ -392,19 +392,19 @@ There are no configurations for this transformer. **Examples** @@ -457,7 +457,7 @@ Depending on your logic, you may want to configure the output email. The transfo ]} /> -## Examples +**Examples** There are several ways you can mix-and-match configurations to get different potential email formats. Here are some possible combinations: @@ -486,68 +486,1339 @@ There are several ways you can mix-and-match configurations to get different pot ### Generate Boolean{#generate-boolean} +The genereate boolean transformer randomly generates a boolean value. + +**Configurations** + +There are no configurations for the random boolean transformer. + +**Examples** + +Here are some examples of what an output random boolean value may look like. + + + ### Generate Card Number{#generate-card-number} +The generate card number transformer generates a new card number that is [luhn valid.](https://en.wikipedia.org/wiki/Luhn_algorithm) + +By default, the card number transformer generates a random 16 digit card number that is _not_ luhn valid. If you want luhn validation, please set the luhn-check config to `true`. + +**Configurations** + +Depending on your validations, you may want to configure the output card number. The card number transformer has the following configurations: + + + +**Examples** + +Here are some examples of an output card number: + + + ### Generate City{#generate-city} +The generate city transformers generates a randomly selected US city. You can see the complete list of cities that are available to be randomly selected [here](https://github.com/nucleuscloud/neosync/blob/main/worker/internal/benthos/transformers/data-sets/addresses.json). + +If you'd rather not get back a real city value, you can use the [Generate Random String Transformer](/transformers/system/reference#generate-random-string) to generate a random string value. + +**Configurations** + +There are no configurations for the city transformer. + +**Examples** + +Here are some examples of what an output City value may look like. + + + ### Generate E164 Phone Number{#generate-e164-phone-number} +The generate e164 phone transformer generates a new international phone number including the + sign. By default, the generate e164 transformer generates a random 12 digit number with no hyphens in the format: + +`+34567890123` + +TPhone numbers also vary in length with some international phone numbers reaching up to 15 digits in length. You can set this transformer to be a certain length by passing in the `length` configuration. Here is more information on the [e164 format](https://www.twilio.com/docs/glossary/what-e164). This transformer also has a min of 9 and a max of 15. If you want to generate a number that is longer than that, you can use the [Generate Random int64 transformer](/transformers/system/reference#generate-random-int64) + +**Configurations** + +Depending on your validations, you may want to configure the output e164 phone number: + + + +**Examples** + +There are several ways you can mix-and-match configurations to get different potential phone number formats. Here are some possible combinations: + + + ### Generate First Name{#generate-first-name} +The generate first name transformer generates a valid first name from a list of predefined first name values. You can see the entire list of first name value [here.](https://github.com/nucleuscloud/neosync/blob/main/worker/internal/benthos/transformers/data-sets/first-names.json) + +By default, the generate first name transformer randomly picks a first name with a length between 2 and 12. + +**Configurations** + +There are no configurations for this transformer. + +**Examples** + +There are several ways you can mix-and-match configurations to get different first name formats. Here are some possible combinations: + + + ### Generate Float64{#generate-float64} -### Generate Full Address{#generate-full-address} +The generate float transformer generates a random floating point number. -### Generate Full Name{#generate-full-name} +For example: +`32.2432` -### Generate Gender{#generate-gender} +By default, the random float transformer generates a floating point number with 3 digits before the decimal point and 3 digits after the decimal point. -### Generate int64 Phone Number{#generate-int64-phone-number} +**Configurations** -### Generate Random Int64{#generate-random-int64} +Depending on your validations, you may want to configure the output float. The random float transformer has the following configurations: -### Generate Last Name{#generate-last-name} + -### Generate SHA256 Hash{#generate-sha256-hash} +**Examples** -### Generate SSN{#generate-ssn} +There are several ways you can mix-and-match configurations to get different potential random float formats. Here are some possible combinations: -### Generate State{#generate-state} + -### Generate Street Address{#generate-street-address} +### Generate Full Address{#generate-full-address} -### Generate String Phone Number{#generate-string-phone-number} +The generate full address transformer generates a randomly selected real full address that exists in the United States. You can see the complete list of full addresses that are available to be randomly selected [here.](https://github.com/nucleuscloud/neosync/blob/main/worker/internal/benthos/transformers/data-sets/addresses.json) -### Generate Random String{#generate-random-string} +The full address transformer returns a valid United States address. For example: +`123 Main Street Boston, Massachusetts, 02169` -### Generate Unix Timestamp{#generate-unix-timestamp} +**Configurations** -### Generate Username{#generate-username} +There are no configurations for the full adddress transformer. -### Generate UTC Timestamp{#generate-utc-timestamp} +**Examples** -### Generate UUID{#generate-uuid} +Here are some examples of what an output full address value may look like. -### Generate Zipcode{#generate-zipcode} + -### Transform E164 Phone Number{#transform-e164-phone-number} +### Generate Full Name{#generate-full-name} -### Transform First Name{#transform-first-name} +The generate full name transformer generates a valid full name from a list of predefined full name values. The generated full name is made from a combination of the [first](/transformers/system/first-name) and [last](/transformers/system/last-name) names transformers. -### Transform Float64{#transform-float64} +**Configurations** -### Transform Full Name{#transform-full-name} +There are no configurations for this transformer. -### Transform Int64 Phone Number{#transform-int64-phone-number} +**Examples** -### Transform Int64{#transform-int64} +Here are some examples of what an output full name value may look like. -### Transform Last Name{#transform-last-name} + -### Transform Phone Number{#transform-phone-number} +### Generate Gender{#generate-gender} -### Transform String{#transform-string} +The gender transformer randomly selects a gender value from a predefined list of genders. Here is the list: -### Passthrough{#passthrough} + -### Null{#null} +By default, the gender transformer does not abbreviate the gender. If you'd like to return an abbreviated gender, pass in the `abbreviate` config. + +**Configurations** + +Depending on your validations, you may want to configure the output gender. The gender transformer has the following configurations: + + + +**Examples** + +There are several ways you can mix-and-match configurations to get different full name formats. Here are some possible combinations: + + + +### Generate int64 Phone Number{#generate-int64-phone-number} + +The generate int64 phone number generates a random 10 digit phone number and returns it as an `int64` type with no hyphens. If you want to return a `string` or want to include hyphens, check out the [Generate String Phone transformer](/transformers/system/reference#generate-string-phone-number). + +For example, the generate int64 phone number transformer could generate the following ouput value: +`5698437232` + +**Configurations** + +There are no configurations for this transformer. + +**Examples** + +Here are some examples of what the output values could look like: + + + +### Generate Random Int64{#generate-random-int64} + +The generate random int64 transformer generates a random integer and returns it as a int64 type. + +For example: +`6782` + +By default, the generate random int64 transformer generates an integer of 4 digits long. + +**Configurations** + +Depending on your validations, you may want to configure the output integer. The random integer transformer has the following configurations: + + + +**Examples** + +There are several ways you can mix-and-match configurations to get different potential random integer formats. Here are some possible combinations: + + + +### Generate Last Name{#generate-last-name} + +The generate last name transformer generates a valid last name from a list of predefined last name values. You can see the entire list of last name value [here.](https://github.com/nucleuscloud/neosync/blob/main/worker/internal/benthos/transformers/data-sets/last-names.json). + +**Configurations** + +This transformer has no configurations. + +**Examples** + +Here are some possible output examples: + + + +### Generate SHA256 Hash{#generate-sha256-hash} + +The generate sha256 hash transformer generates a random SHA256 hash and hex encodes the resulting value and returns it as a string. + +**Configurations** + +There are no configurations for the hash transformer. + +**Examples** + +Here are some examples of what an output hash value may look like. + + + +### Generate SSN{#generate-ssn} + +The generate ssn transformer randomly generates a social security number and returns it with hyphens as a string. + +For, example: +`123-45-6789` + +**Configurations** + +There are no configurations for the ssn transformer. + +**Examples** + +Here are some examples of what an output street address value may look like. + + + +### Generate State{#generate-state} + +The generate state transformer generates a randomly selected US state. You can see the complete list of states that are available to be randomly selected [here.](https://github.com/nucleuscloud/neosync/blob/main/worker/internal/benthos/transformers/data-sets/addresses.json). + +If you'd rather not get back a real state value, you can use the [Random String Transformer](/transformers/system/reference#generate-random-string) to generate a random string value. + +**Configurations** + +There are no configurations for the state transformer. + +**Examples** + +Here are some examples of what an output state value may look like. + + + +### Generate Street Address{#generate-street-address} + +The generate street address transformer generates a randomly selects a real street address that exists in the United States. You can see the complete list of street addresses that are available to be randomly selected [here.](https://github.com/nucleuscloud/neosync/blob/main/worker/internal/benthos/transformers/data-sets/addresses.json). + +The street address transformer returns a valid United States address. For example: +`123 Main Street Boston` + +**Configurations** + +There are no configurations for the street adddress transformer. + +**Examples** + +Here are some examples of what an output street address value may look like. + + + +### Generate String Phone Number{#generate-string-phone-number} + +### Generate Random String{#generate-random-string} + +### Generate Unix Timestamp{#generate-unix-timestamp} + +The generate unix timestamp transformer randomly generates a unix timestamp in UTC timezone and returns back an int64 representation of that timestamp. + +By default, the generated timestamp will always be in the **past**. + +**Configurations** + +There are no configurations for this transformer. + +**Examples** + +Here are some examples of what an output state value may look like. + + + +### Generate Username{#generate-username} + +The generate username transformer generates a random string in the format of ``. The last names are pulled from the last name transformer(/transformers/system/reference#generate-last-name). + +**Configurations** + +There are no configurations for the state transformer. + +**Examples** + +Here are some examples of what an output state value may look like. + + + +### Generate UTC Timestamp{#generate-utc-timestamp} + +The utc timestamp transformer randomly generates a utc timestamp in UTC timezone and returns back an time.Time representation of that timestamp. + +By default, the generated timestamp will always be in the **past**. + +**Configurations** + +There are no configurations for this transformer. + +**Examples** + +Here are some examples of what an output state value may look like. + + + +### Generate UUID{#generate-uuid} + +The UUID transformer generates a new UUID v4. + +For example: +`6d871028b072442c9ad9e6e4e223adfa` + +**Configurations** + +Depending on your validations, you may want to configure the output uuid. The uuid transformer has the following configurations: + + + +**Examples** + +Here are some example UUID values that the uuid transformer can generate: + + + +### Generate Zipcode{#generate-zipcode} + +The generate zipcode transformer generates a randomly selected US zipcode. You can see the complete list of zipcodes that are available to be randomly selected [here.](https://github.com/nucleuscloud/neosync/blob/main/worker/internal/benthos/transformers/data-sets/addresses.json). + +If you'd rather not get back a real zipcode value, you can use the [Random String Transformer](/transformers/system/random-string) to generate a random string value. + +**Configurations** + +There are no configurations for the zipcode transformer. + +**Examples** + +Here are some examples of what an output zipcode value may look like. + + + +### Transform E164 Phone Number{#transform-e164-phone-number} + +The phone transformer can anonymize an existing phone number or completely generate a new one. There are two phone number transformers that differ by type and the configurations that are available to customize the transformer. This transformer specifically takes a string value and returns a string value. The [Phone (integer) transformer](/transformers/system/string-phone) takes in an integer value and returns an integer value. + +By default, the phone (string) transformer generates a random 10 digit phone number with no hyphens. + +For example, the following input value: +`7829828714` + +Would produce the following ouput value: +`5698437232` + +You can see we generated a new phone string value that can be used as an string phone number. + +Phone numbers also vary in length with some international phone numbers reaching up to 15 digits in length. You can set this transformer to respect the length of the input value if you're working with phone numbers longer than 10 digits in length. In fact, you can generate a specific international "looking" phone number by specifying the [e164 format](https://www.twilio.com/docs/glossary/what-e164) config. + +## Configurations + +Depending on your validations, you may want to configure the output phone number. As we discussed above, some phone numbers may be longer than the default 10 digits in length. The phone number (string) transformer has the following configurations: + + + +## Examples + +There are several ways you can mix-and-match configurations to get different potential phone number formats. Here are some possible combinations: + + + +### Transform First Name{#transform-first-name} + +The generate first name transformer generates a valid first name from a list of predefined first name values. You can see the entire list of first name value [here.](https://github.com/nucleuscloud/neosync/blob/main/worker/internal/benthos/transformers/data-sets/first-names.json). + +By default, the first name transformer generates a first name of random length. To preserve the length of the input first name, you can set the `preserveLength` config. + +**Configurations** + +Depending on your validations, you may want to configure the output first name. The first name transformer has the following configurations: + + + +**Examples** + +There are several ways you can mix-and-match configurations to get different first name formats. Here are some possible combinations: + + + +### Transform Float64{#transform-float64} + +The random float transformer generates a random floating point number. + +For example: +`32.2432` + +By default, the random float transformer generates a floating point number with 2 digits before the decimal point and 3 digits after the decimal point. + +## Configurations + +Depending on your validations, you may want to configure the output float. The random float transformer has the following configurations: + + + +## Examples + +There are several ways you can mix-and-match configurations to get different potential random float formats. Here are some possible combinations: + + + +### Transform Full Name{#transform-full-name} + +The full name transformer generates a valid full name from a list of predefined full name values. The generated full name is made from a combination of the [first](/transformers/system/first-name) and [last](/transformers/system/last-name) names transformers. + +By default, the full name transformer generates a full name of random length. To preserve the length of the input full name, you can set the `preserveLength` config. + +**Configurations** + +Depending on your validations, you may want to configure the output full name. The full name transformer has the following configurations: + + + +**Examples** + +There are several ways you can mix-and-match configurations to get different full name formats. Here are some possible combinations: + + + +### Transform Int64 Phone Number{#transform-int64-phone-number} + +The phone transformer can anonymize an existing phone number or completely generate a new one. There are two phone number transformers that differ by type and the configurations that are available to customize the transformer. This transformer specifically takes an integer value and returns an integer value. The [Phone (string) transformer](/transformers/system/string-phone) takes in a string value, returns a string and has more configurations available. + +By default, the phone (integer) transformer generates a random 10 digit phone number. + +For example, the following input value: +`7829828714` + +Would produce the following ouput value: +`5698437232` + +You can see we generated a new phone integer value that can be used as an integer phone number. Also, note that we don't include hyphens in this transformer since the output type is an `integer`. + +Phone numbers also vary in length with some international phone numbers reaching up to 15 digits in length. You can set this transformer to respect the length of the input value if you're working with phone numbers longer than 10 digits in length. + +## Configurations + +Depending on your validations, you may want to configure the output phone number. As we discussed above, some phone numbers may be longer than the default 10 digits in length. The phone number (integer) transformer has the following configurations: + + + +## Examples + +There are several ways you can mix-and-match configurations to get different potential phone number formats. Here are some possible combinations: + + + +### Transform Int64{#transform-int64} + +The random integer transformer generates a random integer. + +For example: +`6782` + +By default, the random int transformer generates an integer of 4 digits long. + +## Configurations + +Depending on your validations, you may want to configure the output integer. The random integer transformer has the following configurations: + + + +## Examples + +There are several ways you can mix-and-match configurations to get different potential random integer formats. Here are some possible combinations: + + + +### Transform Last Name{#transform-last-name} + +The last name transformer generates a valid last name from a list of predefined last name values. You can see the entire list of last name value [here.](https://github.com/nucleuscloud/neosync/blob/main/worker/internal/benthos/transformers/data-sets/last-names.json). + +By default, the last name transformer generates a last name of random length. To preserve the length of the input last name, you can set the `preserveLength` config. + +## Configurations + +Depending on your validations, you may want to configure the output last name. The last name transformer has the following configurations: + + + +## Examples + +There are several ways you can mix-and-match configurations to get different last name formats. Here are some possible combinations: + + + +### Transform Phone Number{#transform-phone-number} + +The phone transformer can anonymize an existing phone number or completely generate a new one. There are two phone number transformers that differ by type and the configurations that are available to customize the transformer. This transformer specifically takes a string value and returns a string value. The [Phone (integer) transformer](/transformers/system/string-phone) takes in an integer value and returns an integer value. + +By default, the phone (string) transformer generates a random 10 digit phone number with no hyphens. + +For example, the following input value: +`7829828714` + +Would produce the following ouput value: +`5698437232` + +You can see we generated a new phone string value that can be used as an string phone number. + +Phone numbers also vary in length with some international phone numbers reaching up to 15 digits in length. You can set this transformer to respect the length of the input value if you're working with phone numbers longer than 10 digits in length. In fact, you can generate a specific international "looking" phone number by specifying the [e164 format](https://www.twilio.com/docs/glossary/what-e164) config. + +## Configurations + +Depending on your validations, you may want to configure the output phone number. As we discussed above, some phone numbers may be longer than the default 10 digits in length. The phone number (string) transformer has the following configurations: + + + +## Examples + +There are several ways you can mix-and-match configurations to get different potential phone number formats. Here are some possible combinations: + + + +### Transform String{#transform-string} + +### Passthrough{#passthrough} + +### Null{#null} + +The null transformer simply returns a null value. This may be useful if you a column that can't be null but don't have a specific value that you want to insert. + +## Configurations + +There are no configurations for the null transformer. + +## Examples + +Here are some examples of what an output null value may look like. + + diff --git a/docs/docs/transformers/system/sha256hash.mdx b/docs/docs/transformers/system/sha256hash.mdx deleted file mode 100644 index d83e247bd3..0000000000 --- a/docs/docs/transformers/system/sha256hash.mdx +++ /dev/null @@ -1,52 +0,0 @@ ---- -title: Hash -id: hash -hide_title: true -slug: /transformers/system/hash ---- - -import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx'; - -import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx'; - - - -## Definition - -The hash transformer creates a SHA256 hash and hex encodes the resulting value and returns it as a string. Before the value is hashed, it's first transformed into a byte array to account for flexible input types. - -## Configurations - -There are no configurations for the hash transformer. - -## Examples - -Here are some examples of what an output hash value may look like. - - diff --git a/docs/docs/transformers/system/ssn.mdx b/docs/docs/transformers/system/ssn.mdx deleted file mode 100644 index d5910a18a4..0000000000 --- a/docs/docs/transformers/system/ssn.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: SSN -id: ssn -hide_title: true -slug: /transformers/system/ssn ---- - -import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx'; - -import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx'; - - - -## Definition - -The ssn transformer randomly generates a social security number and returns it with hyphens as a string. - -For, example: -`123-45-6789` - -## Configurations - -There are no configurations for the ssn transformer. - -## Examples - -Here are some examples of what an output street address value may look like. - - diff --git a/docs/docs/transformers/system/state.mdx b/docs/docs/transformers/system/state.mdx deleted file mode 100644 index fb29bfba8f..0000000000 --- a/docs/docs/transformers/system/state.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: State -id: state -hide_title: true -slug: /transformers/system/state ---- - -import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx'; - -import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx'; - - - -## Definition - -The state transformer generates a randomly selected US state. You can see the complete list of states that are available to be randomly selected [here.](https://github.com/nucleuscloud/neosync/blob/main/worker/internal/benthos/transformers/data-sets/addresses.json). - -If you'd rather not get back a real state value, you can use the [Random String Transformer](/transformers/system/random-string) to generate a random string value. - -## Configurations - -There are no configurations for the state transformer. - -## Examples - -Here are some examples of what an output state value may look like. - - diff --git a/docs/docs/transformers/system/street-address.mdx b/docs/docs/transformers/system/street-address.mdx deleted file mode 100644 index 835163bf03..0000000000 --- a/docs/docs/transformers/system/street-address.mdx +++ /dev/null @@ -1,43 +0,0 @@ ---- -title: Street Address -id: street-address -hide_title: true -slug: /transformers/system/street-address ---- - -import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx'; - -import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx'; - - - -## Definition - -The street address transformer generates a randomly selects a real street address that exists in the United States. You can see the complete list of street addresses that are available to be randomly selected [here.](https://github.com/nucleuscloud/neosync/blob/main/worker/internal/benthos/transformers/data-sets/addresses.json). - -The street address transformer returns a valid United States address. For example: -`123 Main Street Boston` - -## Configurations - -There are no configurations for the street adddress transformer. - -## Examples - -Here are some examples of what an output street address value may look like. - - diff --git a/docs/docs/transformers/system/string-phone.mdx b/docs/docs/transformers/system/string-phone.mdx deleted file mode 100644 index f6400f77a7..0000000000 --- a/docs/docs/transformers/system/string-phone.mdx +++ /dev/null @@ -1,106 +0,0 @@ ---- -title: Phone (string) -id: string-phone -hide_title: true -slug: /transformers/system/string-phone ---- - -import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx'; - -import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx'; - - - -## Definition - -The phone transformer can anonymize an existing phone number or completely generate a new one. There are two phone number transformers that differ by type and the configurations that are available to customize the transformer. This transformer specifically takes a string value and returns a string value. The [Phone (integer) transformer](/transformers/system/string-phone) takes in an integer value and returns an integer value. - -By default, the phone (string) transformer generates a random 10 digit phone number with no hyphens. - -For example, the following input value: -`7829828714` - -Would produce the following ouput value: -`5698437232` - -You can see we generated a new phone string value that can be used as an string phone number. - -Phone numbers also vary in length with some international phone numbers reaching up to 15 digits in length. You can set this transformer to respect the length of the input value if you're working with phone numbers longer than 10 digits in length. In fact, you can generate a specific international "looking" phone number by specifying the [e164 format](https://www.twilio.com/docs/glossary/what-e164) config. - -## Configurations - -Depending on your validations, you may want to configure the output phone number. As we discussed above, some phone numbers may be longer than the default 10 digits in length. The phone number (string) transformer has the following configurations: - - - -## Examples - -There are several ways you can mix-and-match configurations to get different potential phone number formats. Here are some possible combinations: - - diff --git a/docs/docs/transformers/system/unix-ts.mdx b/docs/docs/transformers/system/unix-ts.mdx deleted file mode 100644 index 8cd2dd4652..0000000000 --- a/docs/docs/transformers/system/unix-ts.mdx +++ /dev/null @@ -1,63 +0,0 @@ ---- -title: Unix Timestamp -id: unix-ts -hide_title: true -slug: /transformers/system/unix-ts ---- - -import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx'; - -import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx'; - - - -## Definition - -The unix timestamp transformer randomly generates a unix timestamp in UTC timezone and returns back an int64 representation of that timestamp. - -By default, the generated timestamp will always be in the **past**. To generate a timestamp that is in the future, set the `Future` config to true. - -## Configurations - -Depending on your validations, you may want to configure the output unix timestamp. The unix timestamp transformer has the following configuration options: - - - -## Examples - -Here are some examples of what an output state value may look like. - - diff --git a/docs/docs/transformers/system/utc-ts.mdx b/docs/docs/transformers/system/utc-ts.mdx deleted file mode 100644 index 34d2ae368f..0000000000 --- a/docs/docs/transformers/system/utc-ts.mdx +++ /dev/null @@ -1,71 +0,0 @@ ---- -title: UTC Timestamp -id: utc-ts -hide_title: true -slug: /transformers/system/utc-ts ---- - -import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx'; - -import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx'; - - - -## Definition - -The utc timestamp transformer randomly generates a utc timestamp in UTC timezone and returns back an tiem.Time representation of that timestamp. - -By default, the generated timestamp will always be in the **past**. To generate a timestamp that is in the future, set the `future` config to true. - -## Configurations - -Depending on your validations, you may want to configure the output utc timestamp. The utc timestamp transformer has the following configuration options: - - - -## Examples - -Here are some examples of what an output state value may look like. - - diff --git a/docs/docs/transformers/system/uuid.mdx b/docs/docs/transformers/system/uuid.mdx deleted file mode 100644 index d3492b1572..0000000000 --- a/docs/docs/transformers/system/uuid.mdx +++ /dev/null @@ -1,68 +0,0 @@ ---- -title: UUID -id: uuid -hide_title: true -slug: /transformers/system/uuid ---- - -import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx'; - -import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx'; - - - -## Definition - -The UUID transformer generates a new UUID v4. - -For example: -`6d871028b072442c9ad9e6e4e223adfa` - -## Configurations - -Depending on your validations, you may want to configure the output uuid. The uuid transformer has the following configurations: - - - -## Examples - -Here are some example UUID values that the uuid transformer can generate: - - diff --git a/docs/docs/transformers/system/zipcode.mdx b/docs/docs/transformers/system/zipcode.mdx deleted file mode 100644 index 574f95b474..0000000000 --- a/docs/docs/transformers/system/zipcode.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -title: Zipcode -id: zipcode -hide_title: true -slug: /transformers/system/zipcode ---- - -import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx'; - -import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx'; - - - -## Definition - -The zipcode transformer generates a randomly selected US zipcode. You can see the complete list of zipcodes that are available to be randomly selected [here.](https://github.com/nucleuscloud/neosync/blob/main/worker/internal/benthos/transformers/data-sets/addresses.json). - -If you'd rather not get back a real zipcode value, you can use the [Random String Transformer](/transformers/system/random-string) to generate a random string value. - -## Configurations - -There are no configurations for the zipcode transformer. - -## Examples - -Here are some examples of what an output zipcode value may look like. - -