Session (client 3.5.0 API)

java.lang.Object
- com.vesoft.nebula.client.graph.net.Session

All Implemented Interfaces:

Serializable, AutoCloseable
```
public class Session
extends Object
implements Serializable, AutoCloseable
```
The Session is an object that operates with nebula-graph. It provides an interface `execute` to send any NGQL. The returned data result `ResultSet` include wrapped string encoding and time zone calculations and Node and Relationship and PathWrapper and DateWrapper and TimeWrapper and DateTimeWrapper. The data type obtained by the user is `ValueWrapper`, which is the wrapper of the original data structure Value returned by the server. The user can directly read the data using the interface of ValueWrapper.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static Map<Class<?>,com.vesoft.nebula.client.graph.net.Session.Setter>`	`COMPLEX_TYPE_AND_SETTER` some value setter for java type (complex java type include collections or date) that need convert to NValue
`static Map<Class<?>,com.vesoft.nebula.client.graph.net.Session.Setter>`	`LEAF_TYPE_AND_SETTER` some value setter for java type (basic or nebula special type) that need convert to NValue

Constructor Summary

Constructors
Constructor and Description

Session(SyncConnection connection, AuthResult authResult, NebulaPool connPool, Boolean retryConnect)
Constructor

Constructors
Constructor and Description
`Session(SyncConnection connection, AuthResult authResult, NebulaPool connPool, Boolean retryConnect)` Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()`
`ResultSet`	`execute(String stmt)` Execute the nGql sentence.
`String`	`executeJson(String stmt)` Execute the nGql sentence.
`String`	`executeJsonWithParameter(String stmt, Map<String,Object> parameterMap)` Execute the nGql sentence.
`ResultSet`	`executeWithParameter(String stmt, Map<String,Object> parameterMap)` Execute the nGql sentence.
`HostAddress`	`getGraphHost()` Gets the service address of the current connection
`long`	`getSessionID()` get SessionID
`boolean`	`ping()` Check current connection is ok
`boolean`	`pingSession()` check current session is ok
`void`	`release()` Notifies the server that the session is no longer needed and returns the connection to the pool, and the connection will be reuse.
`static Value`	`value2Nvalue(Object value)` convert java value type to nebula thrift value type

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

- Field Detail
  - LEAF_TYPE_AND_SETTER
```
public static Map<Class<?>,com.vesoft.nebula.client.graph.net.Session.Setter> LEAF_TYPE_AND_SETTER
```
    some value setter for java type (basic or nebula special type) that need convert to NValue
  - COMPLEX_TYPE_AND_SETTER
```
public static Map<Class<?>,com.vesoft.nebula.client.graph.net.Session.Setter> COMPLEX_TYPE_AND_SETTER
```
    some value setter for java type (complex java type include collections or date) that need convert to NValue
- Constructor Detail
  - Session
```
public Session(SyncConnection connection,
               AuthResult authResult,
               NebulaPool connPool,
               Boolean retryConnect)
```
    Constructor
    
    Parameters:
    
    connection - the connection from the pool
    
    authResult - the auth result from graph service
    
    connPool - the connection pool
    
    retryConnect - whether to retry after the connection is disconnected
- Method Detail
  - execute
```
public ResultSet execute(String stmt)
                  throws IOErrorException
```
    Execute the nGql sentence.
    
    Parameters:
    
    stmt - The nGql sentence. such as insert ngql `INSERT VERTEX person(name) VALUES "Tom":("Tom");`
    
    Returns:
    
    The ResultSet
    
    Throws:
    
    IOErrorException
  - executeWithParameter
```
public ResultSet executeWithParameter(String stmt,
                                      Map<String,Object> parameterMap)
                               throws IOErrorException
```
    Execute the nGql sentence.
    
    Parameters:
    
    stmt - The nGql sentence. such as insert ngql `INSERT VERTEX person(name) VALUES "Tom":("Tom");`
    
    parameterMap - The nGql parameter map
    
    Returns:
    
    The ResultSet
    
    Throws:
    
    IOErrorException
  - executeJson
```
public String executeJson(String stmt)
                   throws IOErrorException
```
    Execute the nGql sentence. Date and Datetime will be returned in UTC JSON struct: { "results":[ { "columns":[], "data":[ { "row":row-data, "meta":metadata } ], "latencyInUs":0, "spaceName":"", "planDesc ":{ "planNodeDescs":[ { "name":"", "id":0, "outputVar":"", "description":{ "key":"" }, "profiles":[ { "rows":1, "execDurationInUs":0, "totalDurationInUs":0, "otherStats":{} } ], "branchInfo":{ "isDoBranch":false, "conditionNodeId":-1 }, "dependencies":[] } ], "nodeIndexMap":{}, "format":"", "optimize_time_in_us":0 }, "comment ":"", } ], "errors":[ { "code": 0, "message": "" } ] }
    
    Parameters:
    
    stmt - The nGql sentence. such as insert ngql `INSERT VERTEX person(name) VALUES "Tom":("Tom");` parameterMap The nGql parameters
    
    Returns:
    
    The JSON string
    
    Throws:
    
    IOErrorException
  - executeJsonWithParameter
```
public String executeJsonWithParameter(String stmt,
                                       Map<String,Object> parameterMap)
                                throws IOErrorException
```
    Execute the nGql sentence. Date and Datetime will be returned in UTC JSON struct: { "results":[ { "columns":[], "data":[ { "row":row-data, "meta":metadata } ], "latencyInUs":0, "spaceName":"", "planDesc ":{ "planNodeDescs":[ { "name":"", "id":0, "outputVar":"", "description":{ "key":"" }, "profiles":[ { "rows":1, "execDurationInUs":0, "totalDurationInUs":0, "otherStats":{} } ], "branchInfo":{ "isDoBranch":false, "conditionNodeId":-1 }, "dependencies":[] } ], "nodeIndexMap":{}, "format":"", "optimize_time_in_us":0 }, "comment ":"", } ], "errors":[ { "code": 0, "message": "" } ] }
    
    Parameters:
    
    stmt - The nGql sentence. such as insert ngql `INSERT VERTEX person(name) VALUES "Tom":("Tom");` parameterMap The nGql parameters
    
    Returns:
    
    The JSON string
    
    Throws:
    
    IOErrorException
  - ping
```
public boolean ping()
```
    Check current connection is ok
    
    Returns:
    
    boolean
  - pingSession
```
public boolean pingSession()
```
    check current session is ok
  - release
```
public void release()
```
    Notifies the server that the session is no longer needed and returns the connection to the pool, and the connection will be reuse. This function is called if the user is no longer using the session.
  - getGraphHost
```
public HostAddress getGraphHost()
```
    Gets the service address of the current connection
    
    Returns:
    
    HostAddress the graph service address
  - getSessionID
```
public long getSessionID()
```
    get SessionID
  - value2Nvalue
```
public static Value value2Nvalue(Object value)
                          throws UnsupportedOperationException
```
    convert java value type to nebula thrift value type
    
    Parameters:
    
    value - java obj
    
    Returns:
    
    nebula value
    
    Throws:
    
    UnsupportedOperationException
  - close
```
public void close()
```
    Specified by:
    
    close in interface AutoCloseable

Class Session

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

LEAF_TYPE_AND_SETTER

COMPLEX_TYPE_AND_SETTER

Constructor Detail

Session

Method Detail

execute

executeWithParameter

executeJson

executeJsonWithParameter

ping

pingSession

release

getGraphHost

getSessionID

value2Nvalue

close