Quickstart: Azure Cosmos DB for Apache Gremlin library for .NET
APPLIES TO: Gremlin
Azure Cosmos DB for Apache Gremlin is a fully managed graph database service implementing the popular Apache Tinkerpop
, a graph computing framework using the Gremlin query language. The API for Gremlin gives you a low-friction way to get started using Gremlin with a service that can grow and scale out as much as you need with minimal management.
In this quickstart, you use the Gremlin.Net
library to connect to a newly created Azure Cosmos DB for Gremlin account.
Library source code | Package (NuGet)
Prerequisites
- An Azure account with an active subscription.
- No Azure subscription? Sign up for a Azure account.
- .NET (LTS)
- Don't have .NET installed? Try this quickstart in GitHub Codespaces.
- Azure Command-Line Interface (CLI)
Setting up
This section walks you through creating an API for Gremlin account and setting up a .NET project to use the library to connect to the account.
Create an API for Gremlin account
The API for Gremlin account should be created prior to using the .NET library. Additionally, it helps to also have the database and graph in place.
Create shell variables for accountName, resourceGroupName, and location.
# Variable for resource group name resourceGroupName="msdocs-cosmos-gremlin-quickstart" location="westus" # Variable for account name with a randomly generated suffix let suffix=$RANDOM*$RANDOM accountName="msdocs-gremlin-$suffix"
If you haven't already, sign in to the Azure CLI using
az login
.Use
az group create
to create a new resource group in your subscription.az group create \ --name $resourceGroupName \ --location $location
Use
az cosmosdb create
to create a new API for Gremlin account with default settings.az cosmosdb create \ --resource-group $resourceGroupName \ --name $accountName \ --capabilities "EnableGremlin" \ --locations regionName=$location \ --enable-free-tier true
Get the API for Gremlin endpoint NAME for the account using
az cosmosdb show
.az cosmosdb show \ --resource-group $resourceGroupName \ --name $accountName \ --query "name"
Find the KEY from the list of keys for the account with
az-cosmosdb-keys-list
.az cosmosdb keys list \ --resource-group $resourceGroupName \ --name $accountName \ --type "keys" \ --query "primaryMasterKey"
Record the NAME and KEY values. You use these credentials later.
Create a database named
cosmicworks
usingaz cosmosdb gremlin database create
.az cosmosdb gremlin database create \ --resource-group $resourceGroupName \ --account-name $accountName \ --name "cosmicworks"
Create a graph using
az cosmosdb gremlin graph create
. Name the graphproducts
, then set the throughput to400
, and finally set the partition key path to/category
.az cosmosdb gremlin graph create \ --resource-group $resourceGroupName \ --account-name $accountName \ --database-name "cosmicworks" \ --name "products" \ --partition-key-path "/category" \ --throughput 400
Create a new .NET console application
Create a .NET console application in an empty folder using your preferred terminal.
Open your terminal in an empty folder.
Use the
dotnet new
command specifying the console template.dotnet new console
Install the NuGet package
Add the Gremlin.NET
NuGet package to the .NET project.
Use the
dotnet add package
command specifying theGremlin.Net
NuGet package.dotnet add package Gremlin.Net
Build the .NET project using
dotnet build
.dotnet build
Make sure that the build was successful with no errors. The expected output from the build should look something like this:
Determining projects to restore... All projects are up-to-date for restore. dslkajfjlksd -> \dslkajfjlksd\bin\Debug\net6.0\dslkajfjlksd.dll Build succeeded. 0 Warning(s) 0 Error(s)
Configure environment variables
To use the NAME and URI values obtained earlier in this quickstart, persist them to new environment variables on the local machine running the application.
To set the environment variable, use your terminal to persist the values as
COSMOS_ENDPOINT
andCOSMOS_KEY
respectively.export COSMOS_GREMLIN_ENDPOINT="<account-name>" export COSMOS_GREMLIN_KEY="<account-key>"
Validate that the environment variables were set correctly.
printenv COSMOS_GREMLIN_ENDPOINT printenv COSMOS_GREMLIN_KEY
Code examples
The code in this article connects to a database named cosmicworks
and a graph named products
. The code then adds vertices and edges to the graph before traversing the added items.
Authenticate the client
Application requests to most Azure services must be authorized. For the API for Gremlin, use the NAME and URI values obtained earlier in this quickstart.
Open the Program.cs file.
Delete any existing content within the file.
Add a using block for the
Gremlin.Net.Driver
namespace.
// <imports>
using Gremlin.Net.Driver;
// </imports>
// <environment_variables>
string accountName = Environment.GetEnvironmentVariable("COSMOS_GREMLIN_ENDPOINT")!;
string accountKey = Environment.GetEnvironmentVariable("COSMOS_GREMLIN_KEY")!;
// </environment_variables>
// <authenticate_client>
var server = new GremlinServer(
hostname: $"{accountName}.gremlin.cosmos.azure.cn",
port: 443,
username: "/dbs/cosmicworks/colls/products",
password: $"{accountKey}",
enableSsl: true
);
// </authenticate_client>
// <connect_client>
using var client = new GremlinClient(
gremlinServer: server,
messageSerializer: new Gremlin.Net.Structure.IO.GraphSON.GraphSON2MessageSerializer()
);
// </connect_client>
// <drop_graph>
await client.SubmitAsync(
requestScript: "g.V().drop()"
);
// </drop_graph>
// <create_vertices_1>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518371').property('name', 'Kiama classic surfboard').property('price', 285.55).property('category', 'surfboards')"
);
// </create_vertices_1>
// <create_vertices_2>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518403').property('name', 'Montau Turtle Surfboard').property('price', 600.00).property('category', 'surfboards')"
);
// </create_vertices_2>
// <create_vertices_3>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518409').property('name', 'Bondi Twin Surfboard').property('price', 585.50).property('category', 'surfboards')"
);
// </create_vertices_3>
// <create_edges_1>
await client.SubmitAsync(
requestScript: "g.V(['surfboards', '68719518403']).addE('replaces').to(g.V(['surfboards', '68719518371']))"
);
// </create_edges_1>
// <create_edges_2>
await client.SubmitAsync(
requestScript: "g.V(['surfboards', '68719518403']).addE('replaces').to(g.V(['surfboards', '68719518409']))"
);
// </create_edges_2>
// <query_vertices_edges>
var results = await client.SubmitAsync<Dictionary<string, object>>(
requestScript: "g.V().hasLabel('product').has('category', 'surfboards').has('name', 'Montau Turtle Surfboard').outE('replaces').inV()"
);
// </query_vertices_edges>
// <output_vertices_edges>
Console.WriteLine($"[CREATED PRODUCT]\t68719518403");
foreach (var result in results ?? Enumerable.Empty<Dictionary<string, object>>())
{
Console.WriteLine($"[REPLACES PRODUCT]\t{result["id"]}");
}
// </output_vertices_edges>
- Create
accountName
andaccountKey
string variables. Store theCOSMOS_GREMLIN_ENDPOINT
andCOSMOS_GREMLIN_KEY
environment variables as the values for each respective variable.
// <imports>
using Gremlin.Net.Driver;
// </imports>
// <environment_variables>
string accountName = Environment.GetEnvironmentVariable("COSMOS_GREMLIN_ENDPOINT")!;
string accountKey = Environment.GetEnvironmentVariable("COSMOS_GREMLIN_KEY")!;
// </environment_variables>
// <authenticate_client>
var server = new GremlinServer(
hostname: $"{accountName}.gremlin.cosmos.azure.cn",
port: 443,
username: "/dbs/cosmicworks/colls/products",
password: $"{accountKey}",
enableSsl: true
);
// </authenticate_client>
// <connect_client>
using var client = new GremlinClient(
gremlinServer: server,
messageSerializer: new Gremlin.Net.Structure.IO.GraphSON.GraphSON2MessageSerializer()
);
// </connect_client>
// <drop_graph>
await client.SubmitAsync(
requestScript: "g.V().drop()"
);
// </drop_graph>
// <create_vertices_1>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518371').property('name', 'Kiama classic surfboard').property('price', 285.55).property('category', 'surfboards')"
);
// </create_vertices_1>
// <create_vertices_2>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518403').property('name', 'Montau Turtle Surfboard').property('price', 600.00).property('category', 'surfboards')"
);
// </create_vertices_2>
// <create_vertices_3>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518409').property('name', 'Bondi Twin Surfboard').property('price', 585.50).property('category', 'surfboards')"
);
// </create_vertices_3>
// <create_edges_1>
await client.SubmitAsync(
requestScript: "g.V(['surfboards', '68719518403']).addE('replaces').to(g.V(['surfboards', '68719518371']))"
);
// </create_edges_1>
// <create_edges_2>
await client.SubmitAsync(
requestScript: "g.V(['surfboards', '68719518403']).addE('replaces').to(g.V(['surfboards', '68719518409']))"
);
// </create_edges_2>
// <query_vertices_edges>
var results = await client.SubmitAsync<Dictionary<string, object>>(
requestScript: "g.V().hasLabel('product').has('category', 'surfboards').has('name', 'Montau Turtle Surfboard').outE('replaces').inV()"
);
// </query_vertices_edges>
// <output_vertices_edges>
Console.WriteLine($"[CREATED PRODUCT]\t68719518403");
foreach (var result in results ?? Enumerable.Empty<Dictionary<string, object>>())
{
Console.WriteLine($"[REPLACES PRODUCT]\t{result["id"]}");
}
// </output_vertices_edges>
- Create a new instance of
GremlinServer
using the account's credentials.
// <imports>
using Gremlin.Net.Driver;
// </imports>
// <environment_variables>
string accountName = Environment.GetEnvironmentVariable("COSMOS_GREMLIN_ENDPOINT")!;
string accountKey = Environment.GetEnvironmentVariable("COSMOS_GREMLIN_KEY")!;
// </environment_variables>
// <authenticate_client>
var server = new GremlinServer(
hostname: $"{accountName}.gremlin.cosmos.azure.cn",
port: 443,
username: "/dbs/cosmicworks/colls/products",
password: $"{accountKey}",
enableSsl: true
);
// </authenticate_client>
// <connect_client>
using var client = new GremlinClient(
gremlinServer: server,
messageSerializer: new Gremlin.Net.Structure.IO.GraphSON.GraphSON2MessageSerializer()
);
// </connect_client>
// <drop_graph>
await client.SubmitAsync(
requestScript: "g.V().drop()"
);
// </drop_graph>
// <create_vertices_1>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518371').property('name', 'Kiama classic surfboard').property('price', 285.55).property('category', 'surfboards')"
);
// </create_vertices_1>
// <create_vertices_2>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518403').property('name', 'Montau Turtle Surfboard').property('price', 600.00).property('category', 'surfboards')"
);
// </create_vertices_2>
// <create_vertices_3>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518409').property('name', 'Bondi Twin Surfboard').property('price', 585.50).property('category', 'surfboards')"
);
// </create_vertices_3>
// <create_edges_1>
await client.SubmitAsync(
requestScript: "g.V(['surfboards', '68719518403']).addE('replaces').to(g.V(['surfboards', '68719518371']))"
);
// </create_edges_1>
// <create_edges_2>
await client.SubmitAsync(
requestScript: "g.V(['surfboards', '68719518403']).addE('replaces').to(g.V(['surfboards', '68719518409']))"
);
// </create_edges_2>
// <query_vertices_edges>
var results = await client.SubmitAsync<Dictionary<string, object>>(
requestScript: "g.V().hasLabel('product').has('category', 'surfboards').has('name', 'Montau Turtle Surfboard').outE('replaces').inV()"
);
// </query_vertices_edges>
// <output_vertices_edges>
Console.WriteLine($"[CREATED PRODUCT]\t68719518403");
foreach (var result in results ?? Enumerable.Empty<Dictionary<string, object>>())
{
Console.WriteLine($"[REPLACES PRODUCT]\t{result["id"]}");
}
// </output_vertices_edges>
- Create a new instance of
GremlinClient
using the remote server credentials and the GraphSON 2.0 serializer.
// <imports>
using Gremlin.Net.Driver;
// </imports>
// <environment_variables>
string accountName = Environment.GetEnvironmentVariable("COSMOS_GREMLIN_ENDPOINT")!;
string accountKey = Environment.GetEnvironmentVariable("COSMOS_GREMLIN_KEY")!;
// </environment_variables>
// <authenticate_client>
var server = new GremlinServer(
hostname: $"{accountName}.gremlin.cosmos.azure.cn",
port: 443,
username: "/dbs/cosmicworks/colls/products",
password: $"{accountKey}",
enableSsl: true
);
// </authenticate_client>
// <connect_client>
using var client = new GremlinClient(
gremlinServer: server,
messageSerializer: new Gremlin.Net.Structure.IO.GraphSON.GraphSON2MessageSerializer()
);
// </connect_client>
// <drop_graph>
await client.SubmitAsync(
requestScript: "g.V().drop()"
);
// </drop_graph>
// <create_vertices_1>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518371').property('name', 'Kiama classic surfboard').property('price', 285.55).property('category', 'surfboards')"
);
// </create_vertices_1>
// <create_vertices_2>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518403').property('name', 'Montau Turtle Surfboard').property('price', 600.00).property('category', 'surfboards')"
);
// </create_vertices_2>
// <create_vertices_3>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518409').property('name', 'Bondi Twin Surfboard').property('price', 585.50).property('category', 'surfboards')"
);
// </create_vertices_3>
// <create_edges_1>
await client.SubmitAsync(
requestScript: "g.V(['surfboards', '68719518403']).addE('replaces').to(g.V(['surfboards', '68719518371']))"
);
// </create_edges_1>
// <create_edges_2>
await client.SubmitAsync(
requestScript: "g.V(['surfboards', '68719518403']).addE('replaces').to(g.V(['surfboards', '68719518409']))"
);
// </create_edges_2>
// <query_vertices_edges>
var results = await client.SubmitAsync<Dictionary<string, object>>(
requestScript: "g.V().hasLabel('product').has('category', 'surfboards').has('name', 'Montau Turtle Surfboard').outE('replaces').inV()"
);
// </query_vertices_edges>
// <output_vertices_edges>
Console.WriteLine($"[CREATED PRODUCT]\t68719518403");
foreach (var result in results ?? Enumerable.Empty<Dictionary<string, object>>())
{
Console.WriteLine($"[REPLACES PRODUCT]\t{result["id"]}");
}
// </output_vertices_edges>
Create vertices
Now that the application is connected to the account, use the standard Gremlin syntax to create vertices.
Use
SubmitAsync
to run a command server-side on the API for Gremlin account. Create a product vertex with the following properties:Value label product
id 68719518371
name
Kiama classic surfboard
price
285.55
category
surfboards
// <imports>
using Gremlin.Net.Driver;
// </imports>
// <environment_variables>
string accountName = Environment.GetEnvironmentVariable("COSMOS_GREMLIN_ENDPOINT")!;
string accountKey = Environment.GetEnvironmentVariable("COSMOS_GREMLIN_KEY")!;
// </environment_variables>
// <authenticate_client>
var server = new GremlinServer(
hostname: $"{accountName}.gremlin.cosmos.azure.cn",
port: 443,
username: "/dbs/cosmicworks/colls/products",
password: $"{accountKey}",
enableSsl: true
);
// </authenticate_client>
// <connect_client>
using var client = new GremlinClient(
gremlinServer: server,
messageSerializer: new Gremlin.Net.Structure.IO.GraphSON.GraphSON2MessageSerializer()
);
// </connect_client>
// <drop_graph>
await client.SubmitAsync(
requestScript: "g.V().drop()"
);
// </drop_graph>
// <create_vertices_1>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518371').property('name', 'Kiama classic surfboard').property('price', 285.55).property('category', 'surfboards')"
);
// </create_vertices_1>
// <create_vertices_2>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518403').property('name', 'Montau Turtle Surfboard').property('price', 600.00).property('category', 'surfboards')"
);
// </create_vertices_2>
// <create_vertices_3>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518409').property('name', 'Bondi Twin Surfboard').property('price', 585.50).property('category', 'surfboards')"
);
// </create_vertices_3>
// <create_edges_1>
await client.SubmitAsync(
requestScript: "g.V(['surfboards', '68719518403']).addE('replaces').to(g.V(['surfboards', '68719518371']))"
);
// </create_edges_1>
// <create_edges_2>
await client.SubmitAsync(
requestScript: "g.V(['surfboards', '68719518403']).addE('replaces').to(g.V(['surfboards', '68719518409']))"
);
// </create_edges_2>
// <query_vertices_edges>
var results = await client.SubmitAsync<Dictionary<string, object>>(
requestScript: "g.V().hasLabel('product').has('category', 'surfboards').has('name', 'Montau Turtle Surfboard').outE('replaces').inV()"
);
// </query_vertices_edges>
// <output_vertices_edges>
Console.WriteLine($"[CREATED PRODUCT]\t68719518403");
foreach (var result in results ?? Enumerable.Empty<Dictionary<string, object>>())
{
Console.WriteLine($"[REPLACES PRODUCT]\t{result["id"]}");
}
// </output_vertices_edges>
Create a second product vertex with these properties:
Value label product
id 68719518403
name
Montau Turtle Surfboard
price
600.00
category
surfboards
// <imports>
using Gremlin.Net.Driver;
// </imports>
// <environment_variables>
string accountName = Environment.GetEnvironmentVariable("COSMOS_GREMLIN_ENDPOINT")!;
string accountKey = Environment.GetEnvironmentVariable("COSMOS_GREMLIN_KEY")!;
// </environment_variables>
// <authenticate_client>
var server = new GremlinServer(
hostname: $"{accountName}.gremlin.cosmos.azure.cn",
port: 443,
username: "/dbs/cosmicworks/colls/products",
password: $"{accountKey}",
enableSsl: true
);
// </authenticate_client>
// <connect_client>
using var client = new GremlinClient(
gremlinServer: server,
messageSerializer: new Gremlin.Net.Structure.IO.GraphSON.GraphSON2MessageSerializer()
);
// </connect_client>
// <drop_graph>
await client.SubmitAsync(
requestScript: "g.V().drop()"
);
// </drop_graph>
// <create_vertices_1>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518371').property('name', 'Kiama classic surfboard').property('price', 285.55).property('category', 'surfboards')"
);
// </create_vertices_1>
// <create_vertices_2>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518403').property('name', 'Montau Turtle Surfboard').property('price', 600.00).property('category', 'surfboards')"
);
// </create_vertices_2>
// <create_vertices_3>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518409').property('name', 'Bondi Twin Surfboard').property('price', 585.50).property('category', 'surfboards')"
);
// </create_vertices_3>
// <create_edges_1>
await client.SubmitAsync(
requestScript: "g.V(['surfboards', '68719518403']).addE('replaces').to(g.V(['surfboards', '68719518371']))"
);
// </create_edges_1>
// <create_edges_2>
await client.SubmitAsync(
requestScript: "g.V(['surfboards', '68719518403']).addE('replaces').to(g.V(['surfboards', '68719518409']))"
);
// </create_edges_2>
// <query_vertices_edges>
var results = await client.SubmitAsync<Dictionary<string, object>>(
requestScript: "g.V().hasLabel('product').has('category', 'surfboards').has('name', 'Montau Turtle Surfboard').outE('replaces').inV()"
);
// </query_vertices_edges>
// <output_vertices_edges>
Console.WriteLine($"[CREATED PRODUCT]\t68719518403");
foreach (var result in results ?? Enumerable.Empty<Dictionary<string, object>>())
{
Console.WriteLine($"[REPLACES PRODUCT]\t{result["id"]}");
}
// </output_vertices_edges>
Create a third product vertex with these properties:
Value label product
id 68719518409
name
Bondi Twin Surfboard
price
585.50
category
surfboards
// <imports>
using Gremlin.Net.Driver;
// </imports>
// <environment_variables>
string accountName = Environment.GetEnvironmentVariable("COSMOS_GREMLIN_ENDPOINT")!;
string accountKey = Environment.GetEnvironmentVariable("COSMOS_GREMLIN_KEY")!;
// </environment_variables>
// <authenticate_client>
var server = new GremlinServer(
hostname: $"{accountName}.gremlin.cosmos.azure.cn",
port: 443,
username: "/dbs/cosmicworks/colls/products",
password: $"{accountKey}",
enableSsl: true
);
// </authenticate_client>
// <connect_client>
using var client = new GremlinClient(
gremlinServer: server,
messageSerializer: new Gremlin.Net.Structure.IO.GraphSON.GraphSON2MessageSerializer()
);
// </connect_client>
// <drop_graph>
await client.SubmitAsync(
requestScript: "g.V().drop()"
);
// </drop_graph>
// <create_vertices_1>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518371').property('name', 'Kiama classic surfboard').property('price', 285.55).property('category', 'surfboards')"
);
// </create_vertices_1>
// <create_vertices_2>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518403').property('name', 'Montau Turtle Surfboard').property('price', 600.00).property('category', 'surfboards')"
);
// </create_vertices_2>
// <create_vertices_3>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518409').property('name', 'Bondi Twin Surfboard').property('price', 585.50).property('category', 'surfboards')"
);
// </create_vertices_3>
// <create_edges_1>
await client.SubmitAsync(
requestScript: "g.V(['surfboards', '68719518403']).addE('replaces').to(g.V(['surfboards', '68719518371']))"
);
// </create_edges_1>
// <create_edges_2>
await client.SubmitAsync(
requestScript: "g.V(['surfboards', '68719518403']).addE('replaces').to(g.V(['surfboards', '68719518409']))"
);
// </create_edges_2>
// <query_vertices_edges>
var results = await client.SubmitAsync<Dictionary<string, object>>(
requestScript: "g.V().hasLabel('product').has('category', 'surfboards').has('name', 'Montau Turtle Surfboard').outE('replaces').inV()"
);
// </query_vertices_edges>
// <output_vertices_edges>
Console.WriteLine($"[CREATED PRODUCT]\t68719518403");
foreach (var result in results ?? Enumerable.Empty<Dictionary<string, object>>())
{
Console.WriteLine($"[REPLACES PRODUCT]\t{result["id"]}");
}
// </output_vertices_edges>
Create edges
Create edges using the Gremlin syntax to define relationships between vertices.
- Create an edge from the
Montau Turtle Surfboard
product named replaces to theKiama classic surfboard
product.
// <imports>
using Gremlin.Net.Driver;
// </imports>
// <environment_variables>
string accountName = Environment.GetEnvironmentVariable("COSMOS_GREMLIN_ENDPOINT")!;
string accountKey = Environment.GetEnvironmentVariable("COSMOS_GREMLIN_KEY")!;
// </environment_variables>
// <authenticate_client>
var server = new GremlinServer(
hostname: $"{accountName}.gremlin.cosmos.azure.cn",
port: 443,
username: "/dbs/cosmicworks/colls/products",
password: $"{accountKey}",
enableSsl: true
);
// </authenticate_client>
// <connect_client>
using var client = new GremlinClient(
gremlinServer: server,
messageSerializer: new Gremlin.Net.Structure.IO.GraphSON.GraphSON2MessageSerializer()
);
// </connect_client>
// <drop_graph>
await client.SubmitAsync(
requestScript: "g.V().drop()"
);
// </drop_graph>
// <create_vertices_1>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518371').property('name', 'Kiama classic surfboard').property('price', 285.55).property('category', 'surfboards')"
);
// </create_vertices_1>
// <create_vertices_2>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518403').property('name', 'Montau Turtle Surfboard').property('price', 600.00).property('category', 'surfboards')"
);
// </create_vertices_2>
// <create_vertices_3>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518409').property('name', 'Bondi Twin Surfboard').property('price', 585.50).property('category', 'surfboards')"
);
// </create_vertices_3>
// <create_edges_1>
await client.SubmitAsync(
requestScript: "g.V(['surfboards', '68719518403']).addE('replaces').to(g.V(['surfboards', '68719518371']))"
);
// </create_edges_1>
// <create_edges_2>
await client.SubmitAsync(
requestScript: "g.V(['surfboards', '68719518403']).addE('replaces').to(g.V(['surfboards', '68719518409']))"
);
// </create_edges_2>
// <query_vertices_edges>
var results = await client.SubmitAsync<Dictionary<string, object>>(
requestScript: "g.V().hasLabel('product').has('category', 'surfboards').has('name', 'Montau Turtle Surfboard').outE('replaces').inV()"
);
// </query_vertices_edges>
// <output_vertices_edges>
Console.WriteLine($"[CREATED PRODUCT]\t68719518403");
foreach (var result in results ?? Enumerable.Empty<Dictionary<string, object>>())
{
Console.WriteLine($"[REPLACES PRODUCT]\t{result["id"]}");
}
// </output_vertices_edges>
Tip
This edge defintion uses the g.V(['<partition-key>', '<id>'])
syntax. Alternatively, you can use g.V('<id>').has('category', '<partition-key>')
.
- Create another replaces edge from the same product to the
Bondi Twin Surfboard
.
// <imports>
using Gremlin.Net.Driver;
// </imports>
// <environment_variables>
string accountName = Environment.GetEnvironmentVariable("COSMOS_GREMLIN_ENDPOINT")!;
string accountKey = Environment.GetEnvironmentVariable("COSMOS_GREMLIN_KEY")!;
// </environment_variables>
// <authenticate_client>
var server = new GremlinServer(
hostname: $"{accountName}.gremlin.cosmos.azure.cn",
port: 443,
username: "/dbs/cosmicworks/colls/products",
password: $"{accountKey}",
enableSsl: true
);
// </authenticate_client>
// <connect_client>
using var client = new GremlinClient(
gremlinServer: server,
messageSerializer: new Gremlin.Net.Structure.IO.GraphSON.GraphSON2MessageSerializer()
);
// </connect_client>
// <drop_graph>
await client.SubmitAsync(
requestScript: "g.V().drop()"
);
// </drop_graph>
// <create_vertices_1>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518371').property('name', 'Kiama classic surfboard').property('price', 285.55).property('category', 'surfboards')"
);
// </create_vertices_1>
// <create_vertices_2>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518403').property('name', 'Montau Turtle Surfboard').property('price', 600.00).property('category', 'surfboards')"
);
// </create_vertices_2>
// <create_vertices_3>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518409').property('name', 'Bondi Twin Surfboard').property('price', 585.50).property('category', 'surfboards')"
);
// </create_vertices_3>
// <create_edges_1>
await client.SubmitAsync(
requestScript: "g.V(['surfboards', '68719518403']).addE('replaces').to(g.V(['surfboards', '68719518371']))"
);
// </create_edges_1>
// <create_edges_2>
await client.SubmitAsync(
requestScript: "g.V(['surfboards', '68719518403']).addE('replaces').to(g.V(['surfboards', '68719518409']))"
);
// </create_edges_2>
// <query_vertices_edges>
var results = await client.SubmitAsync<Dictionary<string, object>>(
requestScript: "g.V().hasLabel('product').has('category', 'surfboards').has('name', 'Montau Turtle Surfboard').outE('replaces').inV()"
);
// </query_vertices_edges>
// <output_vertices_edges>
Console.WriteLine($"[CREATED PRODUCT]\t68719518403");
foreach (var result in results ?? Enumerable.Empty<Dictionary<string, object>>())
{
Console.WriteLine($"[REPLACES PRODUCT]\t{result["id"]}");
}
// </output_vertices_edges>
Query vertices & edges
Use the Gremlin syntax to traverse the graph and discover relationships between vertices.
- Traverse the graph and find all vertices that
Montau Turtle Surfboard
replaces.
// <imports>
using Gremlin.Net.Driver;
// </imports>
// <environment_variables>
string accountName = Environment.GetEnvironmentVariable("COSMOS_GREMLIN_ENDPOINT")!;
string accountKey = Environment.GetEnvironmentVariable("COSMOS_GREMLIN_KEY")!;
// </environment_variables>
// <authenticate_client>
var server = new GremlinServer(
hostname: $"{accountName}.gremlin.cosmos.azure.cn",
port: 443,
username: "/dbs/cosmicworks/colls/products",
password: $"{accountKey}",
enableSsl: true
);
// </authenticate_client>
// <connect_client>
using var client = new GremlinClient(
gremlinServer: server,
messageSerializer: new Gremlin.Net.Structure.IO.GraphSON.GraphSON2MessageSerializer()
);
// </connect_client>
// <drop_graph>
await client.SubmitAsync(
requestScript: "g.V().drop()"
);
// </drop_graph>
// <create_vertices_1>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518371').property('name', 'Kiama classic surfboard').property('price', 285.55).property('category', 'surfboards')"
);
// </create_vertices_1>
// <create_vertices_2>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518403').property('name', 'Montau Turtle Surfboard').property('price', 600.00).property('category', 'surfboards')"
);
// </create_vertices_2>
// <create_vertices_3>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518409').property('name', 'Bondi Twin Surfboard').property('price', 585.50).property('category', 'surfboards')"
);
// </create_vertices_3>
// <create_edges_1>
await client.SubmitAsync(
requestScript: "g.V(['surfboards', '68719518403']).addE('replaces').to(g.V(['surfboards', '68719518371']))"
);
// </create_edges_1>
// <create_edges_2>
await client.SubmitAsync(
requestScript: "g.V(['surfboards', '68719518403']).addE('replaces').to(g.V(['surfboards', '68719518409']))"
);
// </create_edges_2>
// <query_vertices_edges>
var results = await client.SubmitAsync<Dictionary<string, object>>(
requestScript: "g.V().hasLabel('product').has('category', 'surfboards').has('name', 'Montau Turtle Surfboard').outE('replaces').inV()"
);
// </query_vertices_edges>
// <output_vertices_edges>
Console.WriteLine($"[CREATED PRODUCT]\t68719518403");
foreach (var result in results ?? Enumerable.Empty<Dictionary<string, object>>())
{
Console.WriteLine($"[REPLACES PRODUCT]\t{result["id"]}");
}
// </output_vertices_edges>
- Write to the console the static string
[CREATED PRODUCT]\t68719518403
. Then, iterate over each matching vertex using aforeach
loop and write to the console a message that starts with[REPLACES PRODUCT]
and includes the matching productid
field as a suffix.
// <imports>
using Gremlin.Net.Driver;
// </imports>
// <environment_variables>
string accountName = Environment.GetEnvironmentVariable("COSMOS_GREMLIN_ENDPOINT")!;
string accountKey = Environment.GetEnvironmentVariable("COSMOS_GREMLIN_KEY")!;
// </environment_variables>
// <authenticate_client>
var server = new GremlinServer(
hostname: $"{accountName}.gremlin.cosmos.azure.cn",
port: 443,
username: "/dbs/cosmicworks/colls/products",
password: $"{accountKey}",
enableSsl: true
);
// </authenticate_client>
// <connect_client>
using var client = new GremlinClient(
gremlinServer: server,
messageSerializer: new Gremlin.Net.Structure.IO.GraphSON.GraphSON2MessageSerializer()
);
// </connect_client>
// <drop_graph>
await client.SubmitAsync(
requestScript: "g.V().drop()"
);
// </drop_graph>
// <create_vertices_1>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518371').property('name', 'Kiama classic surfboard').property('price', 285.55).property('category', 'surfboards')"
);
// </create_vertices_1>
// <create_vertices_2>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518403').property('name', 'Montau Turtle Surfboard').property('price', 600.00).property('category', 'surfboards')"
);
// </create_vertices_2>
// <create_vertices_3>
await client.SubmitAsync(
requestScript: "g.addV('product').property('id', '68719518409').property('name', 'Bondi Twin Surfboard').property('price', 585.50).property('category', 'surfboards')"
);
// </create_vertices_3>
// <create_edges_1>
await client.SubmitAsync(
requestScript: "g.V(['surfboards', '68719518403']).addE('replaces').to(g.V(['surfboards', '68719518371']))"
);
// </create_edges_1>
// <create_edges_2>
await client.SubmitAsync(
requestScript: "g.V(['surfboards', '68719518403']).addE('replaces').to(g.V(['surfboards', '68719518409']))"
);
// </create_edges_2>
// <query_vertices_edges>
var results = await client.SubmitAsync<Dictionary<string, object>>(
requestScript: "g.V().hasLabel('product').has('category', 'surfboards').has('name', 'Montau Turtle Surfboard').outE('replaces').inV()"
);
// </query_vertices_edges>
// <output_vertices_edges>
Console.WriteLine($"[CREATED PRODUCT]\t68719518403");
foreach (var result in results ?? Enumerable.Empty<Dictionary<string, object>>())
{
Console.WriteLine($"[REPLACES PRODUCT]\t{result["id"]}");
}
// </output_vertices_edges>
Run the code
Validate that your application works as expected by running the application. The application should execute with no errors or warnings. The output of the application includes data about the created and queried items.
Open the terminal in the .NET project folder.
Use
dotnet run
to run the application.dotnet run
Observe the output from the application.
[CREATED PRODUCT] 68719518403 [REPLACES PRODUCT] 68719518371 [REPLACES PRODUCT] 68719518409
Clean up resources
When you no longer need the API for Gremlin account, delete the corresponding resource group.
Create a shell variable for resourceGroupName if it doesn't already exist.
# Variable for resource group name resourceGroupName="msdocs-cosmos-gremlin-quickstart"
Use
az group delete
to delete the resource group.az group delete \ --name $resourceGroupName