Snabbstart: Azure Cosmos DB för Apache Gremlin-klientbibliotek för Node.js

2025-07-22
Gäller för: ✅ Apache Gremlin

Viktigt!

Letar du efter en databaslösning för storskaliga scenarier med ett serviceavtal på 99,999% tillgänglighetsnivå (SLA), snabb autoskalning och automatisk redundans i flera regioner? Överväg Azure Cosmos DB för NoSQL.

Vill du implementera ett OLAP-diagram (Online Analytical Processing) eller migrera ett befintligt Apache Gremlin-program? Överväg Graph i Microsoft Fabric.

Kom igång med Azure Cosmos DB för Apache Gremlin-klientbiblioteket för Node.js för att lagra, hantera och fråga ostrukturerade data. Följ stegen i den här guiden för att skapa ett nytt konto, installera ett Node.js klientbibliotek, ansluta till kontot, utföra vanliga åtgärder och köra frågor mot dina slutliga exempeldata.

Paket för bibliotekskällans källkod | (npm)

Förutsättningar

En prenumeration på Azure
- Om du inte har en Azure-prenumeration, skapa ett gratis konto innan du börjar.

Den senaste versionen av Azure CLI i Azure Cloud Shell.
- Om du föredrar att köra CLI-referenskommandon lokalt loggar du in på Azure CLI med hjälp az login av kommandot .

Node.js 22 eller senare

Konfigurera

Konfigurera först konto- och utvecklingsmiljön för den här guiden. Det här avsnittet beskriver hur du skapar ett konto, hämtar dess autentiseringsuppgifter och sedan förbereder utvecklingsmiljön.

Skapa ett konto

Börja med att skapa ett API för Apache Gremlin-konto. När kontot har skapats skapar du databas- och grafresurserna.

Azure CLI
Azure Portal

Om du inte redan har en målresursgrupp använder du az group create kommandot för att skapa en ny resursgrupp i din prenumeration.
```
az group create \
    --name "<resource-group-name>" \
    --location "<location>"
```

az cosmosdb create Använd kommandot för att skapa ett nytt Azure Cosmos DB för Apache Gremlin-konto med standardinställningar.

az cosmosdb create \
    --resource-group "<resource-group-name>" \
    --name "<account-name>" \
    --locations "regionName=<location>" \
    --capabilities "EnableGremlin"

Skapa en ny databas med namnet az cosmosdb gremlin database createcosmicworks.

az cosmosdb gremlin database create \
    --resource-group "<resource-group-name>" \
    --account-name "<account-name>" \
    --name "cosmicworks"

az cosmosdb gremlin graph create Använd kommandot för att skapa ett nytt diagram med namnet products.

az cosmosdb gremlin graph create \
    --resource-group "<resource-group-name>" \
    --account-name "<account-name>" \
    --database-name "cosmicworks" \
    --name "products" \
    --partition-key-path "/category"

Logga in på Azure Portal (https://portal.azure.com).
Ange Azure Cosmos DB i fältet global sökning.
I Tjänster väljer du Azure Cosmos DB.
I fönstret Azure Cosmos DB väljer du Skapa och sedan Azure Cosmos DB för Apache Gremlin på fliken Andra .

I fönstret Grundläggande konfigurerar du följande alternativ och väljer sedan Granska + skapa:

	Värde
Arbetsbelastningstyp	Lärande
Prenumeration	Välj din Azure-prenumeration
Resursgrupp	Skapa en ny resursgrupp eller välj en befintlig resursgrupp
Kontonamn	Ange ett globalt unikt namn
Tillgänglighetszoner	Inaktivera
Läge	Välj en Azure-region som stöds för din prenumeration

Dricks

Du kan lämna alla ospecificerade alternativ till deras standardvärden. Du kan också konfigurera kontot för att begränsa det totala dataflödet till 1 000 enheter för begäranden per sekund (RU/s) eller aktivera den kostnadsfria nivån för att minimera dina kostnader.

I fönstret Granska + skapa väntar du på att verifieringen av ditt konto ska slutföras och väljer sedan Skapa.
Portalen navigerar automatiskt till fönstret Distribution . Vänta tills distributionen har slutförts.
När distributionen är klar väljer du Gå till resurs för att navigera till det nya API:et för Apache Gremlin-kontot.
I resursmenyn väljer du alternativet Datautforskaren .
I Datautforskaren väljer du + Nytt diagram.
I dialogrutan Lägg till diagram konfigurerar du följande alternativ och väljer sedan OK:

Värde

Databas Skapa ny

Databasnamn cosmicworks

Diagramnamn products

Partitionsnyckel /category

Dricks

Du kan lämna alla ospecificerade alternativ till deras standardvärden.

	Värde
Databas	Skapa ny
Databasnamn	`cosmicworks`
Diagramnamn	`products`
Partitionsnyckel	`/category`

Hämta autentiseringsuppgifter

Hämta nu lösenordet för klientbiblioteket som ska användas för att skapa en anslutning till det nyligen skapade kontot.

Azure CLI
Azure Portal

Använd az cosmosdb show för att hämta värden för kontot.

az cosmosdb show \
    --resource-group "<resource-group-name>" \
    --name "<account-name>" \
    --query "{host:name}"

Registrera värdet för host egenskapen från föregående kommandons utdata. Värdet för den här egenskapen är den värd som du använder senare i den här guiden för att ansluta till kontot med biblioteket.

Använd az cosmosdb keys list för att hämta nycklarna för kontot.

az cosmosdb keys list \
    --resource-group "<resource-group-name>" \
    --name "<account-name>" \
    --type "keys"

Registrera värdet för primaryMasterKey egenskapen från föregående kommandons utdata. Den här egenskapens värde är nyckeln som du använder senare i den här guiden för att ansluta till kontot med biblioteket.

Förbereda utvecklingsmiljön

Konfigurera sedan utvecklingsmiljön med ett nytt projekt och klientbiblioteket. Det här steget är det sista nödvändiga kravet innan du går vidare till resten av den här guiden.

Starta i en tom mapp.
Initiera en ny modul.
```
npm init es6 --yes
```
gremlin Installera paketet från Node Package Manager (npm).
```
npm install --save gremlin
```
Skapa filenindex.js .

Starta i en tom mapp.
Initiera en ny modul.
```
npm init es6 --yes
```
typescript Installera paketet från Node Package Manager (npm).
```
npm install --save-dev typescript
```
tsx Installera paketet från npm.
```
npm install --save-dev tsx
```
gremlin Installera paketet från npm.
```
npm install --save gremlin
```
@types/node Installera paketet från npm.
```
npm install --save-dev @types/node
```
@types/gremlin Installera paketet från npm.
```
npm install --save-dev @types/gremlin
```

Initiera TypeScript-projektet med hjälp av kompilatorn (tsc).

npx tsc --init --target es2017 --module es2022 --moduleResolution nodenext

Skapa filen index.ts .

Objektmodell

	Beskrivning
`DriverRemoteConnection`	Representerar anslutningen till Gremlin-servern
`GraphTraversalSource`	Används för att konstruera och köra Gremlin-traverseringar

Autentisera klient

Börja med att autentisera klienten med de autentiseringsuppgifter som samlats in tidigare i den här guiden.

Öppna filenindex.js i din integrerade utvecklingsmiljö (IDE).

Importera paketet gremlin och nödvändiga typer:

import gremlin from 'gremlin';
const { Client, auth } = gremlin.driver;
const { PlainTextSaslAuthenticator } = auth;

Skapa strängvariabler för de autentiseringsuppgifter som samlats in tidigare i den här guiden. Namnge variablerna hostname och primaryKey.
```
const hostname = '<host>';
const primaryKey = '<key>';
```
Skapa ett objekt av typen PlainTextSaslAuthenticator med hjälp av de autentiseringsuppgifter och konfigurationsvariabler som skapades i föregående steg. Lagra objektet i en variabel med namnet authenticator.
```
const authenticator = new PlainTextSaslAuthenticator(
    '/dbs/cosmicworks/colls/products',
    primaryKey
);
```

Skapa ett Client objekt med variabeln authenticator. Ge variabeln namnet client.

const client = new Client(
    `wss://${hostname}.gremlin.cosmos.azure.com:443/`,
    {
        authenticator,
        traversalsource: 'g',
        rejectUnauthorized: true,
        mimeType: 'application/vnd.gremlin-v2.0+json'
    }
);

Öppna filen index.ts i din integrerade utvecklingsmiljö (IDE).

Importera paketet gremlin och nödvändiga typer:

import gremlin from 'gremlin';
const { Client, auth } = gremlin.driver;
const { PlainTextSaslAuthenticator } = auth;

Skapa strängvariabler för de autentiseringsuppgifter som samlats in tidigare i den här guiden. Namnge variablerna hostname och primaryKey.
```
const hostname: string = '<host>';
const primaryKey: string = '<key>';
```
Skapa ett objekt av typen PlainTextSaslAuthenticator med hjälp av de autentiseringsuppgifter och konfigurationsvariabler som skapades i föregående steg. Lagra objektet i en variabel med namnet authenticator.
```
const authenticator = new PlainTextSaslAuthenticator(
    '/dbs/cosmicworks/colls/products',
    primaryKey
);
```

Skapa ett Client objekt med variabeln authenticator. Ge variabeln namnet client.

const client = new Client(
    `wss://${hostname}.gremlin.cosmos.azure.com:443/`,
    {
        authenticator,
        traversalsource: 'g',
        rejectUnauthorized: true,
        mimeType: 'application/vnd.gremlin-v2.0+json'
    }
);

Infoga data

Infoga sedan nya hörn- och kantdata i diagrammet. Innan du skapar nya data rensar du grafen över befintliga data.

Kör frågan g.V().drop() för att rensa alla hörn och kanter från diagrammet.
```
await client.submit('g.V().drop()');
```

Skapa en Gremlin-fråga som lägger till en nod.

const insert_vertex_query = `
    g.addV('product')
        .property('id', prop_id)
        .property('name', prop_name)
        .property('category', prop_category)
        .property('quantity', prop_quantity)
        .property('price', prop_price)
        .property('clearance', prop_clearance)
`;

Lägg till en nod för en enskild produkt.

await client.submit(insert_vertex_query, {
    prop_id: 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb',
    prop_name: 'Yamba Surfboard',
    prop_category: 'gear-surf-surfboards',
    prop_quantity: 12,
    prop_price: 850.00,
    prop_clearance: false,
});

Lägg till ytterligare två hörn för två extra produkter.

await client.submit(insert_vertex_query, {
    prop_id: 'bbbbbbbb-1111-2222-3333-cccccccccccc',
    prop_name: 'Montau Turtle Surfboard',
    prop_category: 'gear-surf-surfboards',
    prop_quantity: 5,
    prop_price: 600.00,
    prop_clearance: true,
});

await client.submit(insert_vertex_query, {
    prop_id: 'cccccccc-2222-3333-4444-dddddddddddd',
    prop_name: 'Noosa Surfboard',
    prop_category: 'gear-surf-surfboards',
    prop_quantity: 31,
    prop_price: 1100.00,
    prop_clearance: false,
});

Skapa en annan Gremlin-fråga som lägger till en kant.

const insert_edge_query = `
    g.V([prop_partition_key, prop_source_id])
        .addE('replaces')
        .to(g.V([prop_partition_key, prop_target_id]))
`;

Lägg till två kanter.

await client.submit(insert_edge_query, {
    prop_partition_key: 'gear-surf-surfboards',
    prop_source_id: 'bbbbbbbb-1111-2222-3333-cccccccccccc',
    prop_target_id: 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb',
});

await client.submit(insert_edge_query, {
    prop_partition_key: 'gear-surf-surfboards',
    prop_source_id: 'bbbbbbbb-1111-2222-3333-cccccccccccc',
    prop_target_id: 'cccccccc-2222-3333-4444-dddddddddddd',
});

Kör frågan g.V().drop() för att rensa alla hörn och kanter från diagrammet.
```
await client.submit('g.V().drop()');
```

Skapa en Gremlin-fråga som lägger till en nod.

const insert_vertex_query: string = `
    g.addV('product')
        .property('id', prop_id)
        .property('name', prop_name)
        .property('category', prop_category)
        .property('quantity', prop_quantity)
        .property('price', prop_price)
        .property('clearance', prop_clearance)
`;

Lägg till en nod för en enskild produkt.

await client.submit(insert_vertex_query, {
    prop_id: 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb',
    prop_name: 'Yamba Surfboard',
    prop_category: 'gear-surf-surfboards',
    prop_quantity: 12,
    prop_price: 850.00,
    prop_clearance: false,
});

Lägg till ytterligare två hörn för två extra produkter.

await client.submit(insert_vertex_query, {
    prop_id: 'bbbbbbbb-1111-2222-3333-cccccccccccc',
    prop_name: 'Montau Turtle Surfboard',
    prop_category: 'gear-surf-surfboards',
    prop_quantity: 5,
    prop_price: 600.00,
    prop_clearance: true,
});

await client.submit(insert_vertex_query, {
    prop_id: 'cccccccc-2222-3333-4444-dddddddddddd',
    prop_name: 'Noosa Surfboard',
    prop_category: 'gear-surf-surfboards',
    prop_quantity: 31,
    prop_price: 1100.00,
    prop_clearance: false,
});

Skapa en annan Gremlin-fråga som lägger till en kant.

const insert_edge_query: string = `
    g.V([prop_partition_key, prop_source_id])
        .addE('replaces')
        .to(g.V([prop_partition_key, prop_target_id]))
`;

Lägg till två kanter.

await client.submit(insert_edge_query, {
    prop_partition_key: 'gear-surf-surfboards',
    prop_source_id: 'bbbbbbbb-1111-2222-3333-cccccccccccc',
    prop_target_id: 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb',
});

await client.submit(insert_edge_query, {
    prop_partition_key: 'gear-surf-surfboards',
    prop_source_id: 'bbbbbbbb-1111-2222-3333-cccccccccccc',
    prop_target_id: 'cccccccc-2222-3333-4444-dddddddddddd',
});

Läs data

Läs sedan data som tidigare infogats i diagrammet.

Skapa en fråga som läser ett hörn med hjälp av det unika identifierar- och partitionsnyckelvärdet.
```
const read_vertex_query = 'g.V([prop_partition_key, prop_id])';
```

Läs sedan en nod genom att ange de nödvändiga parametrarna.

let read_results = await client.submit(read_vertex_query, {
    prop_partition_key: 'gear-surf-surfboards',
    prop_id: 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb',
});

let matched_item = read_results._items[0];

Skapa en fråga som läser ett hörn med hjälp av det unika identifierar- och partitionsnyckelvärdet.
```
const read_vertex_query: string = 'g.V([prop_partition_key, prop_id])';
```

Läs sedan en nod genom att ange de nödvändiga parametrarna.

let read_results = await client.submit(read_vertex_query, {
    prop_partition_key: 'gear-surf-surfboards',
    prop_id: 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb',
});

let matched_item = read_results._items[0];

Fråga efter data

Slutligen använder du en fråga för att hitta alla data som matchar en specifik bläddering eller filter i diagrammet.

Skapa en fråga som hittar alla hörn som passerar ut från ett specifikt hörn.

const find_vertices_query = `
    g.V().hasLabel('product')
        .has('category', prop_partition_key)
        .has('name', prop_name)
        .outE('replaces').inV()
`;

Kör frågan och ange Montau Turtle Surfboard produkten.

let find_results = await client.submit(find_vertices_query, {
    prop_partition_key: 'gear-surf-surfboards',
    prop_name: 'Montau Turtle Surfboard',
});

Iterera över frågeresultatet.

for (const item of find_results._items) {
    // Do something here with each result
}

Skapa en fråga som hittar alla hörn som passerar ut från ett specifikt hörn.

const find_vertices_query: string = `
    g.V().hasLabel('product')
        .has('category', prop_partition_key)
        .has('name', prop_name)
        .outE('replaces').inV()
`;

Kör frågan och ange Montau Turtle Surfboard produkten.

let find_results = await client.submit(find_vertices_query, {
    prop_partition_key: 'gear-surf-surfboards',
    prop_name: 'Montau Turtle Surfboard',
});

Iterera över frågeresultatet.

for (const item of find_results._items) {
    // Do something here with each result
}

Kör koden

Kör det nyligen skapade programmet med hjälp av en terminal i programkatalogen.

node index.js

npx tsx index.ts

Rensa resurser

När du inte längre behöver kontot tar du bort kontot från din Azure-prenumeration genom att ta bort resursen.

Azure CLI
Azure Portal

az cosmosdb delete \
    --resource-group "<resource-group-name>" \
    --name "<account-name>"

Feedback

Var den här sidan till hjälp?