workload_definition.template_variables.md Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of engine-api Show documentation

The engine API for nosqlbench; Provides the interfaces needed to build internal modules for the nosqlbench core engine

There is a newer version: 5.17.0

# Template Variables

Template variables allow for workload descriptions to be parameterized outside the structure of the
templating language.

Template variables are resolved in the workload after the on-disk format is loaded and before yaml parsing.

## angle bracket value with defaults

*yaml:*
```yaml
name: <>
desc: <>
```

*json:*
```json5
{
    "name": "thedefault",
    "desc": "mydescription"
}
```

*ops:*
```json5
[]
```

It's easier on syntax checkers if you use this form.

## call form with defaults

*yaml:*
```yaml
name: TEMPLATE(myname,thedefault)
```

*json:*
```json5
{
    "name": "thedefault"
}
```

*ops:*
```json5
[]
```

## call form with no default, requires input

*yaml:*
```yaml
name: TEMPLATE(myname)
```

*json:*
```json5
{
    "name": "UNSET:myname"
}
```

*ops:*
```json5
[]
```

## call form with null default

*yaml:*
```yaml
name: TEMPLATE(myname,)
```

*json:*
```json5
{
    "name": null
}
```

*ops:*
```json5
[]
```