IntenseFinance/nosqlbench
3
0
Fork 0
mirror of https://github.com/nosqlbench/nosqlbench.git synced 2024-12-24 16:00:09 -06:00
Code Issues Packages Projects Releases Wiki Activity
8e6a14ee43
nosqlbench/devdocs/devguide/drivers
History
Jonathan Shook 828ec0252d naming: use ParsedOp instead of ParsedCommand
2021-09-13 09:43:19 -05:00
..
driver_adapter_standards.md naming: use ParsedOp instead of ParsedCommand 2021-09-13 09:43:19 -05:00
driver_standards.md add guidelines on env vars 2021-07-20 18:26:50 -05:00
drivers_overview.md update wip devguide 2021-02-04 17:47:13 -06:00
nberrors_api.md update wip devguide 2021-02-04 17:47:13 -06:00
optemplate_api.md update wip devguide 2021-02-04 17:47:13 -06:00
optemplate.svg op template visualization 2021-02-04 23:15:56 -06:00
optemplates.png op template visualization 2021-02-04 23:15:56 -06:00
README.md update wip devguide 2021-02-04 17:47:13 -06:00

README.md

Driver Development

This section should have everything you need to know to build a successful driver in NoSQLBench.

If you are new to NoSQLBench concepts, you may want to read about drivers.

You'll want to be generally familiar with the current NoSQLBench driver standards. This document explains what a well-behaved driver can do. Much of what is requested in driver standards is directly supported by a set of supporting APIs which are provided to all driver implementations. It may seem like a high bar to request this of developers, but without such guidelines, a bar is set nonetheless. The aim of this is to help define and clarify how to make a good driver.

Driver APIs

  • NBOpTemplate - Op Templating - This is the recommended way to map user-level semantics to driver-specific operations.
  • NBErrors - Uniform error handling - A modular and configurable error handler which new drivers should use by default.