Driver

The bookmark managed used by Driver.executeQuery

Close all open sessions and other associated resources. You should make sure to use this when you are done with this driver instance.

Executes a query in a retriable context and returns a EagerResult.

This method is a shortcut for a Session#executeRead and Session#executeWrite.

NOTE: Because it is an explicit transaction from the server point of view, Cypher queries using "CALL {} IN TRANSACTIONS" or the older "USING PERIODIC COMMIT" construct will not work (call Session#run for these).

Example:

// Run a simple write query
const { keys, records, summary } = await driver.executeQuery('CREATE (p:Person{ name: $name }) RETURN p', { name: 'Person1'})

// Run a read query
const { keys, records, summary } = await driver.executeQuery(
   'MATCH (p:Person{ name: $name }) RETURN p',
   { name: 'Person1'},
   { routing: neo4j.routing.READ})

// Run a read query returning a Person Nodes per elementId
const peopleMappedById = await driver.executeQuery(
   'MATCH (p:Person{ name: $name }) RETURN p',
   { name: 'Person1'},
   {
     resultTransformer: neo4j.resultTransformers.mappedResultTransformer({
       map(record) {
         const p = record.get('p')
         return [p.elementId, p]
       },
       collect(elementIdPersonPairArray) {
         return new Map(elementIdPersonPairArray)
       }
     })
   }
)

const person = peopleMappedById.get("<ELEMENT_ID>")

// these lines
const transformedResult = await driver.executeQuery(
   "<QUERY>",
   <PARAMETERS>,
   {
      routing: neo4j.routing.WRITE,
      resultTransformer: transformer,
      database: "<DATABASE>",
      impersonatedUser: "<USER>",
      bookmarkManager: bookmarkManager
   })
// are equivalent to those
const session = driver.session({
   database: "<DATABASE>",
   impersonatedUser: "<USER>",
   bookmarkManager: bookmarkManager
})

try {
   const transformedResult = await session.executeWrite(tx => {
       const result = tx.run("<QUERY>", <PARAMETERS>)
       return transformer(result)
   })
} finally {
   await session.close()
}

See:

• resultTransformers for provided result transformers.

Returns the protocol version negotiated via handshake.

Note that this function call always causes a round-trip to the server.

Throw:

Get ServerInfo for the giver database.

Returns boolean to indicate if driver has been configured with encryption enabled.

Acquire a session to communicate with the database. The session will borrow connections from the underlying connection pool as required and should be considered lightweight and disposable.

This comes with some responsibility - make sure you always call close when you are done using a session, and likewise, make sure you don't close your session before you are done using it. Once it is closed, the underlying connection will be released to the connection pool and made available for others to use.

Returns whether the server supports multi database capabilities based on the protocol version negotiated via handshake.

Note that this function call always causes a round-trip to the server.

Returns whether the driver session re-auth functionality capabilities based on the protocol version negotiated via handshake.

Note that this function call always causes a round-trip to the server.

Returns whether the server supports transaction config capabilities based on the protocol version negotiated via handshake.

Note that this function call always causes a round-trip to the server.

Returns whether the server supports user impersonation capabilities based on the protocol version negotiated via handshake.

Note that this function call always causes a round-trip to the server.

This method verifies the authorization credentials work by trying to acquire a connection to one of the servers with the given credentials.

Verifies connectivity of this driver by trying to open a connection with the provided driver options.