Struct Neo4j

pub struct Neo4j { /* private fields */ }

Available on crate feature neo4j only.

Neo4j image for testcontainers.

This image is based on the official Neo4j image. The default user is neo4j and the default password is neo. The default version is 5.

Example

use testcontainers_modules::{neo4j::Neo4j, testcontainers::runners::SyncRunner};

let container = Neo4j::default().start().unwrap();
let uri = format!(
    "bolt://{}:{}",
    container.get_host().unwrap(),
    container.image().bolt_port_ipv4().unwrap()
);
let auth_user = container.image().user();
let auth_pass = container.image().password();
// connect to Neo4j with the uri, user and pass

Neo4j Version

The version of the image can be set with the NEO4J_VERSION_TAG environment variable. The default version is 5. The available versions can be found on Docker Hub.

The used version can be retrieved with the version method.

Auth

The default user is neo4j and the default password is neo.

The used user can be retrieved with the user method. The used password can be retrieved with the pass method.

Environment variables

The following environment variables are supported:

• NEO4J_VERSION_TAG: The default version of the image to use.
• NEO4J_TEST_USER: The default user to use for authentication.
• NEO4J_TEST_PASS: The default password to use for authentication.

Neo4j Labs Plugins

Neo4j offers built-in support for Neo4j Labs plugins. The method with_neo4j_labs_plugin can be used to define them.

Supported plugins are APOC, APOC Core, Bloom, Streams, Graph Data Science, and Neo Semantics.

Implementations

impl Neo4j

pub fn new() -> Self

Create a new instance of a Neo4j image.

pub fn with_version(self, version: impl Into<Cow<'static, str>>) -> Self

Set the Neo4j version to use. The value must be an existing Neo4j version tag.

pub fn with_user(self, user: impl Into<Cow<'static, str>>) -> Self

Set the username to use.

pub fn with_password(self, pass: impl Into<Cow<'static, str>>) -> Self

Set the password to use.

pub fn without_authentication(self) -> Self

Do not use any authentication on the testcontainer.

Setting this will override any prior usages of Self::with_user and Self::with_password.

pub fn with_neo4j_labs_plugin(self, plugins: &[Neo4jLabsPlugin]) -> Self

Add Neo4j lab plugins to get started with the database.

Trait Implementations

impl Clone for Neo4j

fn clone(&self) -> Neo4j

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Neo4j

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Neo4j

fn default() -> Self

Returns the “default value” for a type.

impl From<Neo4j> for ContainerRequest<Neo4jImage>

fn from(neo4j: Neo4j) -> Self

Converts to this type from the input type.

impl From<Neo4j> for Neo4jImage

fn from(neo4j: Neo4j) -> Self

Converts to this type from the input type.

impl PartialEq for Neo4j

fn eq(&self, other: &Neo4j) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Neo4j

impl StructuralPartialEq for Neo4j