mirror of
https://github.com/nosqlbench/nosqlbench.git
synced 2025-02-25 18:55:28 -06:00
minor doc updates
This commit is contained in:
parent
b8a71de405
commit
368843191e
@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Scripting
|
title: Scripting
|
||||||
weight: 10
|
weight: 95
|
||||||
---
|
---
|
||||||
|
|
||||||
# Scripting with NoSQLBench
|
# Scripting with NoSQLBench
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Scripting
|
title: Script Parameters
|
||||||
weight: 10
|
weight: 20
|
||||||
---
|
---
|
||||||
|
|
||||||
# Script Parameters
|
# Script Parameters
|
||||||
@ -15,20 +15,21 @@ that you would for an activity. For example, you might have a scenario script li
|
|||||||
cycles: '1000'
|
cycles: '1000'
|
||||||
});
|
});
|
||||||
|
|
||||||
This is what the script form of starting an activity in a scenario might look like. It is
|
This is what the script form of starting an activity might look like. It is
|
||||||
simply passing a parameter map with the activity parameters to the scenario controller.
|
simply passing a parameter map with the activity parameters to the scenario controller.
|
||||||
|
|
||||||
You might invoke it like this:
|
You might invoke it like this:
|
||||||
|
|
||||||
nb script myscript
|
nb script myscript
|
||||||
|
|
||||||
Suppose that you want to allow the user to run such an activity by calling the script directly,
|
Suppose that you want to allow the user to run such an activity by calling the script directly,
|
||||||
but you also want them to to allow them to add their own parameters specifically to the
|
but you also want them to allow them to add their own parameters specifically to the
|
||||||
activity.
|
activity.
|
||||||
|
|
||||||
NoSQLBench supports this type of flexibility by providing any command-line arguments to the
|
NoSQLBench supports this type of flexibility by providing any command-line arguments to the
|
||||||
script as a script object. It is possible to then combine the parameters that a user provides
|
script as a script object. It is possible to then combine the parameters that a user provides
|
||||||
with any templated parameters in your script. You can make either one the primary, while allowing
|
with any templated parameters in your script. You can make either one the primary, while allowing
|
||||||
the otehr to backfill values. In either case, it's a matter of using helper methods that are
|
the other to backfill values. In either case, it's a matter of using helper methods that are
|
||||||
baked into the command line parameters object.
|
baked into the command line parameters object.
|
||||||
|
|
||||||
To force parameters to specific values while allowing user command line parameters to backfill,
|
To force parameters to specific values while allowing user command line parameters to backfill,
|
||||||
|
@ -0,0 +1,43 @@
|
|||||||
|
---
|
||||||
|
title: Scripting Extensions
|
||||||
|
weight: 30
|
||||||
|
---
|
||||||
|
|
||||||
|
# Scripting Extensions
|
||||||
|
|
||||||
|
Extensions are injected into the scripting environment as plugins. They appear as service
|
||||||
|
objects in the script environment under a name determined by the plugin.
|
||||||
|
|
||||||
|
This section describes some of the scripting extensions available.
|
||||||
|
|
||||||
|
## csvmetrics
|
||||||
|
|
||||||
|
Allows a script to log some or all metrics to CSV files.
|
||||||
|
|
||||||
|
## files
|
||||||
|
|
||||||
|
Allows for convenient read access to local files.
|
||||||
|
|
||||||
|
## globalvars
|
||||||
|
|
||||||
|
Allows access to the shared variable state that can be populated from operations.
|
||||||
|
|
||||||
|
## histologger
|
||||||
|
|
||||||
|
Allows script control of HDR histogram interval logging.
|
||||||
|
|
||||||
|
## histostatslogger
|
||||||
|
|
||||||
|
Allows script control of histogram stats logging in CSV files.
|
||||||
|
|
||||||
|
## http
|
||||||
|
|
||||||
|
Easily use http get and post in scripts.
|
||||||
|
|
||||||
|
## optimos
|
||||||
|
|
||||||
|
Allows use of the BOBYQA optimizer in scripts.
|
||||||
|
|
||||||
|
## scriptingmetrics
|
||||||
|
|
||||||
|
Allows you to create and append metrics within your scenario scripts
|
Loading…
Reference in New Issue
Block a user