Skip to main content

cypher

EXPERIMENTAL

This component is experimental and therefore subject to change or removal outside of major version releases.

Executes a Cypher Query

Introduced in version 1.4.0.

# Common config fields, showing default values
output:
  label: ""
  cypher:
    query: 'CREATE (p:Person {name: $name}) RETURN p' # No default (required)
    values: {}
    max_in_flight: 64
    database: neo4j # No default (required)
    uri: bolt://localhost:7687 # No default (required)
    no_auth: false
    basic_auth:
      user: ""
      password: ""
      realm: ""
    batching:
      count: 0
      byte_size: 0
      period: ""
      jitter: 0
      check: ""

Executes a Cypher Query​

The query field is expected to be a valid cypher query with 0 or more parameters with the $ syntax:

    query: CREATE (p:Person {name: $name, age: $age}) RETURN p

The values field is expected to be a map where the keys are equal to the parameters in the query, and the values are strings (bloblang interpolations are allowed):

    values: 
      name: ${! json("name") }
      age: ${! json("age") }

Examples​

Here we execute a cypher query that takes the value of $name from the interpolated field in the values map:

output:
  cypher:
    database: neo4j
    uri: bolt://localhost:7687
    basic_auth:
      user: neo4j
      password: password
    query: |
      CREATE (p:Person {name: $name}) RETURN p
    values: 
      name: ${! json("name") }
    batching:
      count: 0

Fields​

query​

The cypher query to execute.

Type: string

# Examples

query: 'CREATE (p:Person {name: $name}) RETURN p'

values​

A map of strings -> bloblang interpolations that form the values of the references in the query i.e. $name. This field supports interpolation functions.

Type: object
Default: {}

# Examples

values:
  name: ${! json("name") }

max_in_flight​

The maximum number of messages to have in flight at a given time. Increase this to improve throughput.

Type: int
Default: 64

database​

The name of the database to connect to.

Type: string

# Examples

database: neo4j

uri​

The URL of the database engine.

Type: string

# Examples

uri: bolt://localhost:7687

no_auth​

Set to true to connect without authentication.

Type: bool
Default: false

basic_auth​

Basic Authentication fields

Type: object

basic_auth.user​

The username for basic auth.

Type: string
Default: ""

basic_auth.password​

The password for basic auth.

Secret

This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info.

Type: string
Default: ""

basic_auth.realm​

The realm for basic auth.

Type: string
Default: ""

tls​

Custom TLS settings can be used to override system defaults.

Type: object

tls.enabled​

Whether custom TLS settings are enabled.

Type: bool
Default: false

tls.skip_cert_verify​

Whether to skip server side certificate verification.

Type: bool
Default: false

tls.enable_renegotiation​

Whether to allow the remote server to repeatedly request renegotiation. Enable this option if you're seeing the error message local error: tls: no renegotiation.

Type: bool
Default: false
Requires version 1.0.0 or newer

tls.root_cas​

An optional root certificate authority to use. This is a string, representing a certificate chain from the parent trusted root certificate, to possible intermediate signing certificates, to the host certificate.

Secret

This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info.

Type: string
Default: ""

# Examples

root_cas: |-
  -----BEGIN CERTIFICATE-----
  ...
  -----END CERTIFICATE-----

tls.root_cas_file​

An optional path of a root certificate authority file to use. This is a file, often with a .pem extension, containing a certificate chain from the parent trusted root certificate, to possible intermediate signing certificates, to the host certificate.

Type: string
Default: ""

# Examples

root_cas_file: ./root_cas.pem

tls.client_certs​

A list of client certificates to use. For each certificate either the fields cert and key, or cert_file and key_file should be specified, but not both.

Type: array
Default: []

# Examples

client_certs:
  - cert: foo
    key: bar

client_certs:
  - cert_file: ./example.pem
    key_file: ./example.key

tls.client_certs[].cert​

A plain text certificate to use.

Type: string
Default: ""

tls.client_certs[].key​

A plain text certificate key to use.

Secret

This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info.

Type: string
Default: ""

tls.client_certs[].cert_file​

The path of a certificate to use.

Type: string
Default: ""

tls.client_certs[].key_file​

The path of a certificate key to use.

Type: string
Default: ""

tls.client_certs[].password​

A plain text password for when the private key is password encrypted in PKCS#1 or PKCS#8 format. The obsolete pbeWithMD5AndDES-CBC algorithm is not supported for the PKCS#8 format. Warning: Since it does not authenticate the ciphertext, it is vulnerable to padding oracle attacks that can let an attacker recover the plaintext.

Secret

This field contains sensitive information that usually shouldn't be added to a config directly, read our secrets page for more info.

Type: string
Default: ""

# Examples

password: foo

password: ${KEY_PASSWORD}

batching​

Allows you to configure a batching policy.

Type: object

# Examples

batching:
  byte_size: 5000
  count: 0
  period: 1s

batching:
  count: 10
  period: 1s

batching:
  check: this.contains("END BATCH")
  count: 0
  period: 1m

batching:
  count: 10
  jitter: 0.1
  period: 10s

batching.count​

A number of messages at which the batch should be flushed. If 0 disables count based batching.

Type: int
Default: 0

batching.byte_size​

An amount of bytes at which the batch should be flushed. If 0 disables size based batching.

Type: int
Default: 0

batching.period​

A period in which an incomplete batch should be flushed regardless of its size.

Type: string
Default: ""

# Examples

period: 1s

period: 1m

period: 500ms

batching.jitter​

A non-negative factor that adds random delay to batch flush intervals, where delay is determined uniformly at random between 0 and jitter * period. For example, with period: 100ms and jitter: 0.1, each flush will be delayed by a random duration between 0-10ms.

Type: float
Default: 0

# Examples

jitter: 0.01

jitter: 0.1

jitter: 1

batching.check​

A Bloblang query that should return a boolean value indicating whether a message should end a batch.

Type: string
Default: ""

# Examples

check: this.type == "end_of_transaction"

batching.processors​

A list of processors to apply to a batch as it is flushed. This allows you to aggregate and archive the batch however you see fit. Please note that all resulting messages are flushed as a single batch, therefore splitting the batch into smaller batches using these processors is a no-op.

Type: array

# Examples

processors:
  - archive:
      format: concatenate

processors:
  - archive:
      format: lines

processors:
  - archive:
      format: json_array