Unterstützung und Kompatibilität von Gremlin-Diagrammen in Azure Cosmos DB mit TinkerPop-FeaturesAzure Cosmos DB Gremlin graph support and compatibility with TinkerPop features

• 11/11/2020
• 8 Minuten Lesedauer
• • S
  • o
  • O

GILT FÜR: Gremlin-API

Azure Cosmos DB unterstützt die Apache Tinkerpop-Graphdurchlauf-Sprache, auch als Gremlin bezeichnet.Azure Cosmos DB supports Apache Tinkerpop's graph traversal language, known as Gremlin. Mithilfe der Gremlin-Sprache können Sie Diagrammentitäten (Vertices und Edges) erstellen, Eigenschaften innerhalb dieser Entitäten ändern, Abfragen und Traversierungen ausführen und Entitäten löschen.You can use the Gremlin language to create graph entities (vertices and edges), modify properties within those entities, perform queries and traversals, and delete entities.

Die Azure Cosmos DB Graph-Engine hält sich eng an die Apache TinkerPop-Spezifikation für die Durchlaufschritte, es gibt jedoch Azure Cosmos DB-spezifische Unterschiede bei der Implementierung.Azure Cosmos DB Graph engine closely follows Apache TinkerPop traversal steps specification but there are differences in the implementation that are specific for Azure Cosmos DB. Dieser Artikel enthält eine kurze exemplarische Vorgehensweise zu Gremlin und listet die Funktionen von Gremlin auf, die von der Gremlin-API unterstützt werden.In this article, we provide a quick walkthrough of Gremlin and enumerate the Gremlin features that are supported by the Gremlin API.

Kompatible ClientbibliothekenCompatible client libraries

In der folgenden Tabelle werden gängige Gremlin-Treiber aufgeführt, die Sie für Azure Cosmos DB verwenden können:The following table shows popular Gremlin drivers that you can use against Azure Cosmos DB:

Unterstützte Graph-ObjekteSupported Graph Objects

TinkerPop ist ein Standard, der eine große Bandbreite an Diagrammtechnologien abdeckt.TinkerPop is a standard that covers a wide range of graph technologies. Daher weist diese Standardterminologie auf, die beschreiben, welche Funktionen von einem Diagrammanbieter bereitgestellt werden.Therefore, it has standard terminology to describe what features are provided by a graph provider. Azure Cosmos DB stellt eine beständige und beschreibbare Diagrammdatenbank mit hoher Parallelität dar, die über mehrere Server oder Cluster hinweg partitioniert werden kann.Azure Cosmos DB provides a persistent, high concurrency, writeable graph database that can be partitioned across multiple servers or clusters.

Die folgende Tabelle enthält die TinkerPop-Funktionen, die von Azure Cosmos DB implementiert werden:The following table lists the TinkerPop features that are implemented by Azure Cosmos DB:

Gremlin-SendeformatGremlin wire format

Azure Cosmos DB verwendet bei der Rückgabe von Ergebnissen aus Gremlin-Vorgängen das JSON-Format.Azure Cosmos DB uses the JSON format when returning results from Gremlin operations. Von Azure Cosmos DB wird aktuell das JSON-Format unterstützt.Azure Cosmos DB currently supports the JSON format. Der folgende Ausschnitt zeigt beispielsweise eine JSON-Darstellung eines Vertex, der von Azure Cosmos DB an den Client zurückgegeben wurde:For example, the following snippet shows a JSON representation of a vertex returned to the client from Azure Cosmos DB:

  {
    "id": "a7111ba7-0ea1-43c9-b6b2-efc5e3aea4c0",
    "label": "person",
    "type": "vertex",
    "outE": {
      "knows": [
        {
          "id": "3ee53a60-c561-4c5e-9a9f-9c7924bc9aef",
          "inV": "04779300-1c8e-489d-9493-50fd1325a658"
        },
        {
          "id": "21984248-ee9e-43a8-a7f6-30642bc14609",
          "inV": "a8e3e741-2ef7-4c01-b7c8-199f8e43e3bc"
        }
      ]
    },
    "properties": {
      "firstName": [
        {
          "value": "Thomas"
        }
      ],
      "lastName": [
        {
          "value": "Andersen"
        }
      ],
      "age": [
        {
          "value": 45
        }
      ]
    }
  }

Im Anschluss werden die Eigenschaften beschrieben, die im JSON-Format für Vertices verwendet werden:The properties used by the JSON format for vertices are described below:

Zudem enthalten Edges folgende Informationen, die die Navigation in anderen Teilen des Diagramms unterstützen können.And the edge contains the following information to help with navigation to other parts of the graph.

Jede Eigenschaft kann mehrere Werte in einem Array speichern.Each property can store multiple values within an array.

Gremlin-SchritteGremlin steps

Sehen wir uns nun die Gremlin-Schritte an, die von Azure Cosmos DB unterstützt werden.Now let's look at the Gremlin steps supported by Azure Cosmos DB. Eine vollständige Referenz zu Gremlin finden Sie in der TinkerPop-Referenz.For a complete reference on Gremlin, see TinkerPop reference.

Die von Azure Cosmos DB bereitgestellte, für Schreibvorgänge optimierte Engine unterstützt standardmäßig die automatische Indizierung aller Eigenschaften in Vertices und Edges.The write-optimized engine provided by Azure Cosmos DB supports automatic indexing of all properties within vertices and edges by default. Daher werden Abfragen mit Filtern, Bereichsabfragen, Sortierungen oder Aggregate von Eigenschaften über den Index verarbeitet und effizient übermittelt.Therefore, queries with filters, range queries, sorting, or aggregates on any property are processed from the index, and served efficiently. Weitere Informationen zur Indizierung in Azure Cosmos DB finden Sie in unserem Dokument unter Schemagnostische Indizierung.For more information on how indexing works in Azure Cosmos DB, see our paper on schema-agnostic indexing.

Unterschiede im VerhaltenBehavior differences

• Die Azure Cosmos DB Graph-Engine führt einen Durchlauf mit breitem Ansatz aus, während TinkerPop Gremlin einen „tiefen“ Ansatz verfolgt.Azure Cosmos DB Graph engine runs breadth-first traversal while TinkerPop Gremlin is depth-first. Dieses Verhalten erzielt eine bessere Leistung in einem horizontal skalierbaren System wie Cosmos DB.This behavior achieves better performance in horizontally scalable system like Cosmos DB.

Nicht unterstützte FunktionenUnsupported features

• Gremlin Bytecode ist eine von der Programmiersprache unabhängige Spezifikation für Diagrammdurchläufe.Gremlin Bytecode is a programming language agnostic specification for graph traversals. Cosmos DB Graph unterstützt dies noch nicht.Cosmos DB Graph doesn't support it yet. Verwenden Sie GremlinClient.SubmitAsync(), und übergeben Sie den Durchlauf als eine Textzeichenfolge.Use GremlinClient.SubmitAsync() and pass traversal as a text string.

• property(set, 'xyz', 1): Das Festlegen der Kardinalität wird noch nicht unterstützt.property(set, 'xyz', 1) set cardinality isn't supported today. Verwenden Sie stattdessen property(list, 'xyz', 1).Use property(list, 'xyz', 1) instead. Weitere Informationen finden Sie unter Vertex-Eigenschaften mit TinkerPop.To learn more, see Vertex properties with TinkerPop.

• Der Schritt match() ist derzeit nicht verfügbar.The match() step isn't currently available. Dieser Schritt bietet deklarative Abfragefunktionen.This step provides declarative querying capabilities.

• Objekte als Eigenschaften werden für Vertices und Edges nicht unterstützt.Objects as properties on vertices or edges aren't supported. Eigenschaften können nur primitive Typen oder Arrays sein.Properties can only be primitive types or arrays.

• Sortieren nach Arrayeigenschaften order().by(<array property>) wird nicht unterstützt.Sorting by array properties order().by(<array property>) isn't supported. Die Sortierung wird nur von primitiven Typen unterstützt.Sorting is supported only by primitive types.

• Nicht primitive JSON-Typen werden nicht unterstützt.Non-primitive JSON types aren't supported. Verwenden Sie die Typen string, number oder true/false.Use string, number, or true/false types. null-Werte werden nicht unterstützt.null values aren't supported.

• Das GraphSONv3-Serialisierungsmodul wird derzeit noch nicht unterstützt.GraphSONv3 serializer isn't currently supported. Verwenden Sie das GraphSONv2-Serialisierungsmodul sowie Reader- und Writerklassen in der Verbindungskonfiguration.Use GraphSONv2 Serializer, Reader, and Writer classes in the connection configuration. Das Format der von der Azure Cosmos DB Gremlin-API zurückgegebenen Ergebnisse ist nicht identisch mit dem GraphSON-Format.The results returned by the Azure Cosmos DB Gremlin API don't have the same format as the GraphSON format.

• Lambdaausdrücke und -funktionen werden derzeit nicht unterstützt.Lambda expressions and functions aren't currently supported. Dies umfasst die Funktionen .map{<expression>}, .by{<expression>} und .filter{<expression>}.This includes the .map{<expression>}, the .by{<expression>}, and the .filter{<expression>} functions. Weitere Informationen und wie Sie sie mithilfe der Gremlin-Schritte neu schreiben können, finden Sie unter A Note on Lambdas (Hinweis zu Lambdas).To learn more, and to learn how to rewrite them using Gremlin steps, see A Note on Lambdas.

• Transaktionen werden aufgrund der verteilten Natur des Systems nicht unterstützt.Transactions aren't supported because of distributed nature of the system. Konfigurieren Sie ein geeignetes Konsistenzmodell für das Gremlin-Konto, um „Ihre eigenen Schreibvorgänge zu lesen“, und verwenden Sie optimistische Nebenläufigkeit, um Schreibvorgänge aufzulösen, zu einen Konflikt verursachen.Configure appropriate consistency model on Gremlin account to "read your own writes" and use optimistic concurrency to resolve conflicting writes.

Bekannte EinschränkungenKnown limitations

• Indexverwendung für Gremlin-Abfragen mit Schritten vom Typ .V() während des Durchlaufs: Aktuell wird nur beim ersten .V()-Aufruf eines Durchlaufs der Index genutzt, um alle angefügten Filter oder Prädikate aufzulösen.Index utilization for Gremlin queries with mid-traversal .V() steps: Currently, only the first .V() call of a traversal will make use of the index to resolve any filters or predicates attached to it. Bei späteren Aufrufen wird der Index nicht herangezogen, wodurch sich die Wartezeit und die Kosten der Abfrage erhöhen können.Subsequent calls will not consult the index, which might increase the latency and cost of the query.

Bei Verwendung der Standardindizierung werden von einer typischen Gremlin-Leseabfrage, die mit dem Schritt .V() beginnt, Parameter wie .has() oder .where() in den angefügten Filterschritten verwendet, um die Kosten und die Leistung der Abfrage zu optimieren.Assuming default indexing, a typical read Gremlin query that starts with the .V() step would use parameters in its attached filtering steps, such as .has() or .where() to optimize the cost and performance of the query. Beispiel:For example:

g.V().has('category', 'A')

Enthält die Gremlin-Abfrage allerdings mehrere Schritte vom Typ .V(), ist die Auflösung der Daten für die Abfrage möglicherweise nicht optimal.However, when more than one .V() step is included in the Gremlin query, the resolution of the data for the query might not be optimal. Ein Beispiel hierfür wäre etwa die folgende Abfrage:Take the following query as an example:

g.V().has('category', 'A').as('a').V().has('category', 'B').as('b').select('a', 'b')

Diese Abfrage gibt auf der Grundlage der Eigenschaft category zwei Gruppen von Vertices zurück.This query will return two groups of vertices based on their property called category. In diesem Fall wird nur beim ersten Aufruf (g.V().has('category', 'A')) der Index genutzt, um die Vertices auf der Grundlage der Werte ihrer Eigenschaften aufzulösen.In this case, only the first call, g.V().has('category', 'A') will make use of the index to resolve the vertices based on the values of their properties.

Zur Umgehung dieses Problems können bei dieser Abfrage untergeordnete Durchlaufschritte wie .map() und union() verwendet werden.A workaround for this query is to use subtraversal steps such as .map() and union(). Beispiel:This is exemplified below:

// Query workaround using .map()
g.V().has('category', 'A').as('a').map(__.V().has('category', 'B')).as('b').select('a','b')

// Query workaround using .union()
g.V().has('category', 'A').fold().union(unfold(), __.V().has('category', 'B'))

Die Leistung der Abfragen kann mithilfe des GremlinexecutionProfile()-Schritts überprüft werden.You can review the performance of the queries by using the Gremlin executionProfile() step.

Nächste SchritteNext steps

• Erste Schritte zum Erstellen einer Diagrammanwendung mithilfe unserer SDKsGet started building a graph application using our SDKs
• Informieren Sie sich ausführlicher über die Diagrammunterstützung in Azure Cosmos DB.Learn more about graph support in Azure Cosmos DB