GraphExtensions.xml

<Type Name="GraphExtensions" FullName="Microsoft.Azure.Graphs.GraphExtensions">
  <TypeSignature Language="C#" Value="public static class GraphExtensions" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit GraphExtensions extends System.Object" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Graphs.GraphExtensions" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Azure.Graphs</AssemblyName>
    <AssemblyVersion>1.14.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>
            This class provides extension methods for creating Graph queries of type <see cref="T:Microsoft.Azure.Documents.Linq.IDocumentQuery`1" />.
            These queries will execute against Azure DocumentDB collection.
            </summary>
    <remarks>
            The class extends <see cref="T:Microsoft.Azure.Documents.Client.DocumentClient" /> class to enable you to express graph traversal and CRUD operations
            over data persisted in a Azure DocumentDB collection. The returned <see cref="T:Microsoft.Azure.Documents.Linq.IDocumentQuery`1" /> objects 
            wrap the actual query execution, and enumerating these objects forces Azure DocumentDB queries to be executed.
            </remarks>
  </Docs>
  <Members>
    <Member MemberName="CreateGremlinQuery">
      <MemberSignature Language="C#" Value="public static Microsoft.Azure.Documents.Linq.IDocumentQuery&lt;dynamic&gt; CreateGremlinQuery (this Microsoft.Azure.Documents.Client.DocumentClient documentClient, Microsoft.Azure.Documents.DocumentCollection collection, string gremlinExpression, Microsoft.Azure.Documents.Client.FeedOptions feedOptions = null, Microsoft.Azure.Graphs.GraphSONMode graphSONMode = Microsoft.Azure.Graphs.GraphSONMode.Compact);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Documents.Linq.IDocumentQuery`1&lt;object&gt; CreateGremlinQuery(class Microsoft.Azure.Documents.Client.DocumentClient documentClient, class Microsoft.Azure.Documents.DocumentCollection collection, string gremlinExpression, class Microsoft.Azure.Documents.Client.FeedOptions feedOptions, valuetype Microsoft.Azure.Graphs.GraphSONMode graphSONMode) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Graphs.GraphExtensions.CreateGremlinQuery(Microsoft.Azure.Documents.Client.DocumentClient,Microsoft.Azure.Documents.DocumentCollection,System.String,Microsoft.Azure.Documents.Client.FeedOptions,Microsoft.Azure.Graphs.GraphSONMode)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Graphs</AssemblyName>
        <AssemblyVersion>1.14.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Azure.Documents.Linq.IDocumentQuery&lt;System.Object&gt;</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="documentClient" Type="Microsoft.Azure.Documents.Client.DocumentClient" RefType="this" />
        <Parameter Name="collection" Type="Microsoft.Azure.Documents.DocumentCollection" />
        <Parameter Name="gremlinExpression" Type="System.String" />
        <Parameter Name="feedOptions" Type="Microsoft.Azure.Documents.Client.FeedOptions" />
        <Parameter Name="graphSONMode" Type="Microsoft.Azure.Graphs.GraphSONMode" />
      </Parameters>
      <Docs>
        <param name="documentClient">The DocumentClient instance to execute the query.</param>
        <param name="collection">The DocumentCollection that contains the graph to query.</param>
        <param name="gremlinExpression">The Gremlin expression.</param>
        <param name="feedOptions">The options for processing the query result feed. For details <see cref="T:Microsoft.Azure.Documents.Client.FeedOptions" />.</param>
        <param name="graphSONMode">The GraphSON mode to use when returning the results of the query.</param>
        <summary>
            Method to create a Gremlin expression to create/query graph elements stored under an Azure CosmosDB collection.
            </summary>
        <returns>An <see cref="T:Microsoft.Azure.Documents.Linq.IDocumentQuery`1" /> that can evaluate the query.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="CreateGremlinQuery&lt;T&gt;">
      <MemberSignature Language="C#" Value="public static Microsoft.Azure.Documents.Linq.IDocumentQuery&lt;T&gt; CreateGremlinQuery&lt;T&gt; (this Microsoft.Azure.Documents.Client.DocumentClient documentClient, Microsoft.Azure.Documents.DocumentCollection collection, string gremlinExpression, Microsoft.Azure.Documents.Client.FeedOptions feedOptions = null, Microsoft.Azure.Graphs.GraphSONMode graphSONMode = Microsoft.Azure.Graphs.GraphSONMode.Compact);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Azure.Documents.Linq.IDocumentQuery`1&lt;!!T&gt; CreateGremlinQuery&lt;T&gt;(class Microsoft.Azure.Documents.Client.DocumentClient documentClient, class Microsoft.Azure.Documents.DocumentCollection collection, string gremlinExpression, class Microsoft.Azure.Documents.Client.FeedOptions feedOptions, valuetype Microsoft.Azure.Graphs.GraphSONMode graphSONMode) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Graphs.GraphExtensions.CreateGremlinQuery``1(Microsoft.Azure.Documents.Client.DocumentClient,Microsoft.Azure.Documents.DocumentCollection,System.String,Microsoft.Azure.Documents.Client.FeedOptions,Microsoft.Azure.Graphs.GraphSONMode)" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Graphs</AssemblyName>
        <AssemblyVersion>1.14.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Microsoft.Azure.Documents.Linq.IDocumentQuery&lt;T&gt;</ReturnType>
      </ReturnValue>
      <TypeParameters>
        <TypeParameter Name="T" />
      </TypeParameters>
      <Parameters>
        <Parameter Name="documentClient" Type="Microsoft.Azure.Documents.Client.DocumentClient" RefType="this" />
        <Parameter Name="collection" Type="Microsoft.Azure.Documents.DocumentCollection" />
        <Parameter Name="gremlinExpression" Type="System.String" />
        <Parameter Name="feedOptions" Type="Microsoft.Azure.Documents.Client.FeedOptions" />
        <Parameter Name="graphSONMode" Type="Microsoft.Azure.Graphs.GraphSONMode" />
      </Parameters>
      <Docs>
        <typeparam name="T">Type of the object to query.</typeparam>
        <param name="documentClient">The DocumentClient instance to execute the query.</param>
        <param name="collection">The DocumentCollection that contains the graph to query.</param>
        <param name="gremlinExpression">The Gremlin expression.</param>
        <param name="feedOptions">The options for processing the query result feed. For details <see cref="T:Microsoft.Azure.Documents.Client.FeedOptions" />.</param>
        <param name="graphSONMode">The GraphSON mode to use when returning the results of the query.</param>
        <summary>
            Method to create a Gremlin expression to create/query graph elements stored under an Azure CosmosDB collection.
            </summary>
        <returns>An <see cref="T:Microsoft.Azure.Documents.Linq.IDocumentQuery`1" /> that can evaluate the query.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>