api documentation for neo4j-driver (v1.2.0)

Connect to Neo4j 3.1.0 and up from JavaScript

table of contents

  1. module neo4j-driver
    1. object neo4j-driver.buf
    2. object neo4j-driver.ch_dummy
    3. object neo4j-driver.chunking
    4. object neo4j-driver.connection_holder
    5. object neo4j-driver.connection_providers
    6. object neo4j-driver.connector
    7. object neo4j-driver.default
    8. object neo4j-driver.driver
    9. object neo4j-driver.error
    10. object neo4j-driver.features
    11. object neo4j-driver.get_servers_util
    12. object neo4j-driver.graph_types
    13. object neo4j-driver.host_name_resolvers
    14. object neo4j-driver.integer
    15. object neo4j-driver.packstream
    16. object neo4j-driver.pool
    17. object neo4j-driver.record
    18. object neo4j-driver.rediscovery
    19. object neo4j-driver.result
    20. object neo4j-driver.result_summary
    21. object neo4j-driver.round_robin_array
    22. object neo4j-driver.routing_driver
    23. object neo4j-driver.routing_table
    24. object neo4j-driver.session
    25. object neo4j-driver.stream_observer
    26. object neo4j-driver.transaction
    27. object neo4j-driver.transaction_executor
    28. object neo4j-driver.util
    29. object neo4j-driver.v1
    30. object neo4j-driver.v1.auth
    31. object neo4j-driver.v1.default
    32. object neo4j-driver.v1.integer
    33. object neo4j-driver.v1.types
  2. module neo4j-driver.buf
    1. function neo4j-driver.buf.BaseBuffer (size)
    2. function neo4j-driver.buf.CombinedBuffer (buffers)
    3. function neo4j-driver.buf.HeapBuffer (arg)
    4. function neo4j-driver.buf.NodeBuffer (arg)
    5. function neo4j-driver.buf.SliceBuffer (start, length, inner)
    6. function neo4j-driver.buf.alloc (size)
  3. module neo4j-driver.ch_dummy
    1. function neo4j-driver.ch_dummy.channel (opts)
    2. object neo4j-driver.ch_dummy.observer
  4. module neo4j-driver.chunking
    1. function neo4j-driver.chunking.Chunker (channel, bufferSize)
    2. function neo4j-driver.chunking.Dechunker ()
  5. module neo4j-driver.connection_holder
    1. function neo4j-driver.connection_holder.default (mode, connectionProvider)
    2. object neo4j-driver.connection_holder.EMPTY_CONNECTION_HOLDER
  6. module neo4j-driver.connection_providers
    1. function neo4j-driver.connection_providers.DirectConnectionProvider (address, connectionPool, driverOnErrorCallback)
    2. function neo4j-driver.connection_providers.LoadBalancer (address, connectionPool, driverOnErrorCallback)
    3. function neo4j-driver.connection_providers.SingleConnectionProvider (connectionPromise)
  7. module neo4j-driver.connector
    1. function neo4j-driver.connector.Connection (channel, url)
    2. function neo4j-driver.connector.connect (url)
    3. function neo4j-driver.connector.parseHost (url)
    4. function neo4j-driver.connector.parsePort (url)
    5. function neo4j-driver.connector.parseScheme (url)
    6. function neo4j-driver.connector.parseUrl (url)
  8. module neo4j-driver.driver
    1. function neo4j-driver.driver.Driver (url, userAgent)
    2. function neo4j-driver.driver.default (url, userAgent)
    3. string neo4j-driver.driver.READ
    4. string neo4j-driver.driver.WRITE
  9. module neo4j-driver.error
    1. function neo4j-driver.error.Neo4jError (message)
    2. function neo4j-driver.error.newError (message)
    3. string neo4j-driver.error.PROTOCOL_ERROR
    4. string neo4j-driver.error.SERVICE_UNAVAILABLE
    5. string neo4j-driver.error.SESSION_EXPIRED
  10. module neo4j-driver.features
    1. function neo4j-driver.features.default (name)
  11. module neo4j-driver.get_servers_util
    1. function neo4j-driver.get_servers_util.default ()
  12. module neo4j-driver.graph_types
    1. function neo4j-driver.graph_types.Node (identity, labels, properties)
    2. function neo4j-driver.graph_types.Path (start, end, segments)
    3. function neo4j-driver.graph_types.PathSegment (start, rel, end)
    4. function neo4j-driver.graph_types.Relationship (identity, start, end, type, properties)
    5. function neo4j-driver.graph_types.UnboundRelationship (identity, type, properties)
  13. module neo4j-driver.host_name_resolvers
    1. function neo4j-driver.host_name_resolvers.DnsHostNameResolver ()
    2. function neo4j-driver.host_name_resolvers.DummyHostNameResolver ()
  14. module neo4j-driver.integer
    1. function neo4j-driver.integer.default {{signature}}
    2. function neo4j-driver.integer.inSafeRange (val)
    3. function neo4j-driver.integer.int (val)
    4. function neo4j-driver.integer.isInt (obj)
    5. function neo4j-driver.integer.toNumber (val)
    6. function neo4j-driver.integer.toString (val, radix)
  15. module neo4j-driver.packstream
    1. function neo4j-driver.packstream.Packer (channel)
    2. function neo4j-driver.packstream.Structure (signature, fields)
    3. function neo4j-driver.packstream.Unpacker ()
  16. module neo4j-driver.pool
    1. function neo4j-driver.pool.default (create)
  17. module neo4j-driver.record
    1. function neo4j-driver.record.default (keys, fields)
  18. module neo4j-driver.rediscovery
    1. function neo4j-driver.rediscovery.default (getServersUtil)
  19. module neo4j-driver.result
    1. function neo4j-driver.result.default (streamObserver, statement, parameters, metaSupplier, connectionHolder)
  20. module neo4j-driver.result_summary
    1. function neo4j-driver.result_summary.default (statement, parameters, metadata)
    2. object neo4j-driver.result_summary.statementType
  21. module neo4j-driver.round_robin_array
    1. function neo4j-driver.round_robin_array.default (items)
  22. module neo4j-driver.routing_driver
    1. function neo4j-driver.routing_driver.default (url, userAgent)
  23. module neo4j-driver.routing_table
    1. function neo4j-driver.routing_table.default (routers, readers, writers, expirationTime)
  24. module neo4j-driver.session
    1. function neo4j-driver.session.default (mode, connectionProvider, bookmark, config)
  25. module neo4j-driver.stream_observer
    1. function neo4j-driver.stream_observer.default ()
  26. module neo4j-driver.transaction
    1. function neo4j-driver.transaction.default (connectionHolder, onClose, errorTransformer, bookmark, onBookmark)
  27. module neo4j-driver.transaction_executor
    1. function neo4j-driver.transaction_executor.default (maxRetryTimeMs, initialRetryDelayMs, multiplier, jitterFactor)
  28. module neo4j-driver.util
    1. function neo4j-driver.util.assertString (obj, objName)
    2. function neo4j-driver.util.isEmptyObjectOrNull (obj)
    3. string neo4j-driver.util.ENCRYPTION_OFF
    4. string neo4j-driver.util.ENCRYPTION_ON
  29. module neo4j-driver.v1
    1. function neo4j-driver.v1.Neo4jError (message)
    2. function neo4j-driver.v1.driver (url, authToken)
    3. function neo4j-driver.v1.int (val)
    4. function neo4j-driver.v1.isInt (obj)
    5. object neo4j-driver.v1.auth
    6. object neo4j-driver.v1.default
    7. object neo4j-driver.v1.error
    8. object neo4j-driver.v1.integer
    9. object neo4j-driver.v1.session
    10. object neo4j-driver.v1.types
  30. module neo4j-driver.v1.auth
    1. function neo4j-driver.v1.auth.basic (username, password)
    2. function neo4j-driver.v1.auth.custom (principal, credentials, realm, scheme)
  31. module neo4j-driver.v1.default
    1. function neo4j-driver.v1.default.Neo4jError (message)
    2. function neo4j-driver.v1.default.driver (url, authToken)
    3. function neo4j-driver.v1.default.int (val)
    4. function neo4j-driver.v1.default.isInt (obj)
    5. object neo4j-driver.v1.default.auth
    6. object neo4j-driver.v1.default.error
    7. object neo4j-driver.v1.default.integer
    8. object neo4j-driver.v1.default.session
    9. object neo4j-driver.v1.default.types
  32. module neo4j-driver.v1.integer
    1. function neo4j-driver.v1.integer.inSafeRange (val)
    2. function neo4j-driver.v1.integer.toNumber (val)
    3. function neo4j-driver.v1.integer.toString (val, radix)
  33. module neo4j-driver.v1.types
    1. function neo4j-driver.v1.types.Node (identity, labels, properties)
    2. function neo4j-driver.v1.types.Path (start, end, segments)
    3. function neo4j-driver.v1.types.PathSegment (start, rel, end)
    4. function neo4j-driver.v1.types.Record (keys, fields)
    5. function neo4j-driver.v1.types.Relationship (identity, start, end, type, properties)
    6. function neo4j-driver.v1.types.Result (streamObserver, statement, parameters, metaSupplier, connectionHolder)
    7. function neo4j-driver.v1.types.ResultSummary (statement, parameters, metadata)
    8. function neo4j-driver.v1.types.UnboundRelationship (identity, type, properties)

module neo4j-driver

module neo4j-driver.buf

function neo4j-driver.buf.BaseBuffer (size)

function neo4j-driver.buf.CombinedBuffer (buffers)

function neo4j-driver.buf.HeapBuffer (arg)

function neo4j-driver.buf.NodeBuffer (arg)

function neo4j-driver.buf.SliceBuffer (start, length, inner)

function neo4j-driver.buf.alloc (size)

module neo4j-driver.ch_dummy

function neo4j-driver.ch_dummy.channel (opts)

module neo4j-driver.chunking

function neo4j-driver.chunking.Chunker (channel, bufferSize)

function neo4j-driver.chunking.Dechunker ()

module neo4j-driver.connection_holder

function neo4j-driver.connection_holder.default (mode, connectionProvider)

module neo4j-driver.connection_providers

function neo4j-driver.connection_providers.DirectConnectionProvider (address, connectionPool, driverOnErrorCallback)

function neo4j-driver.connection_providers.LoadBalancer (address, connectionPool, driverOnErrorCallback)

function neo4j-driver.connection_providers.SingleConnectionProvider (connectionPromise)

module neo4j-driver.connector

function neo4j-driver.connector.Connection (channel, url)

function neo4j-driver.connector.connect (url)

function neo4j-driver.connector.parseHost (url)

function neo4j-driver.connector.parsePort (url)

function neo4j-driver.connector.parseScheme (url)

function neo4j-driver.connector.parseUrl (url)

module neo4j-driver.driver

function neo4j-driver.driver.Driver (url, userAgent)

function neo4j-driver.driver.default (url, userAgent)

module neo4j-driver.error

function neo4j-driver.error.Neo4jError (message)

function neo4j-driver.error.newError (message)

module neo4j-driver.features

function neo4j-driver.features.default (name)

module neo4j-driver.get_servers_util

function neo4j-driver.get_servers_util.default ()

module neo4j-driver.graph_types

function neo4j-driver.graph_types.Node (identity, labels, properties)

function neo4j-driver.graph_types.Path (start, end, segments)

function neo4j-driver.graph_types.PathSegment (start, rel, end)

function neo4j-driver.graph_types.Relationship (identity, start, end, type, properties)

function neo4j-driver.graph_types.UnboundRelationship (identity, type, properties)

module neo4j-driver.host_name_resolvers

function neo4j-driver.host_name_resolvers.DnsHostNameResolver ()

function neo4j-driver.host_name_resolvers.DummyHostNameResolver ()

module neo4j-driver.integer

function neo4j-driver.integer.default {{signature}}

function neo4j-driver.integer.inSafeRange (val)

function neo4j-driver.integer.int (val)

function neo4j-driver.integer.isInt (obj)

function neo4j-driver.integer.toNumber (val)

function neo4j-driver.integer.toString (val, radix)

module neo4j-driver.packstream

function neo4j-driver.packstream.Packer (channel)

function neo4j-driver.packstream.Structure (signature, fields)

function neo4j-driver.packstream.Unpacker ()

module neo4j-driver.pool

function neo4j-driver.pool.default (create)

module neo4j-driver.record

function neo4j-driver.record.default (keys, fields)

module neo4j-driver.rediscovery

function neo4j-driver.rediscovery.default (getServersUtil)

module neo4j-driver.result

function neo4j-driver.result.default (streamObserver, statement, parameters, metaSupplier, connectionHolder)

module neo4j-driver.result_summary

function neo4j-driver.result_summary.default (statement, parameters, metadata)

module neo4j-driver.round_robin_array

function neo4j-driver.round_robin_array.default (items)

module neo4j-driver.routing_driver

function neo4j-driver.routing_driver.default (url, userAgent)

module neo4j-driver.routing_table

function neo4j-driver.routing_table.default (routers, readers, writers, expirationTime)

module neo4j-driver.session

function neo4j-driver.session.default (mode, connectionProvider, bookmark, config)

module neo4j-driver.stream_observer

function neo4j-driver.stream_observer.default ()

module neo4j-driver.transaction

function neo4j-driver.transaction.default (connectionHolder, onClose, errorTransformer, bookmark, onBookmark)

module neo4j-driver.transaction_executor

function neo4j-driver.transaction_executor.default (maxRetryTimeMs, initialRetryDelayMs, multiplier, jitterFactor)

module neo4j-driver.util

function neo4j-driver.util.assertString (obj, objName)

function neo4j-driver.util.isEmptyObjectOrNull (obj)

module neo4j-driver.v1

function neo4j-driver.v1.Neo4jError (message)

function neo4j-driver.v1.driver (url, authToken)

function neo4j-driver.v1.int (val)

function neo4j-driver.v1.isInt (obj)

module neo4j-driver.v1.auth

function neo4j-driver.v1.auth.basic (username, password)

function neo4j-driver.v1.auth.custom (principal, credentials, realm, scheme)

module neo4j-driver.v1.default

function neo4j-driver.v1.default.Neo4jError (message)

function neo4j-driver.v1.default.driver (url, authToken)

function neo4j-driver.v1.default.int (val)

function neo4j-driver.v1.default.isInt (obj)

module neo4j-driver.v1.integer

function neo4j-driver.v1.integer.inSafeRange (val)

function neo4j-driver.v1.integer.toNumber (val)

function neo4j-driver.v1.integer.toString (val, radix)

module neo4j-driver.v1.types

function neo4j-driver.v1.types.Node (identity, labels, properties)

function neo4j-driver.v1.types.Path (start, end, segments)

function neo4j-driver.v1.types.PathSegment (start, rel, end)

function neo4j-driver.v1.types.Record (keys, fields)

function neo4j-driver.v1.types.Relationship (identity, start, end, type, properties)

function neo4j-driver.v1.types.Result (streamObserver, statement, parameters, metaSupplier, connectionHolder)

function neo4j-driver.v1.types.ResultSummary (statement, parameters, metadata)

function neo4j-driver.v1.types.UnboundRelationship (identity, type, properties)

[ this document was created with utility2 ]