Le point de terminaison HTTPS Amazon Neptune OpenCypher

Requêtes de lecture et d'écriture OpenCypher sur le point de terminaison HTTPS

Le point de terminaison HTTPS OpenCypher prend en charge les requêtes de lecture et de mise à jour utilisant à la fois laPOST méthodeGET et la. LesPUT méthodesDELETE et ne sont pas prises en charge.

La syntaxe est la suivante :

HTTPS://(the server):(the port number)/openCypher

Voici des exemples de requêtes de lecture, l'une qui utilisePOST et l'autre qui utiliseGET :

1. En utilisantPOST :

curl HTTPS://server:port/openCypher \
  -d "query=MATCH (n1) RETURN n1;"

2. En utilisantGET (la chaîne de requête est codée en URL) :

curl -X GET \
  "HTTPS://server:port/openCypher?query=MATCH%20(n1)%20RETURN%20n1"

Voici des exemples de requêtes d'écriture/de mise à jour, l'une qui utilisePOST et l'autre qui utiliseGET :

1. En utilisantPOST :

curl HTTPS://server:port/openCypher \
  -d "query=CREATE (n:Person { age: 25 })"

2. En utilisantGET (la chaîne de requête est codée en URL) :

curl -X GET \
  "HTTPS://server:port/openCypher?query=CREATE%20(n%3APerson%20%7B%20age%3A%2025%20%7D)"

Le format de résultats JSON d'OpenCypher par défaut

Le format JSON suivant est renvoyé par défaut, ou en définissant explicitement l'en-tête de la demande surAccept: application/json. Ce format est conçu pour être facilement analysé en objets à l'aide des fonctionnalités du langage natif de la plupart des bibliothèques.

Le document JSON renvoyé contient un champresults, qui contient les valeurs renvoyées par la requête. Les exemples ci-dessous montrent le formatage JSON pour les valeurs courantes.

Exemple de réponse à une valeur :

{
  "results": [
    {
      "count(a)": 121
    }
  ]
}

Exemple de réponse de nœud :

{
  "results": [
    {
      "a": {
        "~id": "22",
        "~entityType": "node",
        "~labels": [
          "airport"
        ],
        "~properties": {
          "desc": "Seattle-Tacoma",
          "lon": -122.30899810791,
          "runways": 3,
          "type": "airport",
          "country": "US",
          "region": "US-WA",
          "lat": 47.4490013122559,
          "elev": 432,
          "city": "Seattle",
          "icao": "KSEA",
          "code": "SEA",
          "longest": 11901
        }
      }
    }
  ]
}

Exemple de réponse relationnelle :

{
  "results": [
    {
      "r": {
        "~id": "7389",
        "~entityType": "relationship",
        "~start": "22",
        "~end": "151",
        "~type": "route",
        "~properties": {
          "dist": 956
        }
      }
    }
  ]
}

Exemple de réponse de chemin :

{
  "results": [
    {
      "p": [
        {
          "~id": "22",
          "~entityType": "node",
          "~labels": [
            "airport"
          ],
          "~properties": {
            "desc": "Seattle-Tacoma",
            "lon": -122.30899810791,
            "runways": 3,
            "type": "airport",
            "country": "US",
            "region": "US-WA",
            "lat": 47.4490013122559,
            "elev": 432,
            "city": "Seattle",
            "icao": "KSEA",
            "code": "SEA",
            "longest": 11901
          }
        },
        {
          "~id": "7389",
          "~entityType": "relationship",
          "~start": "22",
          "~end": "151",
          "~type": "route",
          "~properties": {
            "dist": 956
          }
        },
        {
          "~id": "151",
          "~entityType": "node",
          "~labels": [
            "airport"
          ],
          "~properties": {
            "desc": "Ontario International Airport",
            "lon": -117.600997924805,
            "runways": 2,
            "type": "airport",
            "country": "US",
            "region": "US-CA",
            "lat": 34.0559997558594,
            "elev": 944,
            "city": "Ontario",
            "icao": "KONT",
            "code": "ONT",
            "longest": 12198
          }
        }
      ]
    }
  ]
}