docs update for refs/tags/5.21.4-preview

site/content/reference/apps/cqlgen.md

@@ -1,6 +1,6 @@
 ---
-weight: 156400102
 title: cqlgen
+weight: 156400102
 ---
 # cqlgen
 

site/content/reference/apps/export-docs.md

@@ -1,6 +1,6 @@
 ---
-weight: 233772542
 title: export-docs
+weight: 233772542
 ---
 # export-docs
 

site/content/reference/apps/virtdata.md

@@ -1,6 +1,6 @@
 ---
-weight: 225811593
 title: virdata
+weight: 225811593
 ---
 # virdata
 

site/content/reference/bindings/binding-concepts.md

@@ -0,0 +1,119 @@
+---
+title: Binding Concepts
+weight: 1
+---
+
+NoSQLBench has a built-in library for the flexible management and expressive use of
+procedural generation libraries. This section explains the core concepts
+of this library, known as _Virtual Data Set_.
+
+## Basic Example
+
+These functions can be stitched together in small recipes. When you give
+these mapping functions useful names in your workloads, they are called
+bindings.
+
+Here is an example:
+
+```yaml
+bindings:
+ numbers: NumberNameToString()
+ names: FirstNames()
+```
+
+These are two bindings that you can use in your workloads. The names on the left
+are the _binding names_ and the functions on the right are the _binding recipes_.
+Altogether, we just call them _bindings_.
+
+
+## Variates (Samples)
+
+A numeric sample that is drawn from a distribution for the purpose
+of simulation or analysis is called a *Variate*.
+
+## Procedural Generation
+
+Procedural generation is a category of algorithms and techniques which take
+a set or stream of inputs and produce an output in a different form or structure.
+While it may appear that procedural generation actually _generates_ data, no output
+can come from a void. These techniques simply perturb a value in some stateful way,
+or map a coordinate system to another representation. Sometimes, both techniques are
+combined together.
+
+## Uniform Variate
+
+A variate (sample) drawn from a uniform (flat) distribution is what we are used
+to seeing when we ask a system for a "random" value. These are often produced in
+one of two very common forms, either a register full of bits as with most hashing
+functions, or a floating point value between 0.0 and 1.0. (This is called the _unit
+interval_).
+
+Uniform variates are not really random. Without careful attention to API usage,
+such random samples are not even unique from session to session. In many systems,
+the programmer has to be very careful to seed the random generator or they will
+get the same sequence of numbers every time they run their program. This turns out
+to be a useful property, and the random number generators that behave this way are
+usually called Pseudo-Random Number Generators, or PRNGs.
+
+## Apparently Random Variates
+
+Uniform variates produced by PRNGs are not actually random, even though they may
+pass certain tests for randomness. The streams of values produced are nearly
+always measurably random by some meaningful standard. However, they can be
+used again in exactly the same way with the same initial seed.
+
+## Deterministic Variates
+
+If you intentionally avoid randomizing the initial seed for a PRNG, for example,
+with the current timestamp, then it gives you a way to replay a sequence.
+You can think of each initial seed as a _bank_ of values which you can go back
+to at any time. However, when using stateful PRNGs as a way to provide these
+variates, your results will be order dependent.
+
+## Randomly Accessible Determinism
+
+Instead of using a PRNG, it is possible to use a hash function instead. With a 64-bit
+register, you have 2^64 (2^63 in practice due to available implementations) possible
+values. If your hash function has high dispersion, then you will effectively
+get the same result of apparent randomness as well as deterministic sequences, even
+when you use simple sequences of inputs to your _random()_ function. This allows
+you to access a random value in bucket 57, for example, and go back to it at any
+time and in any order to get the same value again.
+
+## Data Mapping Functions
+
+The data mapping functions are the core building block of virtual data set.
+Data mapping functions are generally pure functions. This simply means that
+a generator function will always provide the same result given the same input.
+The parameters that you will see on some binding recipes are not representative
+of volatile state. These parameters are initializer values which are part of a
+function's definition. For example a `Mod(5)` will always behave like a `Mod(5)`,
+as a pure function. But a `Mod(7)` will behave differently than a `Mod(5)`, although
+each function will always produce its own stable result for a given input.
+
+## Combining RNGs and Data Mapping Functions
+
+Because pure functions play such a key part in procedural generation techniques,
+the terms "data mapping function", "data mapper" and "data mapping library" will
+be more common in the library than "generator". Conceptually, mapping functions
+to not generate anything. It makes more sense to think of mapping data from one
+domain to another. Even so, the data that is yielded by mapping functions can
+appear quite realistic.
+
+Because good RNGs do generally contain internal state, they aren't purely
+functional. This means that in some cases -- those in which you need to have
+random access to a virtual data set, hash functions make more sense. This
+toolkit allows you to choose between the two in some cases. However, it
+generally favors using hashing and pure-function approaches where possible. Even
+the statistical curve simulations do this.
+
+## Bindings Template
+
+It is often useful to have a template that describes a set of generator
+functions that can be reused across many threads or other application scopes. A
+bindings template is a way to capture the requested generator functions for
+re-use, with actual scope instantiation of the generator functions controlled by
+the usage point. For example, in a JEE app, you may have a bindings template in
+the application scope, and a set of actual bindings within each request (thread
+scope).
+

site/content/reference/bindings/funcref_HOF.md

@@ -1,6 +1,6 @@
 ---
-weight: 25968606
 title: CqlVector
+weight: 25968606
 ---
 ## CqlVector
 

site/content/reference/bindings/funcref_collections.md

@@ -1,6 +1,6 @@
 ---
-weight: 40
 title: collection functions
+weight: 40
 ---
 
 Collection functions allow you to construct Java Lists, Maps or Sets.

site/content/reference/bindings/funcref_combinitoric.md

@@ -1,6 +1,6 @@
 ---
-weight: 158140750
 title: Combiner
+weight: 158140750
 ---
 ## Combiner
 

site/content/reference/bindings/funcref_conversion.md

@@ -1,6 +1,6 @@
 ---
-weight: 30
 title: conversion functions
+weight: 30
 ---
 
 Conversion functions simply allow values of one type

site/content/reference/bindings/funcref_datetime.md

@@ -1,6 +1,6 @@
 ---
-weight: 20
 title: datetime functions
+weight: 20
 ---
 
 Functions in this category know about times and dates, datetimes, seconds or millisecond epoch times, and so forth.

site/content/reference/bindings/funcref_diagnostics.md

@@ -1,6 +1,6 @@
 ---
-weight: 40
 title: diagnostic functions
+weight: 40
 ---
 
 Diagnostic functions can be used to help you construct the right VirtData recipe.

site/content/reference/bindings/funcref_distributions.md

@@ -1,6 +1,6 @@
 ---
-weight: 30
 title: distribution functions
+weight: 30
 ---
 
 All of the distributions that are provided in the Apache Commons Math

site/content/reference/bindings/funcref_experimental.md

@@ -1,6 +1,6 @@
 ---
-weight: 154485593
 title: DNN_angular1_neighbors
+weight: 154485593
 ---
 ## DNN_angular1_neighbors
 

site/content/reference/bindings/funcref_functional.md

@@ -1,6 +1,6 @@
 ---
-weight: 40
 title: flow functions
+weight: 40
 ---
 
 These functions help combine other functions into higher-order functions when needed.

site/content/reference/bindings/funcref_general.md

@@ -1,6 +1,6 @@
 ---
-weight: 20
 title: general functions
+weight: 20
 ---
 
 These functions have no particular category, so they ended up here by default.

site/content/reference/bindings/funcref_nulls.md

@@ -1,6 +1,6 @@
 ---
-weight: 40
 title: null functions
+weight: 40
 ---
 
 These functions can generate null values. When using nulls in your binding recipes, ensure that you don't generate them

site/content/reference/bindings/funcref_objects.md

@@ -1,6 +1,6 @@
 ---
-weight: 154805211
 title: Distance
+weight: 154805211
 ---
 ## Distance
 

site/content/reference/bindings/funcref_periodic.md

@@ -1,6 +1,6 @@
 ---
-weight: 10014
 title: Sin
+weight: 10014
 ---
 ## Sin
 

site/content/reference/bindings/funcref_premade.md

@@ -1,6 +1,6 @@
 ---
-weight: 20
 title: pre-made functions
+weight: 20
 ---
 
 Functions in this category are meant to provide easy grab-and-go functions that are tailored for real-world simulation.

site/content/reference/bindings/funcref_readers.md

@@ -1,6 +1,6 @@
 ---
-weight: 55333503
 title: FVecReader
+weight: 55333503
 ---
 ## FVecReader
 

site/content/reference/bindings/funcref_state.md

@@ -1,6 +1,6 @@
 ---
-weight: 30
 title: state functions
+weight: 30
 ---
 
 Functions in the state category allow you to do things with side-effects in the function flow. Specifically, they allow

site/content/reference/bindings/funcref_statistics.md

@@ -1,6 +1,6 @@
 ---
-weight: 234087331
 title: LongStats
+weight: 234087331
 ---
 ## LongStats
 

site/content/reference/bindings/funcref_vectors.md

@@ -1,6 +1,6 @@
 ---
-weight: 52584703
 title: DoubleVectorPadLeft
+weight: 52584703
 ---
 ## DoubleVectorPadLeft
 

site/content/reference/drivers/amqp.md

@@ -1,6 +1,6 @@
 ---
-weight: 275768
 title: AMQP
+weight: 275768
 ---
 - [1. Overview](#1-overview)
 - [2. NB AMQP Usage](#2-nb-amqp-usage)

site/content/reference/drivers/cqld4.md

@@ -1,6 +1,6 @@
 ---
-weight: 1889486
 title: cqld4
+weight: 1889486
 ---
 # cqld4
 

site/content/reference/drivers/dataapi.md

@@ -1,6 +1,6 @@
 ---
-weight: 470823
 title: Data API
+weight: 470823
 ---
 # Data API
 ## DataStax Data API Adapter

site/content/reference/drivers/diag.md

@@ -1,6 +1,6 @@
 ---
-weight: 106667
 title: diag
+weight: 106667
 ---
 # diag
 

site/content/reference/drivers/driver-discovery.md

@@ -0,0 +1,39 @@
++++
+title= "Built-In Adapters"
+weight= 1
++++
+
+# Built-In Adapters
+
+NoSQLBench supports a variety of different operations. For operations like
+sending a query to a database, a native driver is typically used with help of the
+DriverAdapter API. For basic operations, like writing the content of a templated
+message to stdout, no native driver is needed, although the mechanism of stdout
+is still implemented via the same Adapter API. In effect, if you want to
+allow NoSQLBench to understand your op templates in a new way, you add an Adapter
+and program it to interpret op templates in a specific way.
+
+Each op template of an activity can be configured to use a specific adapter. The `driver=...`
+parameter sets the default adapter to use for all op templates in an activity. However,
+this can be overridden per op template with the `driver` field.
+
+# Discovering Driver Adapters
+
+NoSQLBench comes with some drivers built-in. You can discover these by running:
+
+    nb5 --list-drivers
+
+Each one comes with its own built-in documentation. It can be accessed with this command:
+
+    nb5 help <driver>
+
+This section contains the per-driver documentation that you get when you run the above command.
+These driver docs are  auto-populated when NoSQLBench is built, so they are exactly the same as
+you will see with the above command, only rendered in HTML.
+
+# External Adapter jars
+
+It is possible to load an adapter from a jar at runtime. If the environment variable `NBLIBDIR`
+is set, it is taken as a library search path for jars, separated by a colon. For each element in the
+lib paths that exists, it is added to the classpath. If the element is a named .jar file, it is
+added. If it is a directory, then all jar files in that directory are added.

site/content/reference/drivers/dynamodb.md

@@ -1,6 +1,6 @@
 ---
-weight: 171833391
 title: dynamodb
+weight: 171833391
 ---
 # dynamodb
 

site/content/reference/drivers/http.md

@@ -1,6 +1,6 @@
 ---
-weight: 277985
 title: http
+weight: 277985
 ---
 # http
 

site/content/reference/drivers/kafka.md

@@ -1,6 +1,6 @@
 ---
-weight: 180150
 title: Kafka
+weight: 180150
 ---
 - [1. Overview](#1-overview)
     - [1.1. Example NB Yaml](#11-example-nb-yaml)

site/content/reference/drivers/mongodb.md

@@ -1,6 +1,6 @@
 ---
-weight: 42157412
 title: MongoDB
+weight: 42157412
 ---
 # MongoDB
 

site/content/reference/drivers/neo4j.md

@@ -1,6 +1,6 @@
 ---
-weight: 16075045
 title: neo4j driver adapter
+weight: 16075045
 ---
 # neo4j driver adapter