| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta charset="utf-8"> |
| <title>Class IgniteTuple |
| | Apache Ignite.NET API Documentation </title> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| <meta name="title" content="Class IgniteTuple |
| | Apache Ignite.NET API Documentation "> |
| |
| <link rel="icon" href="../images/favicon.ico"> |
| <link rel="stylesheet" href="../styles/docfx.min.css"> |
| <link rel="stylesheet" href="../styles/main.css"> |
| <meta name="docfx:navrel" content="../toc.html"> |
| <meta name="docfx:tocrel" content="toc.html"> |
| |
| <meta name="docfx:rel" content="../"> |
| <meta name="docfx:docurl" content="https://github.com/apache/ignite-3/new/main/apiSpec/new?filename=Apache_Ignite_Table_IgniteTuple.md&value=---%0Auid%3A%20Apache.Ignite.Table.IgniteTuple%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A"> |
| |
| <script> |
| MathJax = { |
| options: { |
| processHtmlClass: ['tex2jax_process', 'math'] |
| } |
| }; |
| </script> |
| |
| <script type="text/javascript" src="../styles/docfx.min.js"></script> |
| <script type="text/javascript" src="../styles/main.js"></script> |
| </head> |
| |
| <body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference"> |
| <header class="bg-body border-bottom"> |
| <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> |
| <div class="container-xxl flex-nowrap"> |
| <a class="navbar-brand" href="../index.html"> |
| <img id="logo" class="svg" src="../images/logo.svg" alt=""> |
| |
| </a> |
| <button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation"> |
| <i class="bi bi-three-dots"></i> |
| </button> |
| <div class="collapse navbar-collapse" id="navpanel"> |
| <div id="navbar"> |
| <form class="search" role="search" id="search"> |
| <i class="bi bi-search"></i> |
| <input class="form-control" id="search-query" type="search" disabled="" placeholder="Search" autocomplete="off" aria-label="Search"> |
| </form> |
| </div> |
| </div> |
| </div> |
| </nav> |
| </header> |
| |
| <main class="container-xxl"> |
| <div class="toc-offcanvas"> |
| <div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel"> |
| <div class="offcanvas-header"> |
| <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5> |
| <button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button> |
| </div> |
| <div class="offcanvas-body"> |
| <nav class="toc" id="toc"></nav> |
| </div> |
| </div> |
| </div> |
| |
| <div class="content"> |
| <div class="actionbar"> |
| <button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents"> |
| <i class="bi bi-list"></i> |
| </button> |
| |
| <nav id="breadcrumb"></nav> |
| </div> |
| |
| <article data-uid="Apache.Ignite.Table.IgniteTuple"> |
| |
| |
| |
| <h1 id="Apache_Ignite_Table_IgniteTuple" data-uid="Apache.Ignite.Table.IgniteTuple" class="text-break"> |
| Class IgniteTuple |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-19328/modules/platforms/dotnet/Apache.Ignite/Table/IgniteTuple.cs/#L28"><i class="bi bi-code-slash"></i></a> |
| </h1> |
| |
| <div class="facts text-secondary"> |
| <dl><dt>Namespace</dt><dd><a class="xref" href="Apache.html">Apache</a>.<a class="xref" href="Apache.Ignite.html">Ignite</a>.<a class="xref" href="Apache.Ignite.Table.html">Table</a></dd></dl> |
| <dl><dt>Assembly</dt><dd>Apache.Ignite.dll</dd></dl> |
| </div> |
| |
| <div class="markdown summary"><p>Ignite tuple.</p> |
| </div> |
| <div class="markdown conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public sealed class IgniteTuple : IIgniteTuple, IEquatable<IgniteTuple></code></pre> |
| </div> |
| |
| |
| |
| |
| <dl class="typelist inheritance"> |
| <dt>Inheritance</dt> |
| <dd> |
| <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div> |
| <div><span class="xref">IgniteTuple</span></div> |
| </dd> |
| </dl> |
| |
| <dl class="typelist implements"> |
| <dt>Implements</dt> |
| <dd> |
| <div><a class="xref" href="Apache.Ignite.Table.IIgniteTuple.html">IIgniteTuple</a></div> |
| <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iequatable-1">IEquatable</a><<a class="xref" href="Apache.Ignite.Table.IgniteTuple.html">IgniteTuple</a>></div> |
| </dd> |
| </dl> |
| |
| |
| <dl class="typelist derived"> |
| <dt>Inherited Members</dt> |
| <dd> |
| <div> |
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a> |
| </div> |
| <div> |
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a> |
| </div> |
| <div> |
| <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a> |
| </div> |
| </dd></dl> |
| |
| |
| |
| |
| |
| |
| <h2 class="section" id="constructors">Constructors |
| </h2> |
| |
| |
| <a id="Apache_Ignite_Table_IgniteTuple__ctor_" data-uid="Apache.Ignite.Table.IgniteTuple.#ctor*"></a> |
| |
| <h3 id="Apache_Ignite_Table_IgniteTuple__ctor_System_Int32_" data-uid="Apache.Ignite.Table.IgniteTuple.#ctor(System.Int32)"> |
| IgniteTuple(int) |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-19328/modules/platforms/dotnet/Apache.Ignite/Table/IgniteTuple.cs/#L41"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Apache.Ignite.Table.IgniteTuple.html">IgniteTuple</a> class.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public IgniteTuple(int capacity = 16)</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>capacity</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt> |
| <dd><p>Capacity.</p> |
| </dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <h2 class="section" id="properties">Properties |
| </h2> |
| |
| |
| <a id="Apache_Ignite_Table_IgniteTuple_FieldCount_" data-uid="Apache.Ignite.Table.IgniteTuple.FieldCount*"></a> |
| |
| <h3 id="Apache_Ignite_Table_IgniteTuple_FieldCount" data-uid="Apache.Ignite.Table.IgniteTuple.FieldCount"> |
| FieldCount |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-19328/modules/platforms/dotnet/Apache.Ignite/Table/IgniteTuple.cs/#L48"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Gets the number of columns.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public int FieldCount { get; }</code></pre> |
| </div> |
| |
| |
| |
| |
| |
| <h4 class="section">Property Value</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="Apache_Ignite_Table_IgniteTuple_Item_" data-uid="Apache.Ignite.Table.IgniteTuple.Item*"></a> |
| |
| <h3 id="Apache_Ignite_Table_IgniteTuple_Item_System_Int32_" data-uid="Apache.Ignite.Table.IgniteTuple.Item(System.Int32)"> |
| this[int] |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-19328/modules/platforms/dotnet/Apache.Ignite/Table/IgniteTuple.cs/#L51"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Gets the value of the specified column as an object.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public object? this[int ordinal] { get; set; }</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>ordinal</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt> |
| <dd><p>The zero-based column ordinal.</p> |
| </dd> |
| </dl> |
| |
| |
| |
| |
| <h4 class="section">Property Value</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="Apache_Ignite_Table_IgniteTuple_Item_" data-uid="Apache.Ignite.Table.IgniteTuple.Item*"></a> |
| |
| <h3 id="Apache_Ignite_Table_IgniteTuple_Item_System_String_" data-uid="Apache.Ignite.Table.IgniteTuple.Item(System.String)"> |
| this[string] |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-19328/modules/platforms/dotnet/Apache.Ignite/Table/IgniteTuple.cs/#L58"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Gets the value of the specified column as an object.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public object? this[string name] { get; set; }</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>name</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt> |
| <dd><p>The column name.</p> |
| </dd> |
| </dl> |
| |
| |
| |
| |
| <h4 class="section">Property Value</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| <h2 class="section" id="methods">Methods |
| </h2> |
| |
| |
| <a id="Apache_Ignite_Table_IgniteTuple_Equals_" data-uid="Apache.Ignite.Table.IgniteTuple.Equals*"></a> |
| |
| <h3 id="Apache_Ignite_Table_IgniteTuple_Equals_Apache_Ignite_Table_IgniteTuple_" data-uid="Apache.Ignite.Table.IgniteTuple.Equals(Apache.Ignite.Table.IgniteTuple)"> |
| Equals(IgniteTuple?) |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-19328/modules/platforms/dotnet/Apache.Ignite/Table/IgniteTuple.cs/#L100"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public bool Equals(IgniteTuple? other)</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>other</code> <a class="xref" href="Apache.Ignite.Table.IgniteTuple.html">IgniteTuple</a></dt> |
| <dd></dd> |
| </dl> |
| |
| <h4 class="section">Returns</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="Apache_Ignite_Table_IgniteTuple_Equals_" data-uid="Apache.Ignite.Table.IgniteTuple.Equals*"></a> |
| |
| <h3 id="Apache_Ignite_Table_IgniteTuple_Equals_System_Object_" data-uid="Apache.Ignite.Table.IgniteTuple.Equals(System.Object)"> |
| Equals(object?) |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-19328/modules/platforms/dotnet/Apache.Ignite/Table/IgniteTuple.cs/#L106"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override bool Equals(object? obj)</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>obj</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></dt> |
| <dd></dd> |
| </dl> |
| |
| <h4 class="section">Returns</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="Apache_Ignite_Table_IgniteTuple_GetHashCode_" data-uid="Apache.Ignite.Table.IgniteTuple.GetHashCode*"></a> |
| |
| <h3 id="Apache_Ignite_Table_IgniteTuple_GetHashCode" data-uid="Apache.Ignite.Table.IgniteTuple.GetHashCode"> |
| GetHashCode() |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-19328/modules/platforms/dotnet/Apache.Ignite/Table/IgniteTuple.cs/#L112"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override int GetHashCode()</code></pre> |
| </div> |
| |
| |
| <h4 class="section">Returns</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="Apache_Ignite_Table_IgniteTuple_GetName_" data-uid="Apache.Ignite.Table.IgniteTuple.GetName*"></a> |
| |
| <h3 id="Apache_Ignite_Table_IgniteTuple_GetName_System_Int32_" data-uid="Apache.Ignite.Table.IgniteTuple.GetName(System.Int32)"> |
| GetName(int) |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-19328/modules/platforms/dotnet/Apache.Ignite/Table/IgniteTuple.cs/#L81"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Gets the name of the column, given the zero-based column ordinal.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public string GetName(int ordinal)</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>ordinal</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt> |
| <dd><p>Zero-based column ordinal.</p> |
| </dd> |
| </dl> |
| |
| <h4 class="section">Returns</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt> |
| <dd><p>Column name.</p> |
| </dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="Apache_Ignite_Table_IgniteTuple_GetOrdinal_" data-uid="Apache.Ignite.Table.IgniteTuple.GetOrdinal*"></a> |
| |
| <h3 id="Apache_Ignite_Table_IgniteTuple_GetOrdinal_System_String_" data-uid="Apache.Ignite.Table.IgniteTuple.GetOrdinal(System.String)"> |
| GetOrdinal(string) |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-19328/modules/platforms/dotnet/Apache.Ignite/Table/IgniteTuple.cs/#L84"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"><p>Gets the column ordinal given the name of the column, |
| or -1 when the column with the given name does not exist.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public int GetOrdinal(string name)</code></pre> |
| </div> |
| |
| <h4 class="section">Parameters</h4> |
| <dl class="parameters"> |
| <dt><code>name</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt> |
| <dd><p>Column name.</p> |
| </dd> |
| </dl> |
| |
| <h4 class="section">Returns</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt> |
| <dd><p>Column ordinal, or -1 when the column with the given name does not exist.</p> |
| </dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <a id="Apache_Ignite_Table_IgniteTuple_ToString_" data-uid="Apache.Ignite.Table.IgniteTuple.ToString*"></a> |
| |
| <h3 id="Apache_Ignite_Table_IgniteTuple_ToString" data-uid="Apache.Ignite.Table.IgniteTuple.ToString"> |
| ToString() |
| <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-19328/modules/platforms/dotnet/Apache.Ignite/Table/IgniteTuple.cs/#L87"><i class="bi bi-code-slash"></i></a> |
| </h3> |
| |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override string ToString()</code></pre> |
| </div> |
| |
| |
| <h4 class="section">Returns</h4> |
| <dl class="parameters"> |
| <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt> |
| <dd></dd> |
| </dl> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </article> |
| |
| <div class="contribution d-print-none"> |
| <a href="https://github.com/apache/ignite-3/blob/ignite-19328/modules/platforms/dotnet/Apache.Ignite/Table/IgniteTuple.cs/#L28" class="edit-link">Edit this page</a> |
| </div> |
| |
| |
| </div> |
| |
| <div class="affix"> |
| <nav id="affix"></nav> |
| </div> |
| </main> |
| |
| <div class="container-xxl search-results" id="search-results"></div> |
| |
| <footer class="border-top"> |
| <div class="container-xxl"> |
| <div class="flex-fill"> |
| Copyright 2023 The Apache Software Foundation |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
