README.adoc

AsciiDoc Cypher Query Runner

Usage

Common environment variables

Name	Description	Default value
NEO4J_DATABASE_URI	URI address of the Neo4j database	bolt://localhost
NEO4J_DATABASE_USER	User used to authentificate on the Neo4j database	neo4j
NEO4J_DATABASE_PASSWORD	Password used to authentificate on the Neo4j database	neo4j
NEO4J_DATABASE_NAME	Name of the database (optional)
NEO4J_CONNECTION_ACQUISITION_TIMEOUT_SECONDS	The maximum amount of time to wait to acquire a connection from the Neo4j database (in seconds)	10

Antora

$ antora --generator @neo4j-documentation/asciidoc-cypher-query-runner/lib/antora/generate-site.js antora-playbook.yml

Environment variables

Name	Description	Default value
ASCIIDOC_CYPHER_RUNNER_IGNORE_ROLES	Ignore Cypher source blocks with that role (list separated by comma)
ASCIIDOC_CYPHER_RUNNER_FAIL_FAST	Fail fast and exit when it encounters an error
ASCIIDOC_CYPHER_RUNNER_NO_EXPLAIN	Execute queries instead of using EXPLAIN clause
ASCIIDOC_CYPHER_RUNNER_REPORTER_ERROR_FORMAT	Error format, must be either short or full	full
ASCIIDOC_CYPHER_RUNNER_REPORTER_ERROR_LIMIT	Display at most a given number of failures or errors	3

CLI

$ asciidoc-cypher-query-runner doc.adoc

Options

Option	Description	Default value
-i, --ignore-role <role>	Ignore Cypher source blocks with that role (this option may be specified more than once)
--fail-fast	Fail fast and exit when it encounters an error	false
--no-explain	Execute queries instead of using EXPLAIN clause	false
--reporter-error-limit <value>	Display at most a given number of failures or errors	3
--reporter-error-format <format>	Error format, must be either short or full	full

API

const asciidocCypherQueryRunner = require('@neo4j-documentation/asciidoc-cypher-query-runner')

const result = asciidocCypherQueryRunner.run('doc.adoc', {
  neo4jDatabase: { uri: '', user: '', password: '' },
  ignoreRoles: []
})