Updated on 2024-01-04 GMT+08:00

K-hop (1.0.0)

Table 1 parameters parameter description

Parameter

Mandatory

Type

Description

k

Yes

Integer

Number of hops. The value ranges from 1 to 100.

num_thread

No

Integer

Number of concurrent threads. The value ranges from 1 to 40. If the value is less than 1, it is automatically set to 1. If the value is greater than 40, it is automatically set to 40. The default value is 4.

source

Yes

String

Vertex ID

mode

No

String

Direction. The options are as follows:

  • OUT: Hop from the outgoing edges
  • IN: Hop from the incoming edges
  • ALL: Hop from edges in both directions

The default value is OUT.

statistics

No

Boolean

Whether to only return the neighbor count statistics results, with a value of true or false. The default value is false.

Table 2 response_data parameter description

Parameter

Type

Description

vertices

List

ID of the vertex within k hops. The format is as follows:

[vertexId,...],

where vertexId is of the string type.

source

String

Source vertex ID

k

Integer

Number of hops

k_hop_neighbors

Integer

Number of vertices within k hops (excluding the source vertex)