Dela via

Stöd och kompatibilitet för Azure Cosmos DB for Gremlin-grafer med TinkerPop-funktioner

  • Artikel

GÄLLER FÖR: Gremlin

Azure Cosmos DB stöder Apache Tinkerpops grafblädderingsspråk , som kallas Gremlin. Du kan använda Gremlin-språket för att skapa diagramentiteter (brytpunkter och kanter), ändra egenskaper inom de entiteterna, utföra frågor och bläddringar samt ta bort entiteter.

Azure Cosmos DB Graph-motorn följer noga specifikationen för Apache TinkerPop-bläddrande steg, men det finns skillnader i implementeringen som är specifika för Azure Cosmos DB. I den här artikeln ger vi en snabb genomgång av Gremlin och räknar upp De Gremlin-funktioner som stöds av API:et för Gremlin.

Kompatibla klientbibliotek

Följande tabell visar populära Gremlin-drivrutiner som du kan använda mot Azure Cosmos DB:

Ladda ned Källa Komma igång Version av anslutningsprogram som stöds/rekommenderas
.NET Gremlin.NET på GitHub Skapa diagram med .NET 3.4.13
Java Gremlin JavaDoc Skapa diagram med Java 3.4.13
Python Gremlin-Python på GitHub Skapa diagram med Python 3.4.13
Gremlin-konsol TinkerPop-dokument Skapa diagram med Gremlin-konsolen 3.4.13
Node.js Gremlin-JavaScript på GitHub Skapa diagram med Node.js 3.4.13
PHP Gremlin-PHP på GitHub Skapa diagram med PHP 3.1.0
Go Lang Go Lang Det här biblioteket skapas av externa deltagare. Azure Cosmos DB-teamet erbjuder inte någon support eller underhåll av biblioteket.

Kommentar

Gremlin-klientdrivrutinsversioner för 3.5.*, 3.6.* har kända kompatibilitetsproblem, så vi rekommenderar att du använder de senaste 3.4.* drivrutinsversionerna som stöds ovan. Den här tabellen uppdateras när kompatibilitetsproblem har åtgärdats för dessa nyare drivrutinsversioner.

Diagramobjekt som stöds

TinkerPop är en standard som omfattar en mängd olika diagramtekniker. Därför har den standardterminologi som beskriver vilka funktioner som tillhandahålls av en diagramprovider. Azure Cosmos DB tillhandahåller en beständig, skrivbar diagramdatabas med hög samtidighet som kan partitioneras över flera servrar eller kluster.

Följande tabell visar den TinkerPop-funktioner som implementeras av Azure Cosmos DB:

Kategori Azure Cosmos DB-implementering Kommentar
Diagramfunktioner Ger beständighet och ConcurrentAccess. Designad att stödja transaktioner Datormetoder kan implementeras via Spark-anslutningsappen.
Variabla funktioner Stöder boolesk, heltal, byte, dubbel, flyttal, lång, sträng Har stöd för primitiva typer, är kompatibel med komplexa typer via datamodellen
Brytpunktsfunktioner Stöder RemoveVertices, MetaProperties, AddVertices, MultiProperties, StringIds, UserSuppliedIds, AddProperty, RemoveProperty Stöder att skapa, ändra och ta bort brytpunkter
Funktioner för brytpunktsegenskapen StringIds, UserSuppliedIds, AddProperty, RemoveProperty, BooleanValues, ByteValues, DoubleValues, FloatValues, IntegerValues, LongValues, StringValues Stöder att skapa, ändra och ta bort brytpunktsegenskaper
Kantfunktioner AddEdges, RemoveEdges, StringIds, UserSuppliedIds, AddProperty, RemoveProperty Stöder att skapa, ändra och ta bort kanter
Kantegenskapsfunktioner Properties, BooleanValues, ByteValues, DoubleValues, FloatValues, IntegerValues, LongValues, StringValues Stöder att skapa, ändra och ta bort kantegenskaper

Gremlin-trådformat

Azure Cosmos DB använder JSON-formatet när resultat från Gremlin-åtgärder returneras. Azure Cosmos DB stöder för närvarande JSON-formatet. Följande kodfragment visar till exempel en JSON-representation av ett hörn som returneras till klienten från 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
        }
      ]
    }
  }

Egenskaperna som används av JSON-formatet för hörn beskrivs nedan:

Property beskrivning
id ID för brytpunkten. Måste vara unikt (i kombination med värdet _partition för om tillämpligt). Om inget värde anges levereras det automatiskt med ett GUID
label Etiketten för brytpunkten. Den här egenskapen används för att beskriva entitetstypen.
type Används för att särskilja brytpunkter från icke-diagramdokument
properties En uppsättning användardefinierade egenskaper associerade med brytpunkten. Varje egenskap kan ha flera värden.
_partition Partitionsnyckeln för brytpunkten. Används för grafpartitionering.
outE Den här egenskapen innehåller en lista över utkanter från ett hörn. Lagring av angränsande information med brytpunkter för snabbare körning av bläddring. Kanter grupperas baserat på deras etiketter.

Varje egenskap kan lagra flera värden inom en matris.

Property beskrivning
value Värdet på egenskapen

Och kanten innehåller följande information för att underlätta navigeringen till andra delar av diagrammet.

Property beskrivning
id ID för kanten. Måste vara unikt (i kombination med värdet _partition för om tillämpligt)
label Etiketten för kanten. Den här egenskapen är valfri och används för att beskriva relationstypen.
inV Den här egenskapen innehåller en lista över i hörn för en kant. Lagring av angränsningsinformation med kanter tillåter snabb körning av bläddringar. Brytpunkter grupperas baserat på deras etiketter.
properties En uppsättning användardefinierade egenskaper associerade med kanten.

Gremlin-steg

Nu ska vi titta på de Gremlin-steg som stöds av Azure Cosmos DB. En fullständig referens om Gremlin finns i TinkerPop-referens.

step beskrivning TinkerPop 3.2-dokumentation
addE Lägger till en kant mellan två brytpunkter addE step
addV Lägger till en brytpunkt i diagrammet addV step
and Ser till att alla bläddringar returnerar ett värde and step
as Ett stegmodulator för att tilldela en variabel till utdata från ett steg as step
by En stegmodulator som används med group och order by step
coalesce Returnerar den första bläddringen som returnerar ett resultat coalesce step
constant Returnerar ett konstant värde. Används med coalesce constant step
count Returnerar antalet från bläddringen count step
dedup Returnerar värden med borttagna dubbletter dedup step
drop Släpper värdena (brytpunkt/kant) drop step
executionProfile Skapar en beskrivning av alla åtgärder som genereras av det utförda Gremlin-steget executionProfile-steg
fold Fungerar som en barriär som beräknar sammanställningen av resultat fold step
group Grupperar värdena baserat på de angivna etiketterna group step
has Används för att filtrera egenskaper, brytpunkter och kanter. Stöder varianterna hasLabel, hasId, hasNot och has. has step
inject Matar in värden i en dataström inject step
is Används för att utföra ett filter med ett booleskt uttryck is step
limit Används för att begränsa antalet objekt i bläddringen limit step
local Bäddar in ett avsnitt av en bläddring lokalt, liknar en underfråga local step
not Används för att skapa negationer av ett filter not step
optional Returnerar resultatet av den angivna bläddringen om den ger upphov till ett resultat, annars returneras det anropande elementet optional step
or Garanterar att minst en av bläddringarna returnerar ett värde or step
order Returnerar resultat i den angivna sorteringsordningen order step
path Returnerar den fullständiga sökvägen för bläddringen path step
project Projicerar egenskaperna som en karta project step
properties Returnerar egenskaperna för de angivna etiketterna properties step
range Filtrerar till det angivna intervallet med värden range step
repeat Upprepar steget för det angivna antalet gånger. Används för upprepning repeat step
sample Används för exempelresultat för bläddringen sample step
select Används för att projicera resultat från bläddringen select step
store Används för icke-blockerande sammanställningar från bläddringen store step
TextP.startingWith(string) Strängfiltreringsfunktion. Den här funktionen används som predikat för steget för has() att matcha en egenskap med början av en viss sträng TextP-predikat
TextP.endingWith(string) Strängfiltreringsfunktion. Den här funktionen används som predikat för steget för has() att matcha en egenskap med slutet av en viss sträng TextP-predikat
TextP.containing(string) Strängfiltreringsfunktion. Den här funktionen används som predikat för steget för has() att matcha en egenskap med innehållet i en viss sträng TextP-predikat
TextP.notStartingWith(string) Strängfiltreringsfunktion. Den här funktionen används som predikat för steget för has() att matcha en egenskap som inte börjar med en viss sträng TextP-predikat
TextP.notEndingWith(string) Strängfiltreringsfunktion. Den här funktionen används som predikat för steget för has() att matcha en egenskap som inte slutar med en viss sträng TextP-predikat
TextP.notContaining(string) Strängfiltreringsfunktion. Den här funktionen används som predikat för steget för has() att matcha en egenskap som inte innehåller en viss sträng TextP-predikat
tree Sammanställ sökvägar från en brytpunkt i ett träd tree step
unfold Rulla upp en iterator som ett steg unfold step
union Sammanfoga resultat från flera bläddringar union step
V Inkluderar de steg som krävs för bläddringar mellan brytpunkter och kanter V, E, out, in, both, outE, inE, bothE, outV, inV, bothV och otherV för vertex steps
where Används för att filtrera resultat från bläddringen. Stöder operatorerna eq, neq, lt, lte, gt, gte och between where step

Den skrivoptimerade motorn som tillhandahålls av Azure Cosmos DB stöder automatisk indexering av alla egenskaperna i brytpunkter och kanter som standard. Därför bearbetas frågor med filter, intervallfrågor, sortering eller sammanställning av alla egenskaper från index och hanteras effektivt. Mer information om hur indexering fungerar i Azure Cosmos DV finns i vårt papper om schemaoberoende indexering.

Beteendeskillnader

  • Azure Cosmos DB Graph-motorn kör bredd-första traversering medan TinkerPop Gremlin är djup-först. Det här beteendet ger bättre prestanda i horisontellt skalbara system som Azure Cosmos DB.

Funktioner som inte stöds

  • Gremlin Bytecode är ett datorspråk med oberoende specifikation för diagrambläddringar. Azure Cosmos DB Graph stöder det inte än. Använd GremlinClient.SubmitAsync() och skicka traverseringen som textsträng.

  • property(set, 'xyz', 1) ange kardinalitet stöds inte i dag. Använd property(list, 'xyz', 1) i stället. Mer information finns i Hörnegenskaper med TinkerPop.

  • Steget match() är inte tillgängligt för närvarande. Det här steget innehåller deklarativa frågefunktioner.

  • Objekt som egenskaper på hörn eller kanter stöds inte. Egenskaper kan bara vara primitiva typer eller matriser.

  • Sortering efter matrisegenskaper order().by(<array property>) stöds inte. Sortering stöds endast av primitiva typer.

  • Icke-primitiva JSON-typer stöds inte. Använd string, numbereller true/false typer. null värden stöds inte.

  • GraphSONv3-serialiserare stöds inte för närvarande. Använd GraphSONv2 klasserna Serializer, Reader och Writer i anslutningskonfigurationen. Resultaten som returneras av Azure Cosmos DB för Gremlin har inte samma format som GraphSON-formatet.

  • Lambda-uttryck och -funktioner stöds inte för närvarande. Detta inkluderar .map{<expression>}funktionerna , .by{<expression>}och .filter{<expression>} . Mer information om hur du skriver om dem med Gremlin-steg finns i En anteckning om Lambdas.

  • Transaktioner stöds inte på grund av systemets distribuerade karaktär. Konfigurera lämplig konsekvensmodell för Gremlin-kontot för att "läsa dina egna skrivningar" och använd optimistisk samtidighet för att lösa motstridiga skrivningar.

Kända begränsningar

  • Indexanvändning för Gremlin-frågor med steg i mitten av bläddring.V(): För närvarande används endast det första .V() anropet av en bläddring av indexet för att lösa eventuella filter eller predikat som är kopplade till det. Efterföljande anrop kommer inte att konsultera indexet, vilket kan öka svarstiden och kostnaden för frågan.

Om vi antar standardindexering använder en vanlig Gremlin-fråga som börjar med .V() steget parametrar i de bifogade filtreringsstegen, till exempel .has() eller .where() för att optimera frågans kostnad och prestanda. Till exempel:

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

Men när mer än ett .V() steg ingår i Gremlin-frågan kanske lösningen på data för frågan inte är optimal. Ta följande fråga som exempel:

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

Den här frågan returnerar två grupper med hörn baserat på deras egenskap med namnet category. I det här fallet använder endast det första anropet g.V().has('category', 'A') indexet för att lösa hörnen baserat på värdena för deras egenskaper.

En lösning för den här frågan är att använda subtraversala steg som .map() och union(). Detta exemplifieras nedan:

// 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'))

Du kan granska frågornas prestanda med hjälp av Gremlin-stegetexecutionProfile().

Nästa steg