com.vesoft.nebula.client.storage

Class StorageClient

java.lang.Object

com.vesoft.nebula.client.storage.StorageClient

public class StorageClient
extends Object

Constructor Summary

Constructors

Constructor and Description
StorageClient(List<HostAddress> addresses) Get a Nebula Storage client that executes the scan query to get NebulaGraph's data with multi servers' host.
StorageClient(List<HostAddress> addresses, int timeout) Get a Nebula Storage client that executes the scan query to get NebulaGraph's data with multi servers' hosts and timeout.
StorageClient(List<HostAddress> addresses, int timeout, int connectionRetry, int executionRetry, boolean enableSSL, SSLParam sslParam) Get a Nebula Storage client that executes the scan query to get NebulaGraph's data with multi servers' hosts, timeout and ssl config.
StorageClient(String ip, int port) Get a Nebula Storage client that executes the scan query to get NebulaGraph's data with one server host.

Method Summary

Modifier and Type	Method and Description
void	close() release storage client
boolean	connect() Connect to Nebula Storage server.
protected GraphStorageConnection	getConnection() return client's connection session
ScanEdgeResultIterator	scanEdge(String spaceName, int part, String edgeName) scan edge of specific part with no return cols.
ScanEdgeResultIterator	scanEdge(String spaceName, int part, String edgeName, int limit) scan edge of specific part with no return cols and limit config.
ScanEdgeResultIterator	scanEdge(String spaceName, int part, String edgeName, int limit, long startTime, long endTime) scan edge of specific part with no return cols and limit, start time, end time config.
ScanEdgeResultIterator	scanEdge(String spaceName, int part, String edgeName, int limit, long startTime, long endTime, boolean allowPartSuccess, boolean allowReadFromFollower) scan edge of specific part with no return cols and limit, start time, end time, if allow partial success, if allow read data from storage follower config.
ScanEdgeResultIterator	scanEdge(String spaceName, int part, String edgeName, List<String> returnCols) scan edge of specific part with return cols.
ScanEdgeResultIterator	scanEdge(String spaceName, int part, String edgeName, List<String> returnCols, int limit) scan edge of specific part with return cols.
ScanEdgeResultIterator	scanEdge(String spaceName, int part, String edgeName, List<String> returnCols, int limit, long startTime, long endTime) scan edge of specific part with return cols and limit, start time, end time config.
ScanEdgeResultIterator	scanEdge(String spaceName, int part, String edgeName, List<String> returnCols, int limit, long startTime, long endTime, boolean allowPartSuccess, boolean allowReadFromFollower) scan edge of specific part with return cols and limit, start time, end time, if allow partial success, if allow read data from storage follower config.
ScanEdgeResultIterator	scanEdge(String spaceName, String edgeName) scan edge of all parts with no return cols.
ScanEdgeResultIterator	scanEdge(String spaceName, String edgeName, int limit) scan edge of all parts with no return cols and limit config.
ScanEdgeResultIterator	scanEdge(String spaceName, String edgeName, int limit, long startTime, long endTime) scan edge of all parts with no return cols and limit, start time, end time config.
ScanEdgeResultIterator	scanEdge(String spaceName, String edgeName, int limit, long startTime, long endTime, boolean allowPartSuccess, boolean allowReadFromFollower) scan edge of all parts with no return cols and limit, start time, end time, if allow partial success, if allow read data from storage follower config.
ScanEdgeResultIterator	scanEdge(String spaceName, String edgeName, List<String> returnCols) scan edge of all parts with return cols.
ScanEdgeResultIterator	scanEdge(String spaceName, String edgeName, List<String> returnCols, int limit) scan edge of all parts with return cols and limit config.
ScanEdgeResultIterator	scanEdge(String spaceName, String edgeName, List<String> returnCols, int limit, long startTime, long endTime) scan edge of all parts with return cols and limit, start time, end time config.
ScanEdgeResultIterator	scanEdge(String spaceName, String edgeName, List<String> returnCols, int limit, long startTime, long endTime, boolean allowPartSuccess, boolean allowReadFromFollower) scan edge of all parts with return cols and limit, start time, end time, if allow partial success, if allow read data from storage follower config.
ScanVertexResultIterator	scanVertex(String spaceName, int part, String tagName) scan vertex of specific part with no return cols.
ScanVertexResultIterator	scanVertex(String spaceName, int part, String tagName, int limit) scan vertex of specific part with no return cols and limit.
ScanVertexResultIterator	scanVertex(String spaceName, int part, String tagName, int limit, long startTime, long endTime) scan vertex of specific part with no returnCols, limit, startTime and endTime.
ScanVertexResultIterator	scanVertex(String spaceName, int part, String tagName, int limit, long startTime, long endTime, boolean allowPartSuccess, boolean allowReadFromFollower) scan vertex of specific part with no return cols, limit, startTime, endTime， whether allow partial success, whether allow read from storage follower.
ScanVertexResultIterator	scanVertex(String spaceName, int part, String tagName, List<String> returnCols) scan vertex of specific part with specific return cols, if returnCols is an empty list, then return all the columns of specific tagName.
ScanVertexResultIterator	scanVertex(String spaceName, int part, String tagName, List<String> returnCols, int limit) scan vertex of specific part with specific return cols and limit.
ScanVertexResultIterator	scanVertex(String spaceName, int part, String tagName, List<String> returnCols, int limit, long startTime, long endTime) scan vertex of specific part with specific returnCols, limit, startTime and endTime.
ScanVertexResultIterator	scanVertex(String spaceName, int part, String tagName, List<String> returnCols, int limit, long startTime, long endTime, boolean allowPartSuccess, boolean allowReadFromFollower) scan vertex of specific part with specific return cols, limit, startTime, endTime， whether allow partial success, whether allow read from storage follower.
ScanVertexResultIterator	scanVertex(String spaceName, String tagName) scan vertex of all parts with no return cols.
ScanVertexResultIterator	scanVertex(String spaceName, String tagName, int limit) scan vertex of all parts with no return cols and limit.
ScanVertexResultIterator	scanVertex(String spaceName, String tagName, int limit, long startTime, long endTime) scan vertex of all parts with no returnCols, limit, startTime and endTime.
ScanVertexResultIterator	scanVertex(String spaceName, String tagName, int limit, long startTime, long endTime, boolean allowPartSuccess, boolean allowReadFromFollower) scan vertex of all parts with no return cols, limit, startTime, endTime， whether allow partial success, whether allow read from storage follower.
ScanVertexResultIterator	scanVertex(String spaceName, String tagName, List<String> returnCols) scan vertex of all parts with specific return cols, if returnCols is an empty list, then return all the columns of specific tagName.
ScanVertexResultIterator	scanVertex(String spaceName, String tagName, List<String> returnCols, int limit) scan vertex of all parts with specific return cols and limit.
ScanVertexResultIterator	scanVertex(String spaceName, String tagName, List<String> returnCols, int limit, long startTime, long endTime) scan vertex of all parts with specific returnCols, limit, startTime and endTime.
ScanVertexResultIterator	scanVertex(String spaceName, String tagName, List<String> returnCols, int limit, long startTime, long endTime, boolean allowPartSuccess, boolean allowReadFromFollower) scan vertex of all parts with specific return cols, limit, startTime, endTime， whether allow partial success, whether allow read from storage follower.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StorageClient

public StorageClient(String ip,
                     int port)

Get a Nebula Storage client that executes the scan query to get NebulaGraph's data with one server host.

Parameters:

ip - the ip of metad server

port - the port of metad server

StorageClient

public StorageClient(List<HostAddress> addresses)

Get a Nebula Storage client that executes the scan query to get NebulaGraph's data with multi servers' host.

Parameters:

addresses - the HostAddress list of metad servers

StorageClient

public StorageClient(List<HostAddress> addresses,
                     int timeout)

Get a Nebula Storage client that executes the scan query to get NebulaGraph's data with multi servers' hosts and timeout.

Parameters:

addresses - the HostAddress list of metad servers

timeout - the timeout of scan vertex or edge

StorageClient

public StorageClient(List<HostAddress> addresses,
                     int timeout,
                     int connectionRetry,
                     int executionRetry,
                     boolean enableSSL,
                     SSLParam sslParam)

Get a Nebula Storage client that executes the scan query to get NebulaGraph's data with multi servers' hosts, timeout and ssl config.

Method Detail

connect

public boolean connect()
                throws Exception

Connect to Nebula Storage server.

Returns:

true if connect successfully.

Throws:

Exception

scanVertex

public ScanVertexResultIterator scanVertex(String spaceName,
                                           String tagName,
                                           List<String> returnCols)

scan vertex of all parts with specific return cols, if returnCols is an empty list, then return all the columns of specific tagName.

the result contains vertex id and return cols.

Parameters:

spaceName - Nebula space name

tagName - Nebula tag name

returnCols - Nebula tag properties to return

Returns:

an iterator to get data by call ScanVertexResultIterator.next()

scanVertex

public ScanVertexResultIterator scanVertex(String spaceName,
                                           int part,
                                           String tagName,
                                           List<String> returnCols)

scan vertex of specific part with specific return cols, if returnCols is an empty list, then return all the columns of specific tagName.

the result contains vertex id and return cols.

Parameters:

spaceName - Nebula space name

part - Nebula data partition

tagName - Nebula tag name

returnCols - Nebula tag properties to return

Returns:

an iterator to get data by call ScanVertexResultIterator.next()

scanVertex

public ScanVertexResultIterator scanVertex(String spaceName,
                                           String tagName)

scan vertex of all parts with no return cols.

the result only contains vertex id.

Parameters:

spaceName - Nebula space name

tagName - Nebula tag name

Returns:

an iterator to get data by call ScanVertexResultIterator.next()

scanVertex

public ScanVertexResultIterator scanVertex(String spaceName,
                                           int part,
                                           String tagName)

scan vertex of specific part with no return cols.

the result only contains vertex id.

Parameters:

spaceName - Nebula space name

part - Nebula data partition

tagName - Nebula tag name

Returns:

an iterator to get data by call ScanVertexResultIterator.next()

scanVertex

public ScanVertexResultIterator scanVertex(String spaceName,
                                           String tagName,
                                           List<String> returnCols,
                                           int limit)

scan vertex of all parts with specific return cols and limit.

the result contains vertex id and return cols.

Parameters:

spaceName - Nebula space name

tagName - Nebula tag name

returnCols - Nebula tag properties to return

limit - the data amount of scan in every iterator

Returns:

an iterator to get data by call ScanVertexResultIterator.next()

scanVertex

public ScanVertexResultIterator scanVertex(String spaceName,
                                           int part,
                                           String tagName,
                                           List<String> returnCols,
                                           int limit)

scan vertex of specific part with specific return cols and limit.

the result contains vertex id and return cols.

Parameters:

spaceName - Nebula space name

part - Nebula data partition

tagName - Nebula tag name

returnCols - Nebula tag properties to return

limit - the data amount of scan in every iterator

Returns:

an iterator to get data by call ScanVertexResultIterator.next()

scanVertex

public ScanVertexResultIterator scanVertex(String spaceName,
                                           String tagName,
                                           int limit)

scan vertex of all parts with no return cols and limit.

the result only contains vertex id.

Parameters:

spaceName - Nebula space name

tagName - Nebula tag name

limit - the data amount of scan in every iterator

Returns:

an iterator to get data by call ScanVertexResultIterator.next()

scanVertex

public ScanVertexResultIterator scanVertex(String spaceName,
                                           int part,
                                           String tagName,
                                           int limit)

scan vertex of specific part with no return cols and limit.

the result only contains vertex id.

Parameters:

spaceName - Nebula space name

part - Nebula data partition

tagName - Nebula tag name

limit - the data amount of scan in every iterator

Returns:

an iterator to get data by call ScanVertexResultIterator.next()

scanVertex

public ScanVertexResultIterator scanVertex(String spaceName,
                                           String tagName,
                                           List<String> returnCols,
                                           int limit,
                                           long startTime,
                                           long endTime)

scan vertex of all parts with specific returnCols, limit, startTime and endTime.

the result contains vertex id and return cols.

Parameters:

spaceName - Nebula space name

tagName - Nebula tag name

returnCols - nebula tag properties to return

limit - the data amount of scan operation for each partition in every iterator

startTime - the time range's start time of the data to be scanned, if data was insert before start time, then it will not be return.

endTime - the time range's end time of the data to be scanned, if data was insert after end time, then it will not be return.

Returns:

an iterator to get data by call ScanVertexResultIterator.next()

scanVertex

public ScanVertexResultIterator scanVertex(String spaceName,
                                           int part,
                                           String tagName,
                                           List<String> returnCols,
                                           int limit,
                                           long startTime,
                                           long endTime)

scan vertex of specific part with specific returnCols, limit, startTime and endTime.

the result contains vertex id and return cols.

Parameters:

spaceName - Nebula space name

part - Nebula data partition

tagName - Nebula tag name

returnCols - Nebula tag properties to return

limit - the data amount of scan operation for each partition in every iterator

startTime - the time range's start time of the data to be scanned, if data was insert before start time, then it will not be return.

endTime - the time range's end time of the data to be scanned, if data was insert after end time, then it will not be return.

Returns:

an iterator to get data by call ScanVertexResultIterator.next()

scanVertex

public ScanVertexResultIterator scanVertex(String spaceName,
                                           String tagName,
                                           int limit,
                                           long startTime,
                                           long endTime)

scan vertex of all parts with no returnCols, limit, startTime and endTime.

the result contains vertex id and return cols.

Parameters:

spaceName - Nebula space name

tagName - Nebula tag name

limit - the data amount of scan operation for each partition in every iterator

startTime - the time range's start time of the data to be scanned, if data was insert before start time, then it will not be return.

endTime - the time range's end time of the data to be scanned, if data was insert after end time, then it will not be return.

Returns:

an iterator to get data by call ScanVertexResultIterator.next()

scanVertex

public ScanVertexResultIterator scanVertex(String spaceName,
                                           int part,
                                           String tagName,
                                           int limit,
                                           long startTime,
                                           long endTime)

scan vertex of specific part with no returnCols, limit, startTime and endTime.

the result contains vertex id and return cols.

Parameters:

spaceName - Nebula space name

tagName - Nebula tag name

limit - the data amount of scan operation for each partition in every iterator

startTime - the time range's start time of the data to be scanned, if data was insert before start time, then it will not be return.

endTime - the time range's end time of the data to be scanned, if data was insert after end time, then it will not be return.

Returns:

an iterator to get data by call ScanVertexResultIterator.next()

scanVertex

public ScanVertexResultIterator scanVertex(String spaceName,
                                           String tagName,
                                           List<String> returnCols,
                                           int limit,
                                           long startTime,
                                           long endTime,
                                           boolean allowPartSuccess,
                                           boolean allowReadFromFollower)

scan vertex of all parts with specific return cols, limit, startTime, endTime， whether allow partial success, whether allow read from storage follower.

the result contains vertex id and return cols.

Parameters:

spaceName - Nebula graph space

tagName - Nebula tag name

returnCols - Nebula tag properties to return

limit - the data amount of scan operation for each partition in every iterator

startTime - the time range's start time of the data to be scanned, if data was insert before start time, then it will not be return.

endTime - the time range's end time of the data to be scanned, if data was insert after end time, then it will not be return.

allowPartSuccess - if allow part success

allowReadFromFollower - if allow read from follower

Returns:

an iterator to get data by call ScanVertexResultIterator.next()

scanVertex

public ScanVertexResultIterator scanVertex(String spaceName,
                                           int part,
                                           String tagName,
                                           List<String> returnCols,
                                           int limit,
                                           long startTime,
                                           long endTime,
                                           boolean allowPartSuccess,
                                           boolean allowReadFromFollower)

scan vertex of specific part with specific return cols, limit, startTime, endTime， whether allow partial success, whether allow read from storage follower.

the result contains vertex id and return cols.

Parameters:

spaceName - Nebula graph space

part - Nebula data partition

tagName - Nebula tag name

returnCols - Nebula tag properties to return

limit - the data amount of scan operation for each partition in every iterator

startTime - the time range's start time of the data to be scanned, if data was insert before start time, then it will not be return.

endTime - the time range's end time of the data to be scanned, if data was insert after end time, then it will not be return.

allowPartSuccess - if allow part success

allowReadFromFollower - if allow read from follower

Returns:

an iterator to get data by call ScanVertexResultIterator.next()

scanVertex

public ScanVertexResultIterator scanVertex(String spaceName,
                                           String tagName,
                                           int limit,
                                           long startTime,
                                           long endTime,
                                           boolean allowPartSuccess,
                                           boolean allowReadFromFollower)

scan vertex of all parts with no return cols, limit, startTime, endTime， whether allow partial success, whether allow read from storage follower.

the result only contains vertex id.

Parameters:

spaceName - Nebula graph space

tagName - Nebula tag name

limit - the data amount of scan operation for each partition in every iterator

startTime - the time range's start time of the data to be scanned, if data was insert before start time, then it will not be return.

endTime - the time range's end time of the data to be scanned, if data was insert after end time, then it will not be return.

allowPartSuccess - if allow part success

allowReadFromFollower - if allow read from follower

Returns:

an iterator to get data by call ScanVertexResultIterator.next()

scanVertex

public ScanVertexResultIterator scanVertex(String spaceName,
                                           int part,
                                           String tagName,
                                           int limit,
                                           long startTime,
                                           long endTime,
                                           boolean allowPartSuccess,
                                           boolean allowReadFromFollower)

scan vertex of specific part with no return cols, limit, startTime, endTime， whether allow partial success, whether allow read from storage follower.

the result only contains vertex id.

Parameters:

spaceName - Nebula graph space

part - Nebula data partition

tagName - Nebula tag name

limit - the data amount of scan operation for each partition in every iterator

startTime - the time range's start time of the data to be scanned, if data was insert before start time, then it will not be return.

endTime - the time range's end time of the data to be scanned, if data was insert after end time, then it will not be return.

allowPartSuccess - if allow part success

allowReadFromFollower - if allow read from follower

Returns:

an iterator to get data by call ScanVertexResultIterator.next()

scanEdge

public ScanEdgeResultIterator scanEdge(String spaceName,
                                       String edgeName,
                                       List<String> returnCols)

scan edge of all parts with return cols.

the result contains edge src id, dst id, rank and return cols.

Parameters:

spaceName - Nebula space name

edgeName - Nebula edge type name

returnCols - Nebula edge properties to return

Returns:

an iterator to get data by call ScanVertexResultIterator.next()

scanEdge

public ScanEdgeResultIterator scanEdge(String spaceName,
                                       int part,
                                       String edgeName,
                                       List<String> returnCols)

scan edge of specific part with return cols.

the result contains edge src id, dst id, rank and return cols.

Parameters:

spaceName - Nebula space name

part - Nebula data partition

edgeName - Nebula edge type name

returnCols - Nebula edge properties to return

Returns:

an iterator to get data by call ScanEdgeResultIterator.next()

scanEdge

public ScanEdgeResultIterator scanEdge(String spaceName,
                                       String edgeName)

scan edge of all parts with no return cols.

the result only contains edge src id, dst id, rank.

Parameters:

spaceName - Nebula space name

edgeName - Nebula edge type name

Returns:

an iterator to get data by call ScanEdgeResultIterator.next()

scanEdge

public ScanEdgeResultIterator scanEdge(String spaceName,
                                       int part,
                                       String edgeName)

scan edge of specific part with no return cols.

the result only contains edge src id, dst id, rank.

Parameters:

spaceName - Nebula space name

part - Nebula data partition

edgeName - Nebula edge type name

Returns:

an iterator to get data by call ScanEdgeResultIterator.next()

scanEdge

public ScanEdgeResultIterator scanEdge(String spaceName,
                                       String edgeName,
                                       List<String> returnCols,
                                       int limit)

scan edge of all parts with return cols and limit config.

the result contains edge src id, dst id, rank and return cols.

Parameters:

spaceName - Nebula space name

edgeName - Nebula edge type name

returnCols - Nebula edge properties to return

limit - the data amount of scan operation for each partition in every iterator

Returns:

an iterator to get data by call ScanEdgeResultIterator.next()

scanEdge

public ScanEdgeResultIterator scanEdge(String spaceName,
                                       int part,
                                       String edgeName,
                                       List<String> returnCols,
                                       int limit)

scan edge of specific part with return cols.

the result contains edge src id, dst id, rank and return cols.

Parameters:

spaceName - Nebula space name

edgeName - Nebula edge type name

returnCols - Nebula edge properties to return

limit - the data amount of scan operation for each partition in every iterator

Returns:

an iterator to get data by call ScanEdgeResultIterator.next()

scanEdge

public ScanEdgeResultIterator scanEdge(String spaceName,
                                       String edgeName,
                                       int limit)

scan edge of all parts with no return cols and limit config.

the result only contains edge src id, dst id, rank.

Parameters:

spaceName - Nebula space name

edgeName - Nebula edge type name

limit - the data amount of scan operation for each partition in every iterator

Returns:

an iterator to get data by call ScanEdgeResultIterator.next()

scanEdge

public ScanEdgeResultIterator scanEdge(String spaceName,
                                       int part,
                                       String edgeName,
                                       int limit)

scan edge of specific part with no return cols and limit config.

the result only contains edge src id, dst id, rank.

Parameters:

spaceName - Nebula space name

part - Nebula data partition

edgeName - Nebula edge type name

limit - the data amount of scan operation for each partition in every iterator

Returns:

an iterator to get data by call ScanEdgeResultIterator.next()

scanEdge

public ScanEdgeResultIterator scanEdge(String spaceName,
                                       String edgeName,
                                       List<String> returnCols,
                                       int limit,
                                       long startTime,
                                       long endTime)

scan edge of all parts with return cols and limit, start time, end time config.

the result only contains edge src id, dst id, rank and return cols.

Parameters:

spaceName - Nebula space name

edgeName - Nebula edge type name

returnCols - Nebula edge properties to return

limit - the data amount of scan operation for each partition in every iterator

Returns:

an iterator to get data by call ScanEdgeResultIterator.next()

scanEdge

public ScanEdgeResultIterator scanEdge(String spaceName,
                                       int part,
                                       String edgeName,
                                       List<String> returnCols,
                                       int limit,
                                       long startTime,
                                       long endTime)

scan edge of specific part with return cols and limit, start time, end time config.

the result contains edge src id, dst id, rank and return cols.

Parameters:

spaceName - Nebula space name

part - Nebula data partition

edgeName - Nebula edge type name

returnCols - Nebula edge properties to return

limit - the data amount of scan operation for each partition in every iterator

startTime - the time range's start time of the data to be scanned, if data was insert before start time, then it will not be return.

endTime - the time range's end time of the data to be scanned, if data was insert after end time, then it will not be return.

Returns:

an iterator to get data by call ScanEdgeResultIterator.next()

scanEdge

public ScanEdgeResultIterator scanEdge(String spaceName,
                                       String edgeName,
                                       int limit,
                                       long startTime,
                                       long endTime)

scan edge of all parts with no return cols and limit, start time, end time config.

the result only contains edge src id, dst id, rank.

Parameters:

spaceName - Nebula space name

edgeName - Nebula edge type name

limit - the data amount of scan operation for each partition in every iterator

startTime - the time range's start time of the data to be scanned, if data was insert before start time, then it will not be return.

endTime - the time range's end time of the data to be scanned, if data was insert after end time, then it will not be return.

Returns:

an iterator to get data by call ScanEdgeResultIterator.next()

scanEdge

public ScanEdgeResultIterator scanEdge(String spaceName,
                                       int part,
                                       String edgeName,
                                       int limit,
                                       long startTime,
                                       long endTime)

scan edge of specific part with no return cols and limit, start time, end time config.

the result only contains edge src id, dst id, rank.

Parameters:

spaceName - Nebula space name

part - Nebula data partition

edgeName - Nebula edge type name

limit - the data amount of scan operation for each partition in every iterator

startTime - the time range's start time of the data to be scanned, if data was insert before start time, then it will not be return.

endTime - the time range's end time of the data to be scanned, if data was insert after end time, then it will not be return.

Returns:

an iterator to get data by call ScanEdgeResultIterator.next()

scanEdge

public ScanEdgeResultIterator scanEdge(String spaceName,
                                       String edgeName,
                                       List<String> returnCols,
                                       int limit,
                                       long startTime,
                                       long endTime,
                                       boolean allowPartSuccess,
                                       boolean allowReadFromFollower)

scan edge of all parts with return cols and limit, start time, end time, if allow partial success, if allow read data from storage follower config.

the result contains edge src id, dst id, rank and return cols.

Parameters:

spaceName - Nebula space name

edgeName - Nebula edge type name

limit - the data amount of scan operation for each partition in every iterator

startTime - the time range's start time of the data to be scanned, if data was insert before start time, then it will not be return.

endTime - the time range's end time of the data to be scanned, if data was insert after end time, then it will not be return.

allowPartSuccess - if allow part success

allowReadFromFollower - if allow read from follower

Returns:

an iterator to get data by call ScanEdgeResultIterator.next()

scanEdge

public ScanEdgeResultIterator scanEdge(String spaceName,
                                       int part,
                                       String edgeName,
                                       List<String> returnCols,
                                       int limit,
                                       long startTime,
                                       long endTime,
                                       boolean allowPartSuccess,
                                       boolean allowReadFromFollower)

scan edge of specific part with return cols and limit, start time, end time, if allow partial success, if allow read data from storage follower config.

the result contains edge src id, dst id, rank and return cols.

Parameters:

spaceName - Nebula space name

part - Nebula data partition

edgeName - Nebula edge type name

limit - the data amount of scan operation for each partition in every iterator

startTime - the time range's start time of the data to be scanned, if data was insert before start time, then it will not be return.

endTime - the time range's end time of the data to be scanned, if data was insert after end time, then it will not be return.

allowPartSuccess - if allow part success

allowReadFromFollower - if allow read from follower

Returns:

an iterator to get data by call ScanEdgeResultIterator.next()

scanEdge

public ScanEdgeResultIterator scanEdge(String spaceName,
                                       String edgeName,
                                       int limit,
                                       long startTime,
                                       long endTime,
                                       boolean allowPartSuccess,
                                       boolean allowReadFromFollower)

scan edge of all parts with no return cols and limit, start time, end time, if allow partial success, if allow read data from storage follower config.

the result only contains edge src id, dst id, rank.

Parameters:

spaceName - Nebula space name

edgeName - Nebula edge type name

limit - the data amount of scan operation for each partition in every iterator

startTime - the time range's start time of the data to be scanned, if data was insert before start time, then it will not be return.

endTime - the time range's end time of the data to be scanned, if data was insert after end time, then it will not be return.

allowPartSuccess - if allow part success

allowReadFromFollower - if allow read from follower

Returns:

an iterator to get data by call ScanEdgeResultIterator.next()

scanEdge

public ScanEdgeResultIterator scanEdge(String spaceName,
                                       int part,
                                       String edgeName,
                                       int limit,
                                       long startTime,
                                       long endTime,
                                       boolean allowPartSuccess,
                                       boolean allowReadFromFollower)

scan edge of specific part with no return cols and limit, start time, end time, if allow partial success, if allow read data from storage follower config.

the result only contains edge src id, dst id, rank.

Parameters:

spaceName - Nebula space name

edgeName - Nebula edge type name

part - Nebula data partition

limit - the data amount of scan operation for each partition in every iterator

startTime - the time range's start time of the data to be scanned, if data was insert before start time, then it will not be return.

endTime - the time range's end time of the data to be scanned, if data was insert after end time, then it will not be return.

allowPartSuccess - if allow part success

allowReadFromFollower - if allow read from follower

Returns:

an iterator to get data by call ScanEdgeResultIterator.next()

close

public void close()

release storage client

getConnection

protected GraphStorageConnection getConnection()

return client's connection session

Returns:

StorageConnection