Configuration property fixed at build time - All other configuration properties are overridable at runtime

Configuration property

Type

Default

whether a health check is published in case the smallrye-health extension is present

Environment variable: QUARKUS_NEO4J_HEALTH_ENABLED

boolean

true

If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present. When DevServices is enabled Quarkus will attempt to automatically configure and start a database when running in Dev or Test mode.

Environment variable: QUARKUS_NEO4J_DEVSERVICES_ENABLED

boolean

the container image name to use, for container based DevServices providers

Environment variable: QUARKUS_NEO4J_DEVSERVICES_IMAGE_NAME

string

neo4j:5

additional environment entries that can be added to the container before its start

Environment variable: QUARKUS_NEO4J_DEVSERVICES_ADDITIONAL_ENV__ADDITIONAL_ENV_

Map<String,String>

This value can be used to specify the port to which the bolt-port of the container is exposed. It must be a free port, otherwise startup will fail. A random, free port will be used by default. Either way, a messsage will be logged on which port the Neo4j container is reachable over bolt.

Ignored when container sharing is enabled.

Environment variable: QUARKUS_NEO4J_DEVSERVICES_BOLT_PORT

int

This value can be used to specify the port to which the http-port of the container is exposed. It must be a free port, otherwise startup will fail. A random, free port will be used by default. Either way, a messsage will be logged on which port the Neo4j Browser is available.

Ignored when container sharing is enabled.

Environment variable: QUARKUS_NEO4J_DEVSERVICES_HTTP_PORT

int

Indicates if the Neo4j server managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services for Neo4j starts a new container.

The discovery uses the quarkus-dev-service-neo4j label. The value is configured using the service-name property.

Container sharing is only used in dev mode and disabled by default

Environment variable: QUARKUS_NEO4J_DEVSERVICES_SHARED

boolean

false

The value of the quarkus-dev-service-neo4j label attached to the started container. This property is used when shared is set to true. In this case, before starting a container, Dev Services for Neo4j looks for a container with the quarkus-dev-service-neo4j label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the quarkus-dev-service-neo4j label set to the specified value.

This property is used when you need multiple shared Neo4j servers.

Environment variable: QUARKUS_NEO4J_DEVSERVICES_SERVICE_NAME

string

neo4j

This property is used only when you create multiple shared Neo4j servers

Environment variable: QUARKUS_NEO4J_DEVSERVICES_SHARED_PASSWORD

string

verysecret

the uri this driver should connect to. The driver supports bolt, bolt+routing or neo4j as schemes

Environment variable: QUARKUS_NEO4J_URI

string

bolt://localhost:7687

if the driver should use encrypted traffic

Environment variable: QUARKUS_NEO4J_ENCRYPTED

boolean

false

the maximum time transactions are allowed to retry

Environment variable: QUARKUS_NEO4J_MAX_TRANSACTION_RETRY_TIME

Duration 

30S

return the authentication}

Type

Default

the login of the user connecting to the database

Environment variable: QUARKUS_NEO4J_AUTHENTICATION_USERNAME

string

neo4j

the password of the user connecting to the database

Environment variable: QUARKUS_NEO4J_AUTHENTICATION_PASSWORD

string

neo4j

whether disable authentication or not

Environment variable: QUARKUS_NEO4J_AUTHENTICATION_DISABLED

boolean

false

An optional field that when is not empty has precedence over username and password. It behaves the same way as NEO4J_AUTH in the official docker image, containing both the username and password separated via a single forward slash (/).

Environment variable: QUARKUS_NEO4J_AUTHENTICATION_VALUE

string

return the trust settings for encrypted traffic}

Type

Default

which trust strategy to apply when using encrypted traffic

Environment variable: QUARKUS_NEO4J_TRUST_SETTINGS_STRATEGY

trust-all-certificates, trust-custom-ca-signed-certificates, trust-system-ca-signed-certificates

trust-system-ca-signed-certificates

the file of the certificate to use

Environment variable: QUARKUS_NEO4J_TRUST_SETTINGS_CERT_FILE

path

whether hostname verification is used

Environment variable: QUARKUS_NEO4J_TRUST_SETTINGS_HOSTNAME_VERIFICATION_ENABLED

boolean

false

return the connection pool}

Type

Default

lag, if metrics are enabled

Environment variable: QUARKUS_NEO4J_POOL_METRICS_ENABLED

boolean

false

if leaked sessions logging is enabled

Environment variable: QUARKUS_NEO4J_POOL_LOG_LEAKED_SESSIONS

boolean

false

the maximum amount of connections in the connection pool towards a single database

Environment variable: QUARKUS_NEO4J_POOL_MAX_CONNECTION_POOL_SIZE

int

100

Pooled connections that have been idle in the pool for longer than this timeout will be tested before they are used again. The value 0 means connections will always be tested for validity and negative values mean connections will never be tested.

Environment variable: QUARKUS_NEO4J_POOL_IDLE_TIME_BEFORE_CONNECTION_TEST

Duration 

-0.001S

Pooled connections older than this threshold will be closed and removed from the pool.

Environment variable: QUARKUS_NEO4J_POOL_MAX_CONNECTION_LIFETIME

Duration 

1H

Acquisition of new connections will be attempted for at most configured timeout.

Environment variable: QUARKUS_NEO4J_POOL_CONNECTION_ACQUISITION_TIMEOUT

Duration 

1M

About the Duration format

To write duration values, use the standard java.time.Duration format. See the Duration#parse() Java API documentation for more information.

You can also use a simplified format, starting with a number:

  • If the value is only a number, it represents time in seconds.

  • If the value is a number followed by ms, it represents time in milliseconds.

In other cases, the simplified format is translated to the java.time.Duration format for parsing:

  • If the value is a number followed by h, m, or s, it is prefixed with PT.

  • If the value is a number followed by d, it is prefixed with P.