bigmontz / experimental-query-api-wrapper

Experimental wrapper library to access Neo4j Query API using a neo4j-driver-like interface.

experimental-query-api-wrapper

Warning

This is an experiment which should not be used in production environments. Use in your own risk.

Experimental wrapper library to access Neo4j Query API using a neo4j-driver-like interface.

Quickstart

Requirements:

Node >= 18
Neo4j >= 5.23

Installation:

$ npm i @neo4j-labs/experimental-query-api-wrapper --save

Usage:

example.js

import neo4j from '@neo4j-labs/experimental-query-api-wrapper'

const wrapper = neo4j.wrapper('http://localhost:7474', neo4j.auth.basic('neo4j', 'password'))

const session = wrapper.session({ database: 'neo4j', defaultAccessMode: 'READ' })

try {
    const { records, summary } = await session.run('MATCH (p:Person) RETURN p')

    for (const record of records) {
        console.log('Person', record.get('p').properties)
    }

    console.log('Summary', summary)
} finally {
    await session.close()
    await wrapper.close()
}