GraphQuery | References | ArcGIS Maps SDK for JavaScript

import GraphQuery from "@arcgis/core/rest/knowledgeGraph/GraphQuery.js";

Inheritance:: GraphQuery→Accessor

Subclasses:: GraphQueryStreaming

Since: ArcGIS Maps SDK for JavaScript 4.25

Defines the query operation performed on a knowledge graph service's graph resource. The entities and relationships in the graph are queried by sending an Esri implementation of openCypher query.

Notes

ArcGIS Knowledge does not support write capabilities of the openCypher query language. All openCypher queries must be read-only.

See also

Example

//typical use case
KnowledgeGraphModule.executeQuery(
 knowledgeGraph, //graph
 { //queryArguments
   openCypherQuery: "MATCH (n) RETURN n LIMIT 1", //query
  }).then((queryResult) => {
    //do something with the result
});

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`GraphQueryProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`openCypherQuery`	`string`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

openCypherQuery

Property

Type: string

The Esri implementation of openCypher query to be executed against the knowledge graph.

Required

executeQuery() will fail if not provided.

Default value: ""