Início Rápido: Compilar um aplicativo .NET Framework ou Core usando a conta da API do Gremlin do Azure Cosmos DBQuickstart: Build a .NET Framework or Core application using the Azure Cosmos DB Gremlin API account

O Azure Cosmos DB é o serviço de banco de dados multimodelo distribuído globalmente da Microsoft.Azure Cosmos DB is Microsoft's globally distributed multi-model database service. É possível criar e consultar rapidamente documentos, chave/valor e bancos de dados do grafo. Todos se beneficiam de recursos de escala horizontal e distribuição global no núcleo do Azure Cosmos DB.You can quickly create and query document, key/value, and graph databases, all of which benefit from the global distribution and horizontal scale capabilities at the core of Azure Cosmos DB.

Este início rápido demonstra como criar uma conta da API do Gremlin do Azure Cosmos DB, um banco de dados e um grafo (contêiner) usando o portal do Azure.This quick start demonstrates how to create an Azure Cosmos DB Gremlin API account, database, and graph (container) using the Azure portal. Depois, compile e execute um aplicativo de console criado usando o driver de código-aberto Gremlin.Net.You then build and run a console app built using the open-source driver Gremlin.Net.

Pré-requisitosPrerequisites

Se você ainda não tem o Visual 2019 Studio instalado, pode baixar e usar o Visual Studio 2019 Community Edition gratuito.If you don't already have Visual Studio 2019 installed, you can download and use the free Visual Studio 2019 Community Edition. Verifique se você habilitou o desenvolvimento do Azure durante a instalação do Visual Studio.Make sure that you enable Azure development during the Visual Studio setup.

Se você não tiver uma assinatura do Azure, crie uma conta gratuita antes de começar.If you don't have an Azure subscription, create a free account before you begin.

Criar uma conta de banco de dadosCreate a database account

  1. Em uma nova janela do navegador, entre no Portal do Azure.In a new browser window, sign in to the Azure portal.

  2. Clique em Criar um recurso > Bancos de dados > Azure Cosmos DB.Click Create a resource > Databases > Azure Cosmos DB.

    Painel “Bancos de dados” do portal do Azure

  3. Na página Criar Conta do Azure Cosmos DB, insira as configurações da nova conta do Azure Cosmos DB.In the Create Azure Cosmos DB Account page, enter the settings for the new Azure Cosmos DB account.

    ConfiguraçãoSetting ValorValue DESCRIÇÃODescription
    AssinaturaSubscription Sua assinaturaYour subscription Selecione a assinatura do Azure que você deseja usar para essa conta do Azure Cosmos DB.Select the Azure subscription that you want to use for this Azure Cosmos DB account.
    Grupo de recursosResource Group Criar NovoCreate new

    Em seguida, insira o mesmo nome exclusivo fornecido na IDThen enter the same unique name as provided in ID
    Selecione Criar novo.Select Create new. Insira o novo nome do grupo de recursos para sua conta.Then enter a new resource-group name for your account. Para simplificar, use um nome igual à sua ID.For simplicity, use the same name as your ID.
    Nome da contaAccount Name Insira um nome exclusivoEnter a unique name Insira um nome exclusivo para identificar a conta do Azure Cosmos DB.Enter a unique name to identify your Azure Cosmos DB account. Como documents.Azure.com é acrescentado à ID que você fornece para criar o URI, use uma ID exclusiva.Because documents.azure.com is appended to the ID that you provide to create your URI, use a unique ID.

    A ID deve conter apenas letras minúsculas, números e o caractere de hífen (-).The ID can use only lowercase letters, numbers, and the hyphen (-) character. Ela precisa ter entre 3 e 31 caracteres.It must be between 3 and 31 characters in length.
    APIAPI Gremlin (grafo)Gremlin (graph) A API determina o tipo de conta a ser criada.The API determines the type of account to create. O Azure Cosmos DB fornece cinco APIs: Core(SQL) para bancos de dados de documentos, Gremlin para o bancos de dados de grafos, MongoDB para bancos de dados de documentos, Tabela do Azure e Cassandra.Azure Cosmos DB provides five APIs: Core(SQL) for document databases, Gremlin for graph databases, MongoDB for document databases, Azure Table, and Cassandra. No momento, você deve criar uma conta separada para cada API.Currently, you must create a separate account for each API.

    Selecione Gremlin (grafo) porque neste guia de início rápido você está criando uma tabela que funciona com a API do Gremlin.Select Gremlin (graph) because in this quickstart you are creating a table that works with the Gremlin API.

    Saiba mais sobre a API do Graph.Learn more about the Graph API.
    Local padrãoLocation Selecione a região mais próxima de seus usuáriosSelect the region closest to your users Selecione uma localização geográfica para hospedar a sua conta do Azure Cosmos DB.Select a geographic location to host your Azure Cosmos DB account. Use o local mais próximo dos usuários para fornecer a eles acesso mais rápido aos dados.Use the location that's closest to your users to give them the fastest access to the data.

    Selecione Revisar + Criar.Select Review+Create. Você pode ignorar as seções Rede e Marcas.You can skip the Network and Tags section.

    A folha da nova conta do Azure Cosmos DB

  4. A criação da conta leva alguns minutos.The account creation takes a few minutes. Aguarde até que o portal exiba a página Parabéns! Sua conta do Azure Cosmos DB foi criada.Wait for the portal to display the Congratulations! Your Azure Cosmos DB account was created page.

    O painel Notificações do portal do Azure

Adicionar um grafoAdd a graph

Agora, você pode usar a ferramenta Data Explorer no portal do Azure para criar um banco de dados de grafo.You can now use the Data Explorer tool in the Azure portal to create a graph database.

  1. Clique em Data Explorer > Novo Grafo.Click Data Explorer > New Graph.

    A área Adicionar Grafo é exibida à direita, talvez seja necessário rolar para a direita para vê-la.The Add Graph area is displayed on the far right, you may need to scroll right to see it.

    O Data Explorer do Portal do Azure, página Adicionar Grafo

  2. Na página Adicionar Grafo, insira as configurações do novo grafo.In the Add graph page, enter the settings for the new graph.

    ConfiguraçãoSetting Valor sugeridoSuggested value DESCRIÇÃODescription
    ID do banco de dadosDatabase ID banco de dados de exemplosample-database Digite banco de dados de exemplo como o nome do novo banco de dados.Enter sample-database as the name for the new database. Os nomes de banco de dados devem ter entre um e 255 caracteres e não podem conter / \ # ? nem espaços à direita.Database names must be between 1 and 255 characters, and cannot contain / \ # ? or a trailing space.
    ID do GrafoGraph ID grafo de exemplosample-graph Digite grafo de exemplo como o nome da nova coleção.Enter sample-graph as the name for your new collection. Os nomes de grafo têm os mesmos requisitos de caractere do que as IDs de banco de dados.Graph names have the same character requirements as database IDs.
    Capacidade de ArmazenamentoStorage Capacity Fixo (10 GB)Fixed (10 GB) Deixe o valor padrão de Fixo (10 GB) .Leave the default value of Fixed (10 GB). Esse valor é a capacidade de armazenamento do banco de dados.This value is the storage capacity of the database.
    ProdutividadeThroughput 400 RUs400 RUs Altere a taxa de transferência para 400 unidades de solicitação por segundo (RU/s).Change the throughput to 400 request units per second (RU/s). Se quiser reduzir a latência, você poderá escalar verticalmente a taxa de transferência mais tarde.If you want to reduce latency, you can scale up the throughput later.
  3. Quando o formulário estiver preenchido, clique em OK.Once the form is filled out, click OK.

Clonar o aplicativo de exemploClone the sample application

Agora vamos clonar um aplicativo de API do Gremlin do GitHub, definir a cadeia de conexão e executá-lo.Now let's clone a Gremlin API app from GitHub, set the connection string, and run it. Você verá como é fácil trabalhar usando dados de forma programática.You'll see how easy it is to work with data programmatically.

  1. Abra um prompt de comando, crie uma nova pasta chamada exemplos de git e feche o prompt de comando.Open a command prompt, create a new folder named git-samples, then close the command prompt.

    md "C:\git-samples"
    
  2. Abra uma janela de terminal de git, como git bash, e use o comando cd para alterar para a nova pasta para instalar o aplicativo de exemplo.Open a git terminal window, such as git bash, and use the cd command to change to the new folder to install the sample app.

    cd "C:\git-samples"
    
  3. Execute o comando a seguir para clonar o repositório de exemplo.Run the following command to clone the sample repository. Este comando cria uma cópia do aplicativo de exemplo no seu computador.This command creates a copy of the sample app on your computer.

    git clone https://github.com/Azure-Samples/azure-cosmos-db-graph-gremlindotnet-getting-started.git
    
  4. Em seguida, abra o Visual Studio e o arquivo da solução.Then open Visual Studio and open the solution file.

  5. Restaure os pacotes NuGet no projeto.Restore the NuGet packages in the project. Isso deve incluir o driver Gremlin.Net, bem como o pacote Newtonsoft.Json.This should include the Gremlin.Net driver, as well as the Newtonsoft.Json package.

  6. Também é possível instalar o driver Gremlin.Net manualmente, usando o gerenciador de pacotes Nuget ou o utilitário de linha de comando do nuget:You can also install the Gremlin.Net driver manually using the Nuget package manager, or the nuget command-line utility:

    nuget install Gremlin.Net
    

Examine o códigoReview the code

Esta etapa é opcional.This step is optional. Se você estiver interessado em aprender como os recursos de banco de dados são criados no código, poderá examinar os snippets de código a seguir.If you're interested in learning how the database resources are created in the code, you can review the following snippets. Caso contrário, você poderá pular para Atualizar sua cadeia de conexão.Otherwise, you can skip ahead to Update your connection string.

Todos os snippets de código a seguir são retirados do arquivo Program.cs.The following snippets are all taken from the Program.cs file.

  • Defina os parâmetros de conexão baseados na conta criada acima (linha 19):Set your connection parameters based on the account created above (Line 19):

    private static string hostname = "your-endpoint.gremlin.cosmosdb.azure.com";
    private static int port = 443;
    private static string authKey = "your-authentication-key";
    private static string database = "your-database";
    private static string collection = "your-graph-container";
    
  • Os comandos de Gremlin a serem executados são listados em um dicionário (linha 26):The Gremlin commands to be executed are listed in a Dictionary (Line 26):

    private static Dictionary<string, string> gremlinQueries = new Dictionary<string, string>
    {
        { "Cleanup",        "g.V().drop()" },
        { "AddVertex 1",    "g.addV('person').property('id', 'thomas').property('firstName', 'Thomas').property('age', 44)" },
        { "AddVertex 2",    "g.addV('person').property('id', 'mary').property('firstName', 'Mary').property('lastName', 'Andersen').property('age', 39)" },
        { "AddVertex 3",    "g.addV('person').property('id', 'ben').property('firstName', 'Ben').property('lastName', 'Miller')" },
        { "AddVertex 4",    "g.addV('person').property('id', 'robin').property('firstName', 'Robin').property('lastName', 'Wakefield')" },
        { "AddEdge 1",      "g.V('thomas').addE('knows').to(g.V('mary'))" },
        { "AddEdge 2",      "g.V('thomas').addE('knows').to(g.V('ben'))" },
        { "AddEdge 3",      "g.V('ben').addE('knows').to(g.V('robin'))" },
        { "UpdateVertex",   "g.V('thomas').property('age', 44)" },
        { "CountVertices",  "g.V().count()" },
        { "Filter Range",   "g.V().hasLabel('person').has('age', gt(40))" },
        { "Project",        "g.V().hasLabel('person').values('firstName')" },
        { "Sort",           "g.V().hasLabel('person').order().by('firstName', decr)" },
        { "Traverse",       "g.V('thomas').out('knows').hasLabel('person')" },
        { "Traverse 2x",    "g.V('thomas').out('knows').hasLabel('person').out('knows').hasLabel('person')" },
        { "Loop",           "g.V('thomas').repeat(out()).until(has('id', 'robin')).path()" },
        { "DropEdge",       "g.V('thomas').outE('knows').where(inV().has('id', 'mary')).drop()" },
        { "CountEdges",     "g.E().count()" },
        { "DropVertex",     "g.V('thomas').drop()" },
    };
    
  • Crie um objeto de conexão GremlinServer usando os parâmetros fornecidos acima (linha 52):Create a GremlinServer connection object using the parameters provided above (Line 52):

    var gremlinServer = new GremlinServer(hostname, port, enableSsl: true, 
                                                    username: "/dbs/" + database + "/colls/" + collection, 
                                                    password: authKey);
    
  • Crie um novo objeto GremlinClient (linha 56):Create a new GremlinClient object (Line 56):

    var gremlinClient = new GremlinClient(gremlinServer);
    
  • Execute cada consulta Gremlin usando o objeto GremlinClient com uma tarefa assíncrona (linha 63).Execute each Gremlin query using the GremlinClient object with an async task (Line 63). Isso lerá as consultas Gremlin do dicionário definido acima (linha 26):This will read the Gremlin queries from the dictionary defined above (Line 26):

    var results = await gremlinClient.SubmitAsync<dynamic>(query.Value);
    
  • Recupere o resultado e leia os valores, que são formatados como um dicionário, usando a classe JsonSerializer do Newtonsoft.Json:Retrieve the result and read the values, which are formatted as a dictionary, using the JsonSerializer class from Newtonsoft.Json:

    foreach (var result in results)
    {
        // The vertex results are formed as dictionaries with a nested dictionary for their properties
        string output = JsonConvert.SerializeObject(result);
        Console.WriteLine(String.Format("\tResult:\n\t{0}", output));
    }
    

Atualizar sua cadeia de conexãoUpdate your connection string

Agora, volte ao portal do Azure para obter informações sobre a cadeia de conexão e copiá-las para o aplicativo.Now go back to the Azure portal to get your connection string information and copy it into the app.

  1. No portal do Azure, navegue até sua conta de banco de dados do gráfico.From the Azure portal, navigate to your graph database account. Na guia Visão geral, você pode ver dois pontos de extremidade -In the Overview tab, you can see two endpoints-

    URI de SDK do .NET - Esse valor é usado ao conectar-se à conta do Graph usando a biblioteca Microsoft.Azure.Graphs..NET SDK URI - This value is used when you connect to the graph account by using Microsoft.Azure.Graphs library.

    Ponto de Extremidade do Gremlin - Esse valor é usado ao se conectar à conta do Graph usando a biblioteca Gremlin.Net.Gremlin Endpoint - This value is used when you connect to the graph account by using Gremlin.Net library.

    Copiar o ponto de extremidade

    Para executar este exemplo, copie o valor do Ponto de Extremidade do Gremlin, exclua o número da porta no final e o URI se tornará https://<your cosmos db account name>.gremlin.cosmosdb.azure.comTo run this sample, copy the Gremlin Endpoint value, delete the port number at the end, that is the URI becomes https://<your cosmos db account name>.gremlin.cosmosdb.azure.com

  2. Em Program.cs, cole o valor sobre your-endpoint na variável hostname na linha 19.In Program.cs paste the value over your-endpoint in the hostname variable in line 19.

    "private static string hostname = "<your cosmos db account name>.gremlin.cosmosdb.azure.com";

    Agora, o valor de ponto de extremidade deve ter esta aparência:The endpoint value should now look like this:

    "private static string hostname = "testgraphacct.gremlin.cosmosdb.azure.com";

  3. Em seguida, navegue até a guia Chave e copie CHAVE PRIMÁRIAauthkey no portal e cole-o na variável, substituindo o espaço reservado "your-authentication-key" na linha 21.Next, navigate to the Keys tab and copy PRIMARY KEY value from the portal, and paste it in the authkey variable, replacing the "your-authentication-key" placeholder in line 21.

    private static string authKey = "your-authentication-key";

  4. Usando as informações do banco de dados criado acima, cole o nome do banco de dados dentro da variável database na linha 22.Using the information of the database created above, paste the database name inside of the database variable in line 22.

    private static string database = "your-database";

  5. De modo semelhante, usando as informações do contêiner criada acima, cole o contêiner (que também é o nome do grafo) dentro da variável collection na linha 23.Similarly, using the information of the container created above, paste the collection (which is also the graph name) inside of the collection variable in line 23.

    private static string collection = "your-collection-or-graph";

  6. Salve o arquivo Program.cs.Save the Program.cs file.

Agora, você atualizou o aplicativo com todas as informações necessárias para se comunicar com o Azure Cosmos DB.You've now updated your app with all the info it needs to communicate with Azure Cosmos DB.

Execute o aplicativo de consoleRun the console app

Clique em CTRL + F5 para executar o aplicativo.Click CTRL + F5 to run the application. O aplicativo imprimirá os comandos e resultados de consulta Gremlin no console.The application will print both the Gremlin query commands and results in the console.

A janela do console exibe os vértices e bordas sendo adicionadas ao grafo.The console window displays the vertexes and edges being added to the graph. Quando o script for concluído, pressione ENTER para fechar a janela do console.When the script completes, press ENTER to close the console window.

Navegar usando o Data ExplorerBrowse using the Data Explorer

Agora você pode voltar ao Data Explorer no Portal do Azure e procurar e consultar seus novos dados de grafo.You can now go back to Data Explorer in the Azure portal and browse and query your new graph data.

  1. No Data Explorer, o novo banco de dados aparece no painel Grafos.In Data Explorer, the new database appears in the Graphs pane. Expanda os nós do banco de dados e do contêiner, depois clique em Grafo.Expand the database and container nodes, and then click Graph.

  2. Clique no botão Aplicar Filtro para usar a consulta padrão para exibir todos os vértices no grafo.Click the Apply Filter button to use the default query to view all the vertices in the graph. Os dados gerados pelo aplicativo de exemplo são exibidos no painel Grafos.The data generated by the sample app is displayed in the Graphs pane.

    É possível ampliar e diminuir o zoom do grafo, expandir o espaço de exibição do grafo, adicionar outros vértices e mover vértices na superfície de exibição.You can zoom in and out of the graph, you can expand the graph display space, add additional vertices, and move vertices on the display surface.

    Exibir o grafo no Data Explorer no Portal do Azure

Examinar SLAs no Portal do AzureReview SLAs in the Azure portal

O portal do Azure monitora a taxa de transferência, armazenamento, disponibilidade, latência e consistência da conta do Cosmos DB.The Azure portal monitors your Cosmos DB account throughput, storage, availability, latency, and consistency. Gráficos de métricas associados a um SLA (Contrato de Nível de Serviço) do Azure Cosmos DB mostram o valor do SLA em comparação com o desempenho real.Charts for metrics associated with an Azure Cosmos DB Service Level Agreement (SLA) show the SLA value compared to actual performance. Esse conjunto de métricas torna o monitoramento dos SLAs transparente.This suite of metrics makes monitoring your SLAs transparent.

Para examinar as métricas e os SLAs:To review metrics and SLAs:

  1. Selecione Métricas no menu de navegação da sua conta do Cosmos DB.Select Metrics in your Cosmos DB account's navigation menu.

  2. Selecione uma guia, tal como Latência, e selecione um período à direita.Select a tab such as Latency, and select a timeframe on the right. Comparar as linhas Real e SLA dos gráficos.Compare the Actual and SLA lines on the charts.

    Pacote de métricas do Azure Cosmos DB

  3. Examine as métricas nas outras guias.Review the metrics on the other tabs.

Limpar recursosClean up resources

Quando você concluir seu aplicativo Web e a conta do Azure Cosmos DB, poderá excluir os recursos do Azure criados para não incorrer em mais cobranças.When you're done with your web app and Azure Cosmos DB account, you can delete the Azure resources you created so you don't incur more charges. Para excluir os recursos:To delete the resources:

  1. No portal do Azure, selecione Grupos de recursos no canto esquerdo.In the Azure portal, select Resource groups on the far left. Se o menu esquerdo estiver recolhido, selecione Expandir botão para expandi-lo.If the left menu is collapsed, select Expand button to expand it.

  2. Selecione o grupo de recursos que você criou para este início rápido.Select the resource group you created for this quickstart.

    Métricas no portal do Azure

  3. Na nova janela, selecione Excluir grupo de recursos.In the new window, select Delete resource group.

    Métricas no portal do Azure

  4. Na próxima janela, digite o nome do grupo de recursos a ser excluído e selecione Excluir.In the next window, type the name of the resource group to delete, and then select Delete.

Próximas etapasNext steps

Neste início rápido, você aprendeu como criar uma conta do Azure Cosmos DB, como criar um grafo usando o Data Explorer e como executar um aplicativo.In this quickstart, you've learned how to create an Azure Cosmos DB account, create a graph using the Data Explorer, and run an app. Agora, você pode criar consultas mais complexas e implementar uma lógica de passagem de grafo avançada usando o Gremlin.You can now build more complex queries and implement powerful graph traversal logic using Gremlin.