mirror of
https://github.com/nosqlbench/nosqlbench.git
synced 2025-02-25 18:55:28 -06:00
misc content cleanups
This commit is contained in:
parent
4f33a910d0
commit
4dd86283d4
@ -3,6 +3,8 @@ title: 00 YAML Organization
|
||||
weight: 00
|
||||
---
|
||||
|
||||
# YAML Organization
|
||||
|
||||
It is best to keep every workload self-contained within a single YAML file, including schema, data rampup, and the main
|
||||
phase of testing. The phases of testing are controlled by tags as described in the Standard YAML section.
|
||||
|
||||
@ -11,7 +13,7 @@ The phase names described below have been adopted as a convention within the bui
|
||||
that new workload YAMLs use the same tagging scheme so that workload are more plugable across YAMLs.
|
||||
:::
|
||||
|
||||
### Schema phase
|
||||
## Schema phase
|
||||
|
||||
The schema phase is simply a phase of your test which creates the necessary schema on your target system. For CQL, this
|
||||
generally consists of a keyspace and one ore more table statements. There is no special schema layer in nosqlbench. All
|
||||
@ -28,7 +30,7 @@ block:
|
||||
tags:
|
||||
phase: schema
|
||||
|
||||
### Rampup phase
|
||||
## Rampup phase
|
||||
|
||||
When you run a performance test, it is very important to be aware of how much data is present. Higher density tests are
|
||||
more realistic for systems which accumulate data over time, or which have a large working set of data. The amount of
|
||||
@ -51,7 +53,7 @@ block:
|
||||
tags:
|
||||
phase: rampup
|
||||
|
||||
### Main phase
|
||||
## Main phase
|
||||
|
||||
The main phase of a nosqlbench scenario is the one during which you really care about the metric. This is the actual
|
||||
test that everything else has prepared your system for.
|
||||
|
@ -3,7 +3,7 @@ title: 01 Statement Templates
|
||||
weight: 01
|
||||
---
|
||||
|
||||
## Statement Templates
|
||||
# Statement Templates
|
||||
|
||||
A valid config file for an activity consists of statement templates, parameters for them, bindings to generate the data
|
||||
to use with them, and tags for organizing them.
|
||||
|
@ -3,7 +3,7 @@ title: 02 Data Bindings
|
||||
weight: 02
|
||||
---
|
||||
|
||||
## Data Bindings
|
||||
# Data Bindings
|
||||
|
||||
Procedural data generation is built-in to the nosqlbench runtime by way of the
|
||||
[Virtual DataSet](http://virtdata.io/) library. This allows us to create named data generation recipes. These named
|
||||
|
@ -4,7 +4,7 @@ weight: 03
|
||||
|
||||
---
|
||||
|
||||
## Statement Parameters
|
||||
# Statement Parameters
|
||||
|
||||
Statements within a YAML can be accessorized with parameters. These are known as _statement params_ and are different
|
||||
than the parameters that you use at the activity level. They apply specifically to a statement template, and are
|
||||
|
@ -3,7 +3,7 @@ title: 04 Statement Tags
|
||||
weight: 04
|
||||
---
|
||||
|
||||
## Statement Tags
|
||||
# Statement Tags
|
||||
|
||||
Tags are used to mark and filter groups of statements for controlling which ones get used in a given scenario. Tags are
|
||||
generally free-form, but there is a set of conventions that can make your testing easier.
|
||||
|
@ -3,7 +3,7 @@ title: 05 Statement Blocks
|
||||
weight: 05
|
||||
---
|
||||
|
||||
## Statement Blocks
|
||||
# Statement Blocks
|
||||
|
||||
All the basic primitives described above (names, statements, bindings, params, tags) can be used to describe and
|
||||
parameterize a set of statements in a yaml document. In some scenarios, however, you may need to structure your
|
||||
|
@ -3,7 +3,7 @@ title: YAML Diagnostics
|
||||
weight: 99
|
||||
---
|
||||
|
||||
## Diagnostics
|
||||
# YAML Diagnostics
|
||||
|
||||
This section describes errors that you might see if you have a YAML loading issue, and what you can do to fix them.
|
||||
|
||||
|
@ -3,6 +3,8 @@ title: Driver Types
|
||||
weight: 50
|
||||
---
|
||||
|
||||
# Driver Types
|
||||
|
||||
Each nosqlbench scenario is comprised of one or more activities of a specific type. The types of activities available
|
||||
are provided by the version of nosqlbench.
|
||||
|
||||
|
@ -3,7 +3,7 @@ title: NoSQLBench Intro
|
||||
weight: 0
|
||||
---
|
||||
|
||||
## Welcome to NoSQLBench
|
||||
# Welcome to NoSQLBench
|
||||
|
||||
Welcome to the documentation for NoSQLBench. This is a power tool that emulates real application workloads. This means
|
||||
that you can fast-track performance, sizing and data model testing without writing your own testing harness.
|
||||
|
@ -2,7 +2,7 @@
|
||||
title: CLI Scripting
|
||||
---
|
||||
|
||||
# CLI Scripting
|
||||
# Command-Line Scripting
|
||||
|
||||
Sometimes you want to to run a set of workloads in a particular order, or call other specific test setup logic in
|
||||
between phases or workloads. While the full scripting environment allows you to do this and more, it is not necessary to
|
||||
|
@ -3,4 +3,6 @@ title: Reference
|
||||
weight: 90
|
||||
---
|
||||
|
||||
This section contains additional reference details across a range of nosqlbench topics.
|
||||
# Reference Section
|
||||
|
||||
This section contains additional reference details across a range of nosqlbench topics.
|
||||
|
@ -3,7 +3,7 @@ title: High Fidelity Metrics
|
||||
weight: 12
|
||||
---
|
||||
|
||||
# High Fidelity Metrics
|
||||
# High-Fidelity Metrics
|
||||
|
||||
Since NoSQLBench has been built as a serious testing tool for all users,
|
||||
some attention was necessary on the way metric are used.
|
||||
|
Loading…
Reference in New Issue
Block a user