AWS IoT TwinMaker Knowledge Graph, zusätzliche Ressourcen

Ruft alle Entitäten mit einem Filter ab

SELECT entity
FROM EntityGraph MATCH (entity)
WHERE entity.entityName = 'room_0'

Diese Abfrage gibt alle Entitäten in einem Workspace mit dem Namen zurückroom_0.

FROMKlausel: EntityGraph ist die Grafiksammlung, die alle Entitäten und ihre Beziehungen in einem Workspace enthält. Diese Sammlung wird automatisch auf der AWS IoT TwinMaker Grundlage der Entitäten in Ihrem Workspace erstellt und verwaltet.

MATCHKlausel: gibt ein Muster an, das einem Teil des Diagramms entspricht. In diesem Fall (entity) entspricht das Muster jedem Knoten im Diagramm und ist an die Entitätsvariable gebunden. Auf die FROM Klausel muss die MATCH Klausel folgen.

WHEREKlausel: gibt einen Filter für das entityName Feld des Knotens an, mit dem der Wert übereinstimmen mussroom_0.

SELECTKlausel: spezifiziert die entity Variable, sodass der gesamte Entitätsknoten zurückgegeben wird.

Antwort:

{
  "columnDescriptions": [
    {
      "name": "entity",
      "type": "NODE"
    }
  ],
  "rows": [
    {
      "rowData": [
        {
          "arn": "arn:aws:iottwinmaker:us-east-1: 577476956029: workspace / SmartBuilding8292022 / entity / room_18f3ef90 - 7197 - 53 d1 - abab - db9c9ad02781 ",
          "creationDate": 1661811123914,
          "entityId": "room_18f3ef90-7197-53d1-abab-db9c9ad02781",
          "entityName": "room_0",
          "lastUpdateDate": 1661811125072,
          "workspaceId": "SmartBuilding8292022",
          "description": "",
          "components": [
            {
              "componentName": "RoomComponent",
              "componentTypeId": "com.example.query.construction.room",
              "properties": [
                {
                  "propertyName": "roomFunction",
                  "propertyValue": "meeting"
                },
                {
                  "propertyName": "roomNumber",
                  "propertyValue": 0
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Die columnDescriptions gibt Metadaten über die Spalte zurück, z. B. den Namen und den Typ. Der zurückgegebene Typ istNODE. Dies zeigt an, dass der gesamte Knoten zurückgegeben wurde. Andere Werte für den Typ können seinEDGE, die auf eine Beziehung hinweisen würdenVALUE, oder die auf einen Skalarwert hinweisen würden, z. B. eine Ganzzahl oder eine Zeichenfolge.

Das rows gibt eine Liste von Zeilen zurück. Da nur eine Entität gefunden wurde, rowData wird eine zurückgegeben, die alle Felder einer Entität enthält.

Jeder Knoten enthält alle Felder auf Entitätsebene wie entityId arn und components Felder auf Komponentenebene wie und sowie Felder auf Eigenschaftsebene properties wie componentTypeId undcomponentName, alles als verschachteltes JSON. propertyName propertyValue

Ruft alle Beziehungen mit einem Filter ab:

SELECT relationship
FROM EntityGraph MATCH (e1)-[relationship]->(e2)
WHERE relationship.relationshipName = 'isLocationOf'

Diese Abfrage gibt alle Beziehungen in einem Arbeitsbereich mit dem Beziehungsnamen zurückisLocationOf.

Die MATCH Klausel: gibt ein Muster an, das zwei Knoten (gekennzeichnet durch()) entspricht, die durch eine gerichtete Kante (gekennzeichnet durch-[]->) miteinander verbunden und an eine Variable gebunden sind, die aufgerufen wirdrelationship.

Die WHERE Klausel: gibt einen Filter für das relationshipName Feld der Kante an, in dem sich der Wert befindetisLocationOf.

Die SELECT Klausel: gibt die Beziehungsvariable an, sodass der gesamte Kantenknoten zurückgegeben wird.

Antwort

{
    "columnDescriptions": [{
        "name": "relationship",
        "type": "EDGE"
    }],
    "rows": [{
        "rowData": [{
            "relationshipName": "isLocationOf",
            "sourceEntityId": "floor_83faea7a-ea3b-56b7-8e22-562f0cf90c5a",
            "targetEntityId": "building_4ec7f9e9-e67e-543f-9d1b- 235df7e3f6a8",
            "sourceComponentName": "FloorComponent",
            "sourceComponentTypeId": "com.example.query.construction.floor"
        }]
    },
        ... //rest of the rows are omitted
    ]
}

Der Typ der Spalte in columnDescriptions ist einEDGE.

Jedes rowData steht für eine Kante mit Feldern wierelationshipName. Dies entspricht dem Namen der Beziehungseigenschaft, der für die Entität definiert ist. DiesourceEntityId, sourceComponentName und sourceComponentTypeId geben Auskunft darüber, für welche Entität und Komponente die Beziehungseigenschaft definiert wurde. Das targetEntityId gibt an, auf welche Entität diese Beziehung zeigt.

Ruft alle Entitäten mit einer bestimmten Beziehung zu einer bestimmten Entität ab

SELECT e2.entityName
      FROM EntityGraph MATCH (e1)-[r]->(e2)
      WHERE relationship.relationshipName = 'isLocationOf'
      AND e1.entityName = 'room_0'

Diese Abfrage gibt alle Entitätsnamen aller Entitäten zurück, die eine isLocationOf Beziehung zu der room_0 Entität haben.

Die MATCH Klausel: gibt ein Muster an, das zwei beliebigen Knoten (e1,e2) entspricht, die eine gerichtete Kante (r) haben.

Die WHERE Klausel: gibt einen Filter für den Beziehungsnamen und den Namen der Quellentität an.

Die SELECT Klausel: gibt das entityName Feld im e2 Knoten zurück.

Antwort

{
  "columnDescriptions": [
    {
       "name": "entityName",
       "type": "VALUE"
    }
  ],
   "rows": [
    {
       "rowData": [
         "floor_0"
      ]
    }
  ]
}

In den ColumnDescriptions ist der Typ der Spalte, VALUE da es sich um eine entityName Zeichenfolge handelt.

Eine Entität,floor_0, wird zurückgegeben.

Entspricht dem Knoten 'b', der auf den Knoten 'a' zeigt:

FROM EntityGraph MATCH (a)-[rel]-(b)

Ordnet Knoten 'a' zu, der auf Knoten 'b' zeigt:

FROM EntityGraph MATCH (a)-[]->(b)

Es gibt keine Variable, die an eine Beziehung gebunden ist, vorausgesetzt, dass für die Beziehung kein Filter angegeben werden muss.

Ordnen Sie Knoten 'a', der auf Knoten 'b' zeigt, und Knoten 'b', der auf Knoten 'a' zeigt, zu:

FROM EntityGraph MATCH (a)-[rel]-(b)

Dadurch werden zwei Treffer zurückgegeben: eine von 'a' nach 'b' und eine weitere von 'b' nach 'a', daher wird empfohlen, wo immer möglich gerichtete Kanten zu verwenden.

Der Beziehungsname ist auch eine Bezeichnung für das EigenschaftsdiagrammEntityGraph, sodass Sie den Beziehungsnamen einfach hinter einem Doppelpunkt (:) angeben können, anstatt rel.relationshipName in der WHERE Klausel einen Filter für anzugeben.

FROM EntityGraph MATCH (a)-[:isLocationOf]-(b)

Verkettung: Muster können so verkettet werden, dass sie in mehreren Beziehungen übereinstimmen.

FROM EntityGraph MATCH (a)-[rel1]->(b)-[rel2]-(c)

Variable Hop-Muster können sich auch über mehrere Knoten und Kanten erstrecken:

FROM EntityGraph MATCH (a)-[]->{1,5}(b)

Diese Abfrage entspricht jedem Muster mit ausgehenden Kanten von Knoten 'a' innerhalb von 1 bis 5 Hops. Die zulässigen Quantifizierer sind:

{m,n}- zwischen m und n Wiederholungen

{m,}- m oder mehr Wiederholungen.

Einen Knoten zurückgeben:

SELECT e
FROM EntityGraph MATCH (e)

Gibt eine Kante zurück:

SELECT r
FROM EntityGraph MATCH (e1)-[r]->(e2)

Gibt einen Skalarwert zurück:

SELECT floor.entityName, room.description, p.propertyValue AS roomfunction
FROM EntityGraph MATCH (floor)-[:isLocationOf]-(room),
room.components AS c, c.properties AS p

Formatieren Sie den Namen des Ausgabefeldes, indem Sie ihn mit einem Alias versehen. AS Hier wird statt propertyValue als Spaltenname in der Antwort roomfunction zurückgegeben.

Aliase zurückgeben:

SELECT floor.entityName AS floorName, luminaire.entityName as luminaireName
FROM EntityGraph MATCH (floor)-[:isLocationOf]-(room)-[:hasPart]-
(lightingZone)-[:feed]-(luminaire)
WHERE floor.entityName = 'floor_0'
AND luminaire.entityName like 'lumin%'

Es wird dringend empfohlen, Aliase zu verwenden, um explizit zu sein, die Lesbarkeit zu erhöhen und Mehrdeutigkeiten in Ihren Abfragen zu vermeiden.

Die unterstützten logischen Operatoren sind ANDNOT, undOR.

Die unterstützten Vergleichsoperatoren sind <<=,>,=>,=, und!=.

Verwenden Sie das IN Schlüsselwort, wenn Sie mehrere OR Bedingungen für dasselbe Feld angeben möchten.

Filtern Sie nach einem Entitäts-, Komponenten- oder Eigenschaftsfeld:

FROM EntityGraph MATCH (e), e.components AS c, c.properties AS p
WHERE e.entityName = 'room_0'
AND c.componentTypeId = 'com.example.query.construction.room',
AND p.propertyName = 'roomFunction'
AND NOT p.propertyValue = 'meeting'
OR p.propertyValue = 'office'

Filtern Sie nach der configuration Eigenschaft. Hier unit ist der Schlüssel in der Konfigurationsübersicht und der Celsius Wert.

WHERE p.definition.configuration.unit = 'Celsius'

Prüfen Sie, ob eine Karteneigenschaft einen bestimmten Schlüssel und Wert enthält:

WHERE p.propertyValue.length = 20.0

Prüft, ob eine Karteneigenschaft einen bestimmten Schlüssel enthält:

WHERE NOT p.propertyValue.length IS MISSING

Prüft, ob eine Listeneigenschaft einen bestimmten Wert enthält:

WHERE 10.0 IN p.propertyValue

Verwenden Sie die lower() Funktion für Vergleiche ohne Berücksichtigung der Groß- und Kleinschreibung. Standardmäßig wird bei allen Vergleichen zwischen Groß- und Kleinschreibung unterschieden.

WHERE lower(p.propertyValue) = 'meeting'

Infix-Suche: %room%

Präfix-Suche: room%

Suffix-Suche: %room

Wenn Sie '%' in Ihren Werten haben, fügen Sie ein Escape-Zeichen ein LIKE und geben Sie das Escape-Zeichen mit ESCAPE an.

Das DISTINCT Schlüsselwort entfernt Duplikate aus dem Endergebnis.

DISTINCTwird bei komplexen Datentypen nicht unterstützt.

Das COUNT Schlüsselwort berechnet die Anzahl der Elemente in einem Abfrageergebnis.

COUNTwird für verschachtelte komplexe Felder und Felder mit Grafikmustern nicht unterstützt.

COUNTAggregation wird bei DISTINCT verschachtelten Abfragen nicht unterstützt.

Beispielsweise wird COUNT(DISTINCT e.entityId) nicht unterstützt.

Abfragen mit variablem Hop

SELECT p FROM EntityGraph MATCH p = (a)-[]->{1, 3}(b)

Bei dieser Abfrage werden Knoten-Metadaten beliebiger Muster mit ausgehenden Kanten von Knoten A innerhalb von 1 bis 3 Hops abgeglichen und projiziert.

Hop-Abfragen wurden behoben

SELECT p FROM EntityGraph MATCH p = (a)-[]->(b)<-[]-(c)

Diese Abfrage gleicht Metadaten von Entitäten und eingehenden Kanten ab und projiziert sie auf b.

Ungerichtete Abfragen

SELECT p FROM EntityGraph MATCH p = (a)-[]-(b)-[]-(c)

Diese Abfrage vergleicht und projiziert die Metadaten von Knoten in 1-Hop-Mustern, die a und c über b verbinden.

{
    "columnDescriptions": [
        {
            "name": "path",
            "type": "PATH"
        }
    ],
    "rows": [
        {
            "rowData": [
                {
                    "path": [
                        {
                            "entityId": "a",
                            "entityName": "a"
                        },
                        {
                            "relationshipName": "a-to-b-relation",
                            "sourceEntityId": "a",
                            "targetEntityId": "b"
                        },
                        {
                            "entityId": "b",
                            "entityName": "b"
                        }
                    ]
                }
            ]
        },
        {
            "rowData": [
                {
                    "path": [
                        {
                            "entityId": "b",
                            "entityName": "b"
                        },
                        {
                            "relationshipName": "b-to-c-relation",
                            "sourceEntityId": "b",
                            "targetEntityId": "c"
                        },
                        {
                            "entityId": "c",
                            "entityName": "c"
                        }
                    ]
                }
            ]
        }
    ]
}

Diese PATH Abfrageantwort besteht nur aus Metadaten, die alle Knoten und Kanten der einzelnen Knoten path/pattern zwischen a und c über b identifizieren.

Das LIMIT Schlüsselwort wirkt sich auf die Abfrage aus und begrenzt die resultierenden Zeilen. Wenn Sie die Anzahl der pro API-Aufruf zurückgegebenen Ergebnisse kontrollieren möchten, ohne die Gesamtzahl der zurückgegebenen Ergebnisse zu begrenzen, verwenden SieLIMIT.

max-resultsist ein optionaler Parameter für die ExecuteQuery API-Aktion. max-resultsgilt nur für die API und dafür, wie Ergebnisse im Rahmen der obigen Abfrage gelesen werden.

Durch die Verwendung max-results in einer Abfrage können Sie die Anzahl der angezeigten Ergebnisse reduzieren, ohne die tatsächliche Anzahl der zurückgegebenen Ergebnisse zu begrenzen.

Die next-token Zeichenfolge gibt die nächste Ergebnisseite an. Weitere Informationen finden Sie in der ExecuteQueryAPI-Aktion.