A set of parameters for Kinetica.getGraphEntities. More…
Inheritance diagram for kinetica.GetGraphEntitiesRequest:
[legend]
Collaboration diagram for kinetica.GetGraphEntitiesRequest:
[legend]
Classes | |
| struct | Options |
| A set of string constants for the parameter GetGraphEntitiesRequest.options. More… | |
Public Member Functions | |
| GetGraphEntitiesRequest () | |
| Constructs a GetGraphEntitiesRequest object with default parameters. | |
| GetGraphEntitiesRequest (string graph_name, long? offset=null, long? limit=null, IDictionary< string, string > options=null) | |
| Constructs a GetGraphEntitiesRequest object with the specified parameters. | |
| GetGraphEntitiesRequest () | |
| Constructs a GetGraphEntitiesRequest object with default parameters. | |
| GetGraphEntitiesRequest (string graph_name, long? offset=null, long? limit=null, IDictionary< string, string > options=null) | |
| Constructs a GetGraphEntitiesRequest object with the specified parameters. | |
| Public Member Functions inherited from kinetica.KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type. | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type. | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object. | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object. | |
Properties | |
| string | graph_name [get, set] |
| Name of the graph from which to retrieve entities. | |
| long | offset = 0 [get, set] |
| Starting index of the entities to retrieve (0-based). | |
| long | limit = 10000 [get, set] |
| Number of entities to retrieve starting from GetGraphEntitiesRequest.offset. | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Optional parameters. | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from kinetica.KineticaData | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. | |
Detailed Description
A set of parameters for Kinetica.getGraphEntities.
Retrieves node or edge entities from an existing graph, with pagination support via offset and limit. Use Kinetica.showGraph to obtain the total number of nodes and edges.
Definition at line 18 of file GetGraphEntities.cs.
Constructor & Destructor Documentation
◆ GetGraphEntitiesRequest() [1/4]
| inline |
Constructs a GetGraphEntitiesRequest object with default parameters.
Definition at line 278 of file GetGraphEntities.cs.
◆ GetGraphEntitiesRequest() [2/4]
| inline |
Constructs a GetGraphEntitiesRequest object with the specified parameters.
Parameters
| graph_name | Name of the graph from which to retrieve entities. |
| offset | Starting index of the entities to retrieve (0-based). The default value is 0. |
| limit | Number of entities to retrieve starting from offset . A value of -1 returns all entities from the offset to the end. Note: the entities_int or entities_string array size will be 2x this value for nodes (stride 2) or 4x for edges (stride 4). The default value is 10000. |
| options | Optional parameters.
|
Definition at line 410 of file GetGraphEntities.cs.
◆ GetGraphEntitiesRequest() [3/4]
| inline |
Constructs a GetGraphEntitiesRequest object with default parameters.
Definition at line 278 of file GetGraphEntities.cs.
◆ GetGraphEntitiesRequest() [4/4]
| inline |
Constructs a GetGraphEntitiesRequest object with the specified parameters.
Parameters
| graph_name | Name of the graph from which to retrieve entities. |
| offset | Starting index of the entities to retrieve (0-based). The default value is 0. |
| limit | Number of entities to retrieve starting from offset . A value of -1 returns all entities from the offset to the end. Note: the entities_int or entities_string array size will be 2x this value for nodes (stride 2) or 4x for edges (stride 4). The default value is 10000. |
| options | Optional parameters.
|
Definition at line 410 of file GetGraphEntities.cs.
Property Documentation
◆ graph_name
| getset |
Name of the graph from which to retrieve entities.
Definition at line 141 of file GetGraphEntities.cs.
◆ limit
| getset |
Number of entities to retrieve starting from GetGraphEntitiesRequest.offset.
A value of -1 returns all entities from the offset to the end. Note: the entities_int or entities_string array size will be 2x this value for nodes (stride 2) or 4x for edges (stride 4). The default value is 10000.
Definition at line 156 of file GetGraphEntities.cs.
◆ offset
| getset |
Starting index of the entities to retrieve (0-based).
The default value is 0.
Definition at line 146 of file GetGraphEntities.cs.
◆ options
| getset |
Optional parameters.
- ENTITY_TYPE: The type of entity to retrieve. Supported values:The default value is EDGE.
- SERVER_ID: Indicates which graph server to send the request to. Required when the graph is distributed across multiple servers. The default value is ‘0’.
- CONCISE_EDGE_CONNECTIVITY: When true, edges are emitted in a compact connectivity form regardless of the graph’s identifier type: entities_int contains stride-4 records [edge_id, node1_index, node2_index, edge_label_index] where node1_index/node2_index are 0-based positions into the node array (obtained from a node-entity call on the same graph). When requesting nodes with this option, the response includes tombstoned (deleted) slots in order to keep position indices stable so edge indices resolve correctly; deleted slots carry id=0 for integer graphs or an empty identifier for string/WKT graphs. For paginated node calls, subtract GetGraphEntitiesRequest.offset from an edge endpoint index to locate it within the returned page. Supported values:
- TRUE: Compact integer connectivity for edges; deleted node slots included in node output.
- FALSE: Default: edges emit node identifiers (int/string/WKT) matching the graph; deleted nodes are skipped.
- INCLUDE_WEIGHTS: When true and
options entity_typeis ‘edge’, the response entities_weight array is populated with one float weight per emitted edge (aligned 1:1 with the edge records in entities_int or entities_string). Empty when the graph has no weights component or when requesting nodes. Supported values:- TRUE: Populate entities_weight with per-edge weights (edge requests only).
- FALSE: Default: entities_weight is empty.
The default value is an empty Dictionary.
Definition at line 274 of file GetGraphEntities.cs.
The documentation for this class was generated from the following files:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/GetGraphEntities.cs
- Kinetica/Protocol/GetGraphEntities.cs