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 à l'aide de GET et de la méthode POST. Les méthodes DELETE et PUT ne sont pas prises en charge.

Les instructions suivantes vous guident à travers la connexion au point de terminaison openCypher à l'aide de la commande curl et de HTTPS. Vous devez suivre ces instructions à partir d'une instance Amazon EC2 dans le même cloud privé virtuel (VPC) (VPC) que l'instance de base de données Neptune.

La syntaxe est la suivante :

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

Voici des exemples de requêtes de lecture, l'une avec POST et l'autre avec GET :

1. En utilisant POST :

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

2. En utilisant GET (la chaîne de requête est encodée en URL) :

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

Voici des exemples de requêtes d'écriture ou de mise à jour, l'une avec POST et l'autre avec GET :

1. En utilisant POST :

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

2. En utilisant GET (la chaîne de requête est encodée en URL) :

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

Format de résultats openCypher JSON par défaut

Le format JSON suivant est renvoyé par défaut ou en définissant explicitement l'en-tête de demande sur Accept: 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 champ, results, qui comporte les valeurs renvoyées par la requête. Les exemples ci-dessous montrent la mise en forme JSON pour les valeurs courantes.

Exemple de réponse pour une valeur :

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

Exemple de réponse pour un 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 pour une relation :

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

Exemple de réponse pour un 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
          }
        }
      ]
    }
  ]
}