Ghost Bakery documentation

Ghost Bakery turns a GBDDL recipe into synthetic test data. A recipe describes tables, columns and their relationships; its output block selects the representation. Recipes generate tabular files, nested documents or test scenarios. Catalog exports and localized filler PDFs have separate workflows that do not require a recipe.

first-recipe.gbddl

gbddl 1

table customers rows 3 (
  id    int64 autoincrement primarykey
  name  text fullName()
  email text email()
)

output csv

Start here

Quickstart: create and validate a small recipe.
Recipe concepts: tables, projections, jobs and guarantees.

Reference

Smart types

`integer`

Random integer.

Effective credit weight: 1.

Argument	Kind	Default	Description
`min`	`integer`	`0`	Inclusive lower bound.
`max`	`integer`	`100`	Inclusive upper bound.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`decimal`

Random decimal, rounded to precision places.

Effective credit weight: 1.

Argument	Kind	Default	Description
`min`	`number`	`0`	Inclusive lower bound.
`max`	`number`	`1`	Inclusive upper bound.
`precision`	`integer`	`2`	Digits after the decimal separator.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`boolean`

true or false.

Effective credit weight: 1.

Argument	Kind	Default	Description
`trueRate`	`percent`	`50`	Percentage of `true` values, from 0% to 100%.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`date`

Calendar date. Defaults to 1970-01-01 through 2030-12-31.

Effective credit weight: 2.

Argument	Kind	Default	Description
`min`	`string`	—	Earliest date, as `yyyy-MM-dd`.
`max`	`string`	—	Latest date, as `yyyy-MM-dd`.
`range`	`enum`	—	`past`: the last 10 years; `future`: 10 years ahead.
`format`	`string`	`yyyy-MM-dd`	How the date is written on a text column.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`datetime`

Date and time in UTC. Defaults to one year either side of now.

Effective credit weight: 1.

Argument	Kind	Default	Description
`min`	`string`	—	Earliest instant, as RFC 3339 or `yyyy-MM-dd HH:mm:ss`.
`max`	`string`	—	Latest instant, same forms as `min`.
`range`	`enum`	—	`past`: the last 10 years; `future`: 10 years ahead.
`format`	`string`	`rfc3339`	How the instant is written on a text column.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`time`

Time of day. Defaults to 00:00:00 through 23:59:59.

Effective credit weight: 1.

Argument	Kind	Default	Description
`min`	`string`	—	Earliest time, as `HH:mm:ss`.
`max`	`string`	—	Latest time, as `HH:mm:ss`.
`format`	`string`	`HH:mm:ss`	How the time is written on a text column, from the tokens `HH`, `mm`, `ss` and the separators `- / . : , _`, space and `T`.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`age`

Human age in years.

Effective credit weight: 1.

Argument	Kind	Default	Description
`min`	`integer`	`0`	Inclusive lower bound.
`max`	`integer`	`100`	Inclusive upper bound.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`port`

TCP/UDP port from 1 to 65535.

Effective credit weight: 1.

Argument	Kind	Default	Description
`min`	`integer`	`1`	Inclusive lower bound.
`max`	`integer`	`65535`	Inclusive upper bound.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`latitude`

Latitude in degrees.

Effective credit weight: 1.

Argument	Kind	Default	Description
`min`	`number`	`-90`	Inclusive lower bound.
`max`	`number`	`90`	Inclusive upper bound.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`longitude`

Longitude in degrees.

Effective credit weight: 1.

Argument	Kind	Default	Description
`min`	`number`	`-180`	Inclusive lower bound.
`max`	`number`	`180`	Inclusive upper bound.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`timezoneOffset`

UTC offset in hours, in quarter-hour steps from -12 to +14.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`datetimePart`

One integer part of a date or time.

Effective credit weight: 1.

Argument	Kind	Default	Description
`part`	`enum`	`second`	Which part.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`words`

Lorem-ipsum filler words.

Effective credit weight: 1.

Argument	Kind	Default	Description
`minWords`	`integer`	`1`	Minimum word count.
`maxWords`	`integer`	`minWords + 3`	Maximum word count.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`lorem`

Lorem-ipsum filler words.

Effective credit weight: 1.

Argument	Kind	Default	Description
`minWords`	`integer`	`1`	Minimum word count.
`maxWords`	`integer`	`minWords + 3`	Maximum word count.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`phrase`

Lorem-ipsum filler words.

Effective credit weight: 1.

Argument	Kind	Default	Description
`minWords`	`integer`	`1`	Minimum word count.
`maxWords`	`integer`	`minWords + 3`	Maximum word count.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`sentence`

Filler sentence of random words in the alphabet of the column's language.

Effective credit weight: 3.

Argument	Kind	Default	Description
`minWords`	`integer`	`1`	Minimum word count.
`maxWords`	`integer`	`minWords + 3`	Maximum word count.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.

`question`

Like sentence, ending in ?.

Effective credit weight: 3.

Argument	Kind	Default	Description
`minWords`	`integer`	`1`	Minimum word count.
`maxWords`	`integer`	`minWords + 3`	Maximum word count.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.

`quote`

Like sentence, in double quotes.

Effective credit weight: 3.

Argument	Kind	Default	Description
`minWords`	`integer`	`1`	Minimum word count.
`maxWords`	`integer`	`minWords + 3`	Maximum word count.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.

`paragraph`

Several filler sentences in the alphabet of the column's language: maxWords / 10 of them, at least one.

Effective credit weight: 4.

Argument	Kind	Default	Description
`minWords`	`integer`	`1`	Minimum word count.
`maxWords`	`integer`	`minWords + 3`	Maximum word count.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.

`enum`

A value picked from your list, optionally weighted.

Effective credit weight: 1.

Argument	Kind	Default	Description
`values`	`list`	—	The values to pick from.
`weights`	`weights`	—	Relative weight per value, a list parallel to `values`.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.

`template`

Text assembled from earlier columns of the same row.

Effective credit weight: 1.

Argument	Kind	Default	Description
`template`	`template`	—	Text with `{{column}}` placeholders.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.

`regexp`

Text matching a regular expression.

Effective credit weight: 1.

Argument	Kind	Default	Description
`pattern`	`string`	—	The expression.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.

`pattern`

Text from a placeholder mask: ? is a letter, # a digit.

Effective credit weight: 1.

Argument	Kind	Default	Description
`pattern`	`string`	—	The mask, e.g. `??-####`.
`mode`	`enum`	`lexifyNumerify`	Which placeholders to replace.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.

`firstName`

Given name.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`middleName`

Middle name.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`lastName`

Family name.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`fullName`

Full name, in the language's own name order.

Effective credit weight: 2.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`namePrefix`

Title such as Dr. or Ms..

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`nameSuffix`

Suffix such as Jr..

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`gender`

Gender label.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.

`email`

E-mail address built from the drawn name.

Effective credit weight: 2.

Argument	Kind	Default	Description
`domain`	`string`	`example.com`	Domain after the `@`.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`username`

Account handle such as lars.eriksson318.

Effective credit weight: 2.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`phone`

Phone number. Brazilian for country: BR, North American otherwise.

Effective credit weight: 1.

Argument	Kind	Default	Description
`country`	`string`	—	`BR` or `US`.
`formatted`	`boolean`	`false`	`BR` only: `(11) 91234-5678`.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`uuid`

Random UUID version 4.

Effective credit weight: 3.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`ulid`

ULID: 26 characters, sortable by creation time.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`mongodbObjectId`

24-character hexadecimal MongoDB ObjectId.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`identifier`

National or business identifier with valid check digits.

Effective credit weight: 1.

Argument	Kind	Default	Description
`kind`	`enum`	—	Which identifier.
`formatted`	`boolean`	`false`	Include the usual punctuation.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`isbn`

ISBN-10 or ISBN-13 with a valid check digit.

Effective credit weight: 1.

Argument	Kind	Default	Description
`version`	`enum`	—	`10` or `13`; either without it.
`formatted`	`boolean`	`false`	Separate the groups with hyphens.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`issn`

ISSN with a valid check digit.

Effective credit weight: 2.

Argument	Kind	Default	Description
`formatted`	`boolean`	`false`	Write it as `1234-5679`.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`semver`

Semantic version such as 2.14.7.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`slug`

Lowercase ASCII slug of hyphen-joined words.

Effective credit weight: 2.

Argument	Kind	Default	Description
`words`	`integer`	`3`	Number of words.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`creditCard`

16-digit test card number, Luhn-valid and never a real card.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`url`

URL with a random domain and path.

Effective credit weight: 3.

Argument	Kind	Default	Description
`scheme`	`string`	`https`	URL scheme.
`host`	`string`	—	Fixed host name.
`pathDepth`	`integer`	`2`	Number of path segments.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`httpUrl`

Like url, restricted to http and https.

Effective credit weight: 3.

Argument	Kind	Default	Description
`scheme`	`string`	`https`	URL scheme.
`host`	`string`	—	Fixed host name.
`pathDepth`	`integer`	`2`	Number of path segments.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`domainName`

Domain name such as litoral.com.

Effective credit weight: 2.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`hostname`

Host name such as host-417.

Effective credit weight: 2.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`fqdn`

Fully qualified domain name such as host-12.litoral.com.

Effective credit weight: 2.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`ipv4`

IPv4 address.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`ipv6`

IPv6 address in 2001::/16.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`ip`

IPv4 or IPv6 address, half each.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`cidr`

IPv4 or IPv6 network block such as 10.32.0.0/11.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`mac`

Locally administered unicast MAC address.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`httpStatus`

Common HTTP status code.

Effective credit weight: 1.

Argument	Kind	Default	Description
`format`	`enum`	`code`	`code` (and `simple`) writes the integer; `text` writes `404 Not Found`.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`httpMethod`

GET, POST, PUT, PATCH, DELETE, HEAD or OPTIONS.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`httpVersion`

HTTP/1.0, HTTP/1.1, HTTP/2 or HTTP/3.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`logLevel`

TRACE, DEBUG, INFO, WARN or ERROR.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`userAgent`

Browser or API client user-agent string.

Effective credit weight: 1.

Argument	Kind	Default	Description
`browser`	`enum`	—	Fixed browser.
`kind`	`enum`	—	`api` for an API client agent.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`jwt`

Unsigned JWT (alg: none), never valid against a real verifier.

Effective credit weight: 8.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`city`

City name.

Effective credit weight: 2.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`country`

Country name.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.

`countryCode`

Country ISO 3166-1 alpha-2 code.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`currency`

The country's currency (ISO 4217 code). Countries share currencies, so it cannot be unique.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`postcode`

Postal code: 12345-678 for BR, 12345 for US, 1234-567 otherwise.

Effective credit weight: 1.

Argument	Kind	Default	Description
`country`	`string`	—	`BR` or `US`; other values use the generic form.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`password`

Random password with at least one character of each enabled class.

Effective credit weight: 8.

Argument	Kind	Default	Description
`length`	`integer`	`16`	Length in characters.
`lower`	`boolean`	—	Include a-z.
`upper`	`boolean`	—	Include A-Z.
`numeric`	`boolean`	—	Include 0-9.
`special`	`boolean`	—	Include punctuation.
`space`	`boolean`	—	Include spaces.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`hash`

Digest of an earlier column or of a template.

Effective credit weight: 1.

Argument	Kind	Default	Description
`algorithm`	`enum`	—	Digest algorithm.
`sourceField`	`field`	—	Earlier column to hash.
`template`	`template`	—	Text to hash, with `{{column}}` placeholders.
`encoding`	`enum`	`hex`	How the digest is written.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`binary`

Random bytes. A bytes column holds them as they are; a text or varchar column holds them written with encoding.

Effective credit weight: 1.

Argument	Kind	Default	Description
`bytes`	`integer`	—	Exact byte count.
`minBytes`	`integer`	`1`	Minimum byte count.
`maxBytes`	`integer`	`32`	Maximum byte count.
`encoding`	`enum`	`base64`	How the bytes are written on a text or varchar column. A `bytes` column ignores it and renders per the format (plan section 7).
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`base64`

Standard Base64 of random bytes.

Effective credit weight: 1.

Argument	Kind	Default	Description
`length`	`integer`	`16`	Number of random bytes before encoding.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`color`

Color value.

Effective credit weight: 1.

Argument	Kind	Default	Description
`format`	`enum`	`hex`	`hex` writes `#A3F2C1`.
`palette`	`enum`	—	`safe` restricts to the 216 web-safe colors.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`company`

Company name.

Effective credit weight: 2.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`street`

Street name.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`hobby`

Hobby.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.

`monthName`

Month name.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.

`weekdayName`

Weekday name.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.

`timezone`

IANA time zone such as Europe/Paris.

Effective credit weight: 3.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`timezoneAbbr`

Time zone abbreviation such as IST.

Effective credit weight: 3.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`timezoneRegion`

Time zone region such as Europe.

Effective credit weight: 3.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`timezoneFull`

Full time zone name.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.

`programmingLanguage`

Programming language name.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`domainSuffix`

Domain suffix such as com or org.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.

`languageName`

Language name.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.

`continent`

Continent name.

Effective credit weight: 1.

Argument	Kind	Default	Description
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.

`pick`

A value drawn from a column of an uploaded file, written pick(@part.column). In a dataset table it reads the table's own upload row.

Effective credit weight: 1.

Argument	Kind	Default	Description
`part`	`upload`	—	The upload part, from the `@part` reference.
`column`	`upload`	—	The upload column, from the `@part.column` reference.
`prefix`	`string`	—	Text written before the value. Valid on text and varchar columns.
`suffix`	`string`	—	Text written after the value. Valid on text and varchar columns.
`case`	`enum`	—	Letter case of the value, with the casing rules of its language. Valid on text and varchar columns.
`ascii`	`boolean`	`false`	Write the value in ASCII, using the romanized form of words. Valid on text and varchar columns.