Neo4jClient (Neo4j client for Vert.x 0.0.3 API)

java.lang.Object
- io.reactiverse.reactivex.neo4j.Neo4jClient

```
public class Neo4jClient
extends Object
```

Field Summary

Fields
Modifier and Type Field and Description

static io.vertx.lang.rx.TypeArg<Neo4jClient> __TYPE_ARG

static String DEFAULT_POOL_NAME
The default shared client name.

Fields
Modifier and Type	Field and Description
`static io.vertx.lang.rx.TypeArg<Neo4jClient>`	`__TYPE_ARG`
`static String`	`DEFAULT_POOL_NAME` The default shared client name.

Constructor Summary

Constructors
Constructor and Description

Neo4jClient(Neo4jClient delegate)

Neo4jClient(Object delegate)

Constructors
Constructor and Description
`Neo4jClient(Neo4jClient delegate)`
`Neo4jClient(Object delegate)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Neo4jClient`	`begin(Handler<AsyncResult<Neo4jTransaction>> resultHandler)` Begins a new transaction
`Neo4jClient`	`bulkWrite(List<Query> queries, Handler<AsyncResult<SummaryCounters>> resultHandler)` Executes a list of queries in one transaction
`void`	`close()` Closes this client
`static Neo4jClient`	`createNonShared(Vertx vertx, Neo4jClientOptions config)` Creates a Neo4j client which maintains its own driver session.
`static Neo4jClient`	`createShared(Vertx vertx, Neo4jClientOptions config)` Same as `createShared(io.vertx.reactivex.core.Vertx, io.reactiverse.neo4j.options.Neo4jClientOptions)` but with a default data source name
`static Neo4jClient`	`createShared(Vertx vertx, Neo4jClientOptions config, String dataSourceName)` Creates a Neo4j client that shares its driver session with any other client having the same name.
`Neo4jClient`	`delete(String query, Handler<AsyncResult<List<Record>>> resultHandler)` Executes and returns deleted results
`Neo4jClient`	`delete(String query, Value parameters, Handler<AsyncResult<List<Record>>> resultHandler)` Executes and returns deleted results
`boolean`	`equals(Object o)`
`Neo4jClient`	`execute(String query, Handler<AsyncResult<ResultSummary>> resultHandler)` Executes a write transaction
`Neo4jClient`	`execute(String query, Value parameters, Handler<AsyncResult<ResultSummary>> resultHandler)` Executes a write transaction
`Neo4jClient`	`find(String query, Handler<AsyncResult<List<Record>>> resultHandler)` Finds a list of records
`Neo4jClient`	`find(String query, Value parameters, Handler<AsyncResult<List<Record>>> resultHandler)` Finds a list of records
`Neo4jClient`	`findOne(String query, Handler<AsyncResult<Record>> resultHandler)` Finds exactly one record
`Neo4jClient`	`findOne(String query, Value parameters, Handler<AsyncResult<Record>> resultHandler)` Finds exactly one record
`Neo4jClient`	`getDelegate()`
`int`	`hashCode()`
`static Neo4jClient`	`newInstance(Neo4jClient arg)`
`Neo4jClient`	`queryStream(String query, Handler<AsyncResult<Neo4jRecordStream>> recordStreamHandler)` Opens a new stream of records
`Neo4jClient`	`queryStream(String query, Value parameters, Handler<AsyncResult<Neo4jRecordStream>> recordStreamHandler)` Opens a new stream of records
`Single<Neo4jTransaction>`	`rxBegin()` Begins a new transaction
`Single<SummaryCounters>`	`rxBulkWrite(List<Query> queries)` Executes a list of queries in one transaction
`Single<List<Record>>`	`rxDelete(String query)` Executes and returns deleted results
`Single<List<Record>>`	`rxDelete(String query, Value parameters)` Executes and returns deleted results
`Single<ResultSummary>`	`rxExecute(String query)` Executes a write transaction
`Single<ResultSummary>`	`rxExecute(String query, Value parameters)` Executes a write transaction
`Single<List<Record>>`	`rxFind(String query)` Finds a list of records
`Single<List<Record>>`	`rxFind(String query, Value parameters)` Finds a list of records
`Single<Record>`	`rxFindOne(String query)` Finds exactly one record
`Single<Record>`	`rxFindOne(String query, Value parameters)` Finds exactly one record
`Single<Neo4jRecordStream>`	`rxQueryStream(String query)` Opens a new stream of records
`Single<Neo4jRecordStream>`	`rxQueryStream(String query, Value parameters)` Opens a new stream of records
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - __TYPE_ARG
```
public static final io.vertx.lang.rx.TypeArg<Neo4jClient> __TYPE_ARG
```
  - DEFAULT_POOL_NAME
```
public static final String DEFAULT_POOL_NAME
```
    The default shared client name.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Neo4jClient
```
public Neo4jClient(Neo4jClient delegate)
```
  - Neo4jClient
```
public Neo4jClient(Object delegate)
```
- Method Detail
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getDelegate
```
public Neo4jClient getDelegate()
```
  - createShared
```
public static Neo4jClient createShared(Vertx vertx,
                                       Neo4jClientOptions config)
```
    Same as createShared(io.vertx.reactivex.core.Vertx, io.reactiverse.neo4j.options.Neo4jClientOptions) but with a default data source name
    
    Parameters:
    
    vertx - the Vert.x instance
    
    config - the driver configuration
    
    Returns:
    
    the client
  - createShared
```
public static Neo4jClient createShared(Vertx vertx,
                                       Neo4jClientOptions config,
                                       String dataSourceName)
```
    Creates a Neo4j client that shares its driver session with any other client having the same name.
    
    Parameters:
    
    vertx - the Vert.x instance
    
    config - the driver configuration
    
    dataSourceName - the data source name
    
    Returns:
    
    the client
  - createNonShared
```
public static Neo4jClient createNonShared(Vertx vertx,
                                          Neo4jClientOptions config)
```
    Creates a Neo4j client which maintains its own driver session.
    It is not recommended to create several non shared clients in an application.
    
    Parameters:
    
    vertx - the Vert.x instance
    
    config - the driver configuration
    
    Returns:
    
    the client
  - begin
```
public Neo4jClient begin(Handler<AsyncResult<Neo4jTransaction>> resultHandler)
```
    Begins a new transaction
    
    Parameters:
    
    resultHandler - the handler to be called when the transaction has begun
    
    Returns:
    
    the current Neo4jClient instance
  - rxBegin
```
public Single<Neo4jTransaction> rxBegin()
```
    Begins a new transaction
    
    Returns:
    
    the current Neo4jClient instance
  - queryStream
```
public Neo4jClient queryStream(String query,
                               Handler<AsyncResult<Neo4jRecordStream>> recordStreamHandler)
```
    Opens a new stream of records
    
    Parameters:
    
    query - the cypher query
    
    recordStreamHandler - the handler to be called when the stream of records is available
    
    Returns:
    
    the current Neo4jClient instance
  - rxQueryStream
```
public Single<Neo4jRecordStream> rxQueryStream(String query)
```
    Opens a new stream of records
    
    Parameters:
    
    query - the cypher query
    
    Returns:
    
    the current Neo4jClient instance
  - close
```
public void close()
```
    Closes this client
  - execute
```
public Neo4jClient execute(String query,
                           Handler<AsyncResult<ResultSummary>> resultHandler)
```
    Executes a write transaction
    
    Parameters:
    
    query - the cypher query
    
    resultHandler - the handler to be called when the query has completed
    
    Returns:
    
    the current Neo4jClient instance
  - rxExecute
```
public Single<ResultSummary> rxExecute(String query)
```
    Executes a write transaction
    
    Parameters:
    
    query - the cypher query
    
    Returns:
    
    the current Neo4jClient instance
  - execute
```
public Neo4jClient execute(String query,
                           Value parameters,
                           Handler<AsyncResult<ResultSummary>> resultHandler)
```
    Executes a write transaction
    
    Parameters:
    
    query - the cypher query
    
    parameters - the cypher parameters
    
    resultHandler - the handler to be called when the query has completed
    
    Returns:
    
    the current Neo4jClient instance
  - rxExecute
```
public Single<ResultSummary> rxExecute(String query,
                                       Value parameters)
```
    Executes a write transaction
    
    Parameters:
    
    query - the cypher query
    
    parameters - the cypher parameters
    
    Returns:
    
    the current Neo4jClient instance
  - delete
```
public Neo4jClient delete(String query,
                          Handler<AsyncResult<List<Record>>> resultHandler)
```
    Executes and returns deleted results
    
    Parameters:
    
    query - the cypher query
    
    resultHandler - the handler to be called when the query has completed
    
    Returns:
    
    the current Neo4jClient instance
  - rxDelete
```
public Single<List<Record>> rxDelete(String query)
```
    Executes and returns deleted results
    
    Parameters:
    
    query - the cypher query
    
    Returns:
    
    the current Neo4jClient instance
  - delete
```
public Neo4jClient delete(String query,
                          Value parameters,
                          Handler<AsyncResult<List<Record>>> resultHandler)
```
    Executes and returns deleted results
    
    Parameters:
    
    query - the cypher query
    
    parameters - the cypher parameters
    
    resultHandler - the handler to be called when the query has completed
    
    Returns:
    
    the current Neo4jClient instance
  - rxDelete
```
public Single<List<Record>> rxDelete(String query,
                                     Value parameters)
```
    Executes and returns deleted results
    
    Parameters:
    
    query - the cypher query
    
    parameters - the cypher parameters
    
    Returns:
    
    the current Neo4jClient instance
  - findOne
```
public Neo4jClient findOne(String query,
                           Handler<AsyncResult<Record>> resultHandler)
```
    Finds exactly one record
    
    Parameters:
    
    query - the cypher query
    
    resultHandler - the handler to be called when the query has completed
    
    Returns:
    
    the current Neo4jClient instance
  - rxFindOne
```
public Single<Record> rxFindOne(String query)
```
    Finds exactly one record
    
    Parameters:
    
    query - the cypher query
    
    Returns:
    
    the current Neo4jClient instance
  - findOne
```
public Neo4jClient findOne(String query,
                           Value parameters,
                           Handler<AsyncResult<Record>> resultHandler)
```
    Finds exactly one record
    
    Parameters:
    
    query - the cypher query
    
    parameters - the cypher parameters
    
    resultHandler - the handler to be called when the query has completed
    
    Returns:
    
    the current Neo4jClient instance
  - rxFindOne
```
public Single<Record> rxFindOne(String query,
                                Value parameters)
```
    Finds exactly one record
    
    Parameters:
    
    query - the cypher query
    
    parameters - the cypher parameters
    
    Returns:
    
    the current Neo4jClient instance
  - find
```
public Neo4jClient find(String query,
                        Handler<AsyncResult<List<Record>>> resultHandler)
```
    Finds a list of records
    
    Parameters:
    
    query - the cypher query
    
    resultHandler - the handler to be called when the query has completed
    
    Returns:
    
    the current Neo4jClient instance
  - rxFind
```
public Single<List<Record>> rxFind(String query)
```
    Finds a list of records
    
    Parameters:
    
    query - the cypher query
    
    Returns:
    
    the current Neo4jClient instance
  - find
```
public Neo4jClient find(String query,
                        Value parameters,
                        Handler<AsyncResult<List<Record>>> resultHandler)
```
    Finds a list of records
    
    Parameters:
    
    query - the cypher query
    
    parameters - the cypher parameters
    
    resultHandler - the handler to be called when the query has completed
    
    Returns:
    
    the current Neo4jClient instance
  - rxFind
```
public Single<List<Record>> rxFind(String query,
                                   Value parameters)
```
    Finds a list of records
    
    Parameters:
    
    query - the cypher query
    
    parameters - the cypher parameters
    
    Returns:
    
    the current Neo4jClient instance
  - bulkWrite
```
public Neo4jClient bulkWrite(List<Query> queries,
                             Handler<AsyncResult<SummaryCounters>> resultHandler)
```
    Executes a list of queries in one transaction
    
    Parameters:
    
    queries - the list of queries to execute
    
    resultHandler - the handler to be called when the query has completed
    
    Returns:
    
    the current Neo4jClient instance
  - rxBulkWrite
```
public Single<SummaryCounters> rxBulkWrite(List<Query> queries)
```
    Executes a list of queries in one transaction
    
    Parameters:
    
    queries - the list of queries to execute
    
    Returns:
    
    the current Neo4jClient instance
  - queryStream
```
public Neo4jClient queryStream(String query,
                               Value parameters,
                               Handler<AsyncResult<Neo4jRecordStream>> recordStreamHandler)
```
    Opens a new stream of records
    
    Parameters:
    
    query - the cypher query
    
    parameters - the cypher parameters
    
    recordStreamHandler - the handler to be called when the stream of records is available
    
    Returns:
    
    the current Neo4jClient instance
  - rxQueryStream
```
public Single<Neo4jRecordStream> rxQueryStream(String query,
                                               Value parameters)
```
    Opens a new stream of records
    
    Parameters:
    
    query - the cypher query
    
    parameters - the cypher parameters
    
    Returns:
    
    the current Neo4jClient instance
  - newInstance
```
public static Neo4jClient newInstance(Neo4jClient arg)
```

Class Neo4jClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__TYPE_ARG

DEFAULT_POOL_NAME

Constructor Detail

Neo4jClient

Neo4jClient

Method Detail

toString

equals

hashCode

getDelegate

createShared

createShared

createNonShared

begin

rxBegin

queryStream

rxQueryStream

close

execute

rxExecute

execute

rxExecute

delete

rxDelete

delete

rxDelete

findOne

rxFindOne

findOne

rxFindOne

find

rxFind

find

rxFind

bulkWrite

rxBulkWrite

queryStream

rxQueryStream

newInstance