Inheritance diagram for StorageClient:

Collaboration diagram for StorageClient:

Public Member Functions
	StorageClient (String ip, int port)
	Get a Nebula Storage client that executes the scan query to get NebulaGraph's data with one server host. More...

	StorageClient (List< HostAddress > addresses)
	Get a Nebula Storage client that executes the scan query to get NebulaGraph's data with multi servers' host. More...

	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. More...

	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.

boolean	connect () throws Exception
	Connect to Nebula Storage server. More...

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. More...

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. More...

ScanVertexResultIterator	scanVertex (String spaceName, String tagName)
	scan vertex of all parts with no return cols. More...

ScanVertexResultIterator	scanVertex (String spaceName, int part, String tagName)
	scan vertex of specific part with no return cols. More...

ScanVertexResultIterator	scanVertex (String spaceName, String tagName, List< String > returnCols, int limit)
	scan vertex of all parts with specific return cols and limit. More...

ScanVertexResultIterator	scanVertex (String spaceName, int part, String tagName, List< String > returnCols, int limit)
	scan vertex of specific part with specific return cols and limit. More...

ScanVertexResultIterator	scanVertex (String spaceName, String tagName, int limit)
	scan vertex of all parts with no return cols and limit. More...

ScanVertexResultIterator	scanVertex (String spaceName, int part, String tagName, int limit)
	scan vertex of specific part with no return cols and limit. More...

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. More...

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. More...

ScanVertexResultIterator	scanVertex (String spaceName, String tagName, int limit, long startTime, long endTime)
	scan vertex of all parts with no returnCols, limit, startTime and endTime. More...

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. More...

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. More...

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. More...

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. More...

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. More...

ScanEdgeResultIterator	scanEdge (String spaceName, String edgeName, List< String > returnCols)
	scan edge of all parts with return cols. More...

ScanEdgeResultIterator	scanEdge (String spaceName, int part, String edgeName, List< String > returnCols)
	scan edge of specific part with return cols. More...

ScanEdgeResultIterator	scanEdge (String spaceName, String edgeName)
	scan edge of all parts with no return cols. More...

ScanEdgeResultIterator	scanEdge (String spaceName, int part, String edgeName)
	scan edge of specific part with no return cols. More...

ScanEdgeResultIterator	scanEdge (String spaceName, String edgeName, List< String > returnCols, int limit)
	scan edge of all parts with return cols and limit config. More...

ScanEdgeResultIterator	scanEdge (String spaceName, int part, String edgeName, List< String > returnCols, int limit)
	scan edge of specific part with return cols. More...

ScanEdgeResultIterator	scanEdge (String spaceName, String edgeName, int limit)
	scan edge of all parts with no return cols and limit config. More...

ScanEdgeResultIterator	scanEdge (String spaceName, int part, String edgeName, int limit)
	scan edge of specific part with no return cols and limit config. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

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. More...

void	close ()
	release storage client

Protected Member Functions
GraphStorageConnection	getConnection ()
	return client's connection session More...

Detailed Description

Definition at line 30 of file StorageClient.java.

Constructor & Destructor Documentation

◆ StorageClient() [1/3]

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

Definition at line 51 of file StorageClient.java.

◆ StorageClient() [2/3]

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

Definition at line 61 of file StorageClient.java.

◆ StorageClient() [3/3]

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

Definition at line 73 of file StorageClient.java.

Member Function Documentation

◆ connect()

boolean connect ( ) throws Exception

Connect to Nebula Storage server.

Returns: true if connect successfully.

Definition at line 100 of file StorageClient.java.

◆ getConnection()

GraphStorageConnection getConnection ( )

protected

return client's connection session

Returns: StorageConnection

Definition at line 1109 of file StorageClient.java.

◆ scanEdge() [1/16]

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()

Definition at line 682 of file StorageClient.java.

Here is the call graph for this function:

◆ scanEdge() [2/16]

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()

Definition at line 749 of file StorageClient.java.

Here is the call graph for this function:

◆ scanEdge() [3/16]

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()

Definition at line 843 of file StorageClient.java.

Here is the call graph for this function:

◆ scanEdge() [4/16]

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()

Definition at line 977 of file StorageClient.java.

Here is the call graph for this function:

◆ scanEdge() [5/16]

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()

Definition at line 653 of file StorageClient.java.

Here is the call graph for this function:

◆ scanEdge() [6/16]

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()

Definition at line 716 of file StorageClient.java.

Here is the call graph for this function:

◆ scanEdge() [7/16]

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()

Definition at line 792 of file StorageClient.java.

Here is the call graph for this function:

◆ scanEdge() [8/16]

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()

Definition at line 909 of file StorageClient.java.

Here is the call graph for this function:

◆ scanEdge() [9/16]

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()

Definition at line 668 of file StorageClient.java.

Here is the call graph for this function:

◆ scanEdge() [10/16]

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()

Definition at line 733 of file StorageClient.java.

Here is the call graph for this function:

◆ scanEdge() [11/16]

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()

Definition at line 818 of file StorageClient.java.

Here is the call graph for this function:

◆ scanEdge() [12/16]

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()

Definition at line 941 of file StorageClient.java.

Here is the call graph for this function:

◆ scanEdge() [13/16]

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()

Definition at line 636 of file StorageClient.java.

Here is the caller graph for this function:

◆ scanEdge() [14/16]

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()

Definition at line 698 of file StorageClient.java.

Here is the call graph for this function:

◆ scanEdge() [15/16]

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()

Definition at line 765 of file StorageClient.java.

Here is the call graph for this function:

◆ scanEdge() [16/16]

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()

Definition at line 872 of file StorageClient.java.

Here is the call graph for this function:

◆ scanVertex() [1/16]

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()

Definition at line 168 of file StorageClient.java.

Here is the call graph for this function:

◆ scanVertex() [2/16]

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()

Definition at line 239 of file StorageClient.java.

Here is the call graph for this function:

◆ scanVertex() [3/16]

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()

Definition at line 336 of file StorageClient.java.

Here is the call graph for this function:

◆ scanVertex() [4/16]

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()

Definition at line 510 of file StorageClient.java.

Here is the call graph for this function:

◆ scanVertex() [5/16]

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()

Definition at line 140 of file StorageClient.java.

Here is the call graph for this function:

◆ scanVertex() [6/16]

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()

Definition at line 203 of file StorageClient.java.

Here is the call graph for this function:

◆ scanVertex() [7/16]

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()

Definition at line 288 of file StorageClient.java.

Here is the call graph for this function:

◆ scanVertex() [8/16]

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()

Definition at line 423 of file StorageClient.java.

Here is the call graph for this function:

◆ scanVertex() [9/16]

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()

Definition at line 154 of file StorageClient.java.

Here is the call graph for this function:

◆ scanVertex() [10/16]

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()

Definition at line 222 of file StorageClient.java.

Here is the call graph for this function:

◆ scanVertex() [11/16]

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()

Definition at line 313 of file StorageClient.java.

Here is the call graph for this function:

◆ scanVertex() [12/16]

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()

Definition at line 466 of file StorageClient.java.

Here is the call graph for this function:

◆ scanVertex() [13/16]

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()

Definition at line 123 of file StorageClient.java.

Here is the caller graph for this function:

◆ scanVertex() [14/16]

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()

Definition at line 183 of file StorageClient.java.

Here is the call graph for this function:

◆ scanVertex() [15/16]

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()

Definition at line 262 of file StorageClient.java.

Here is the call graph for this function:

◆ scanVertex() [16/16]

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()

Definition at line 375 of file StorageClient.java.

Here is the call graph for this function:

The documentation for this class was generated from the following file:

client/src/main/java/com/vesoft/nebula/client/storage/StorageClient.java

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ StorageClient() [1/3]

◆ StorageClient() [2/3]

◆ StorageClient() [3/3]

Member Function Documentation

◆ connect()

◆ getConnection()

◆ scanEdge() [1/16]

◆ scanEdge() [2/16]

◆ scanEdge() [3/16]

◆ scanEdge() [4/16]

◆ scanEdge() [5/16]

◆ scanEdge() [6/16]

◆ scanEdge() [7/16]

◆ scanEdge() [8/16]

◆ scanEdge() [9/16]

◆ scanEdge() [10/16]

◆ scanEdge() [11/16]

◆ scanEdge() [12/16]

◆ scanEdge() [13/16]

◆ scanEdge() [14/16]

◆ scanEdge() [15/16]

◆ scanEdge() [16/16]

◆ scanVertex() [1/16]

◆ scanVertex() [2/16]

◆ scanVertex() [3/16]

◆ scanVertex() [4/16]

◆ scanVertex() [5/16]

◆ scanVertex() [6/16]

◆ scanVertex() [7/16]

◆ scanVertex() [8/16]

◆ scanVertex() [9/16]

◆ scanVertex() [10/16]

◆ scanVertex() [11/16]

◆ scanVertex() [12/16]

◆ scanVertex() [13/16]

◆ scanVertex() [14/16]

◆ scanVertex() [15/16]

◆ scanVertex() [16/16]