releases/3.0.0/dotnetdoc/api/Apache.Ignite.Sql.IgniteDbDataReader.html (1,271 lines of code) (raw):

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>Class IgniteDbDataReader | Apache Ignite.NET API Documentation </title> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta name="title" content="Class IgniteDbDataReader | Apache Ignite.NET API Documentation "> <meta name="description" content="Reads a forward-only stream of rows from an Ignite result set."> <link rel="icon" href="../images/favicon.ico"> <link rel="stylesheet" href="../public/docfx.min.css"> <link rel="stylesheet" href="../public/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_Sql_IgniteDbDataReader.md&amp;value=---%0Auid%3A%20Apache.Ignite.Sql.IgniteDbDataReader%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A"> <meta name="loc:inThisArticle" content="In this article"> <meta name="loc:searchResultsCount" content="{count} results for &quot;{query}&quot;"> <meta name="loc:searchNoResults" content="No results for &quot;{query}&quot;"> <meta name="loc:tocFilter" content="Filter by title"> <meta name="loc:nextArticle" content="Next"> <meta name="loc:prevArticle" content="Previous"> <meta name="loc:themeLight" content="Light"> <meta name="loc:themeDark" content="Dark"> <meta name="loc:themeAuto" content="Auto"> <meta name="loc:changeTheme" content="Change theme"> <meta name="loc:copy" content="Copy"> <meta name="loc:downloadPdf" content="Download PDF"> <script type="module" src="./../public/docfx.min.js"></script> <script> const theme = localStorage.getItem('theme') || 'auto' document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme) </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" 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.Sql.IgniteDbDataReader"> <h1 id="Apache_Ignite_Sql_IgniteDbDataReader" data-uid="Apache.Ignite.Sql.IgniteDbDataReader" class="text-break"> Class IgniteDbDataReader <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L40"><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.Sql.html">Sql</a></dd></dl> <dl><dt>Assembly</dt><dd>Apache.Ignite.dll</dd></dl> </div> <div class="markdown summary"><p>Reads a forward-only stream of rows from an Ignite result set.</p> </div> <div class="markdown conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public sealed class IgniteDbDataReader : DbDataReader, IEnumerable, IDataReader, IDataRecord, IDisposable, IAsyncDisposable, IDbColumnSchemaGenerator</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><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.marshalbyrefobject">MarshalByRefObject</a></div> <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader">DbDataReader</a></div> <div><span class="xref">IgniteDbDataReader</span></div> </dd> </dl> <dl class="typelist implements"> <dt>Implements</dt> <dd> <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.ienumerable">IEnumerable</a></div> <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.idatareader">IDataReader</a></div> <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.idatarecord">IDataRecord</a></div> <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.idisposable">IDisposable</a></div> <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.iasyncdisposable">IAsyncDisposable</a></div> <div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.idbcolumnschemagenerator">IDbColumnSchemaGenerator</a></div> </dd> </dl> <dl class="typelist inheritedMembers"> <dt>Inherited Members</dt> <dd> <div> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader.getfieldvalueasync#system-data-common-dbdatareader-getfieldvalueasync-1(system-int32)">DbDataReader.GetFieldValueAsync&lt;T&gt;(int)</a> </div> <div> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader.getfieldvalueasync#system-data-common-dbdatareader-getfieldvalueasync-1(system-int32-system-threading-cancellationtoken)">DbDataReader.GetFieldValueAsync&lt;T&gt;(int, CancellationToken)</a> </div> <div> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader.getschematableasync">DbDataReader.GetSchemaTableAsync(CancellationToken)</a> </div> <div> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader.getcolumnschemaasync">DbDataReader.GetColumnSchemaAsync(CancellationToken)</a> </div> <div> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader.getstream">DbDataReader.GetStream(int)</a> </div> <div> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader.gettextreader">DbDataReader.GetTextReader(int)</a> </div> <div> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader.isdbnullasync#system-data-common-dbdatareader-isdbnullasync(system-int32)">DbDataReader.IsDBNullAsync(int)</a> </div> <div> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader.isdbnullasync#system-data-common-dbdatareader-isdbnullasync(system-int32-system-threading-cancellationtoken)">DbDataReader.IsDBNullAsync(int, CancellationToken)</a> </div> <div> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader.nextresultasync#system-data-common-dbdatareader-nextresultasync">DbDataReader.NextResultAsync()</a> </div> <div> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader.nextresultasync#system-data-common-dbdatareader-nextresultasync(system-threading-cancellationtoken)">DbDataReader.NextResultAsync(CancellationToken)</a> </div> <div> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader.readasync#system-data-common-dbdatareader-readasync">DbDataReader.ReadAsync()</a> </div> <div> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader.visiblefieldcount">DbDataReader.VisibleFieldCount</a> </div> <div> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.marshalbyrefobject.getlifetimeservice">MarshalByRefObject.GetLifetimeService()</a> </div> <div> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.marshalbyrefobject.initializelifetimeservice">MarshalByRefObject.InitializeLifetimeService()</a> </div> <div> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a> </div> <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.gethashcode">object.GetHashCode()</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="properties">Properties </h2> <a id="Apache_Ignite_Sql_IgniteDbDataReader_Depth_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.Depth*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_Depth" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.Depth"> Depth <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L89"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>Gets a value indicating the depth of nesting for the current row. Always zero in Ignite.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override int Depth { 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><p>The level of nesting.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_FieldCount_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.FieldCount*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_FieldCount" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.FieldCount"> FieldCount <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L74"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, gets the number of columns in the current row.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override 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><p>The number of columns in the current row.</p> </dd> </dl> <h4 class="section">Exceptions</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.notsupportedexception">NotSupportedException</a></dt> <dd><p>There is no current connection to an instance of SQL Server.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_HasRows_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.HasRows*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_HasRows" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.HasRows"> HasRows <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L80"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, gets a value that indicates whether this <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader">DbDataReader</a> contains one or more rows.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override bool HasRows { 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.boolean">bool</a></dt> <dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader">DbDataReader</a> contains one or more rows; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_IsClosed_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.IsClosed*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_IsClosed" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.IsClosed"> IsClosed <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L83"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, gets a value indicating whether the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader">DbDataReader</a> is closed.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override bool IsClosed { 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.boolean">bool</a></dt> <dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader">DbDataReader</a> is closed; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p> </dd> </dl> <h4 class="section">Exceptions</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.invalidoperationexception">InvalidOperationException</a></dt> <dd><p>The <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader">DbDataReader</a> is closed.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_Item_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.Item*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_Item_System_Int32_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.Item(System.Int32)"> this[int] <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L97"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, gets the value of the specified column as an instance of <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override object this[int ordinal] { get; }</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><p>The value of the specified column.</p> </dd> </dl> <h4 class="section">Exceptions</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.indexoutofrangeexception">IndexOutOfRangeException</a></dt> <dd><p>The column index is out of range.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_Item_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.Item*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_Item_System_String_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.Item(System.String)"> this[string] <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L100"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, gets the value of the specified column as an instance of <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override object this[string name] { get; }</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 name of the column.</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><p>The value of the specified column.</p> </dd> </dl> <h4 class="section">Exceptions</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.indexoutofrangeexception">IndexOutOfRangeException</a></dt> <dd><p>No column with the specified name was found.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_Metadata_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.Metadata*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_Metadata" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.Metadata"> Metadata <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L94"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>Gets Ignite-specific result set metadata.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public IResultSetMetadata Metadata { get; }</code></pre> </div> <h4 class="section">Property Value</h4> <dl class="parameters"> <dt><a class="xref" href="Apache.Ignite.Sql.IResultSetMetadata.html">IResultSetMetadata</a></dt> <dd></dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_RecordsAffected_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.RecordsAffected*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_RecordsAffected" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.RecordsAffected"> RecordsAffected <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L77"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, gets the number of rows changed, inserted, or deleted by execution of the SQL statement.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override int RecordsAffected { 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><p>The number of rows changed, inserted, or deleted. -1 for SELECT statements; 0 if no rows were affected or the statement failed.</p> </dd> </dl> <h2 class="section" id="methods">Methods </h2> <a id="Apache_Ignite_Sql_IgniteDbDataReader_Close_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.Close*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_Close" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.Close"> Close() <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L380"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>Closes the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader">DbDataReader</a> object.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override void Close()</code></pre> </div> <a id="Apache_Ignite_Sql_IgniteDbDataReader_CloseAsync_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.CloseAsync*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_CloseAsync" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.CloseAsync"> CloseAsync() <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L383"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>Asynchronously closes the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader">DbDataReader</a> object.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override Task CloseAsync()</code></pre> </div> <h4 class="section">Returns</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task">Task</a></dt> <dd><p>A task representing the asynchronous operation.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_Dispose_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.Dispose*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_Dispose_System_Boolean_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.Dispose(System.Boolean)"> Dispose(bool) <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L475"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>Releases the unmanaged resources used by the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader">DbDataReader</a> and optionally releases the managed resources.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">protected override void Dispose(bool disposing)</code></pre> </div> <h4 class="section">Parameters</h4> <dl class="parameters"> <dt><code>disposing</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt> <dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> to release managed and unmanaged resources; <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> to release only unmanaged resources.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_DisposeAsync_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.DisposeAsync*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_DisposeAsync" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.DisposeAsync"> DisposeAsync() <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L373"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>Asynchronously releases all resources used by the current instance of the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader">DbDataReader</a> class.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override ValueTask DisposeAsync()</code></pre> </div> <h4 class="section">Returns</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask">ValueTask</a></dt> <dd><p>A <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask">ValueTask</a> representing the asynchronous operation.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_GetBoolean_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetBoolean*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_GetBoolean_System_Int32_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetBoolean(System.Int32)"> GetBoolean(int) <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L110"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, gets the value of the specified column as a Boolean.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override bool GetBoolean(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>The 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.boolean">bool</a></dt> <dd><p>The value of the specified column.</p> </dd> </dl> <h4 class="section">Exceptions</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.indexoutofrangeexception">IndexOutOfRangeException</a></dt> <dd><p>The column index is out of range.</p> </dd> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.invalidcastexception">InvalidCastException</a></dt> <dd><p>The specified cast is not valid.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_GetByte_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetByte*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_GetByte_System_Int32_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetByte(System.Int32)"> GetByte(int) <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L113"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, gets the value of the specified column as a byte.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override byte GetByte(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>The 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.byte">byte</a></dt> <dd><p>The value of the specified column.</p> </dd> </dl> <h4 class="section">Exceptions</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.indexoutofrangeexception">IndexOutOfRangeException</a></dt> <dd><p>The column index is out of range.</p> </dd> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.invalidcastexception">InvalidCastException</a></dt> <dd><p>The specified cast is not valid.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_GetBytes_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetBytes*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_GetBytes_System_Int32_System_Int64_System_Byte___System_Int32_System_Int32_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetBytes(System.Int32,System.Int64,System.Byte[],System.Int32,System.Int32)"> GetBytes(int, long, byte[]?, int, int) <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L120"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, reads a specified number of bytes from the specified column starting at a specified index and writes them to a buffer starting at a specified position in the buffer.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override long GetBytes(int ordinal, long dataOffset, byte[]? buffer, int bufferOffset, int length)</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> <dt><code>dataOffset</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int64">long</a></dt> <dd><p>The index within the row from which to begin the read operation.</p> </dd> <dt><code>buffer</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">byte</a>[]</dt> <dd><p>The buffer into which to copy the data.</p> </dd> <dt><code>bufferOffset</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt> <dd><p>The index with the buffer to which the data will be copied.</p> </dd> <dt><code>length</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt> <dd><p>The maximum number of bytes to read.</p> </dd> </dl> <h4 class="section">Returns</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int64">long</a></dt> <dd><p>The actual number of bytes read.</p> </dd> </dl> <h4 class="section">Exceptions</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.indexoutofrangeexception">IndexOutOfRangeException</a></dt> <dd><p>The column index is out of range.</p> </dd> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.invalidcastexception">InvalidCastException</a></dt> <dd><p>The specified cast is not valid.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_GetChar_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetChar*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_GetChar_System_Int32_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetChar(System.Int32)"> GetChar(int) <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L154"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, gets the value of the specified column as a single character.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override char GetChar(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>The 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.char">char</a></dt> <dd><p>The value of the specified column.</p> </dd> </dl> <h4 class="section">Exceptions</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.indexoutofrangeexception">IndexOutOfRangeException</a></dt> <dd><p>The column index is out of range.</p> </dd> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.invalidcastexception">InvalidCastException</a></dt> <dd><p>The specified cast is not valid.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_GetChars_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetChars*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_GetChars_System_Int32_System_Int64_System_Char___System_Int32_System_Int32_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetChars(System.Int32,System.Int64,System.Char[],System.Int32,System.Int32)"> GetChars(int, long, char[]?, int, int) <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L157"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, reads a specified number of characters from a specified column starting at a specified index, and writes them to a buffer starting at a specified position.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override long GetChars(int ordinal, long dataOffset, char[]? buffer, int bufferOffset, int length)</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> <dt><code>dataOffset</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int64">long</a></dt> <dd><p>The index within the row from which to begin the read operation.</p> </dd> <dt><code>buffer</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.char">char</a>[]</dt> <dd><p>The buffer into which to copy the data.</p> </dd> <dt><code>bufferOffset</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt> <dd><p>The index with the buffer to which the data will be copied.</p> </dd> <dt><code>length</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt> <dd><p>The maximum number of characters to read.</p> </dd> </dl> <h4 class="section">Returns</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int64">long</a></dt> <dd><p>The actual number of characters read.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_GetColumnSchema_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetColumnSchema*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_GetColumnSchema" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetColumnSchema"> GetColumnSchema() <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L306"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>Gets the column schema (<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbcolumn">DbColumn</a> collection).</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public ReadOnlyCollection&lt;DbColumn&gt; GetColumnSchema()</code></pre> </div> <h4 class="section">Returns</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.objectmodel.readonlycollection-1">ReadOnlyCollection</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbcolumn">DbColumn</a>&gt;</dt> <dd><p>The column schema (<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbcolumn">DbColumn</a> collection).</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_GetDataTypeName_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetDataTypeName*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_GetDataTypeName_System_Int32_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetDataTypeName(System.Int32)"> GetDataTypeName(int) <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L190"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, gets name of the data type of the specified column.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override string GetDataTypeName(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>The 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>The name of the data type.</p> </dd> </dl> <h4 class="section">Exceptions</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.indexoutofrangeexception">IndexOutOfRangeException</a></dt> <dd><p>The column index is out of range.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_GetDateTime_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetDateTime*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_GetDateTime_System_Int32_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetDateTime(System.Int32)"> GetDateTime(int) <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L193"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, gets the value of the specified column as a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.datetime">DateTime</a> object.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override DateTime GetDateTime(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>The 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.datetime">DateTime</a></dt> <dd><p>The value of the specified column.</p> </dd> </dl> <h4 class="section">Exceptions</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.indexoutofrangeexception">IndexOutOfRangeException</a></dt> <dd><p>The column index is out of range.</p> </dd> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.invalidcastexception">InvalidCastException</a></dt> <dd><p>The specified cast is not valid.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_GetDecimal_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetDecimal*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_GetDecimal_System_Int32_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetDecimal(System.Int32)"> GetDecimal(int) <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L208"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, gets the value of the specified column as a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.decimal">decimal</a>.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override decimal GetDecimal(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>The 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.decimal">decimal</a></dt> <dd><p>The value of the specified column.</p> </dd> </dl> <h4 class="section">Exceptions</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.indexoutofrangeexception">IndexOutOfRangeException</a></dt> <dd><p>The column index is out of range.</p> </dd> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.invalidcastexception">InvalidCastException</a></dt> <dd><p>The specified cast is not valid.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_GetDouble_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetDouble*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_GetDouble_System_Int32_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetDouble(System.Int32)"> GetDouble(int) <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L218"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, gets the value of the specified column as a double-precision floating point number.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override double GetDouble(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>The 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.double">double</a></dt> <dd><p>The value of the specified column.</p> </dd> </dl> <h4 class="section">Exceptions</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.invalidcastexception">InvalidCastException</a></dt> <dd><p>The specified cast is not valid.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_GetEnumerator_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetEnumerator*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_GetEnumerator" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetEnumerator"> GetEnumerator() <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L303"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, returns an enumerator that can be used to iterate through the rows in the data reader.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override IEnumerator GetEnumerator()</code></pre> </div> <h4 class="section">Returns</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.ienumerator">IEnumerator</a></dt> <dd><p>An enumerator that can be used to iterate through the rows in the data reader.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_GetFieldType_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetFieldType*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_GetFieldType_System_Int32_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetFieldType(System.Int32)"> GetFieldType(int) <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L462"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, gets the data type of the specified column.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override Type GetFieldType(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>The 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.type">Type</a></dt> <dd><p>The data type of the specified column.</p> </dd> </dl> <h4 class="section">Exceptions</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.indexoutofrangeexception">IndexOutOfRangeException</a></dt> <dd><p>The column index is out of range.</p> </dd> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.invalidcastexception">InvalidCastException</a></dt> <dd><p>The specified cast is not valid.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_GetFieldValue_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetFieldValue*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_GetFieldValue__1_System_Int32_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetFieldValue``1(System.Int32)"> GetFieldValue&lt;T&gt;(int) <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L386"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>Gets the value of the specified column as the requested type.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override T GetFieldValue&lt;T&gt;(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>The zero-based column ordinal.</p> </dd> </dl> <h4 class="section">Returns</h4> <dl class="parameters"> <dt><span class="xref">T</span></dt> <dd><p>The value of the specified column.</p> </dd> </dl> <h4 class="section">Type Parameters</h4> <dl class="parameters"> <dt><code>T</code></dt> <dd><p>The type of the value to be returned.</p> </dd> </dl> <h4 class="section">Exceptions</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.invalidoperationexception">InvalidOperationException</a></dt> <dd><p>The connection was dropped or closed during data retrieval.</p> <p>-or-</p> <p>The data reader was closed during data retrieval.</p> <p>-or-</p> <p>There is no data ready to be read (for example, the first <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader.read">Read()</a> hasn't been called, or it returned <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>).</p> <p>-or-</p> <p>The reader tried to read a previously-read column in sequential mode.</p> <p>-or-</p> <p>There was an asynchronous operation in progress. This applies to all Get* methods when running in sequential mode, as they could be called while reading a stream.</p> </dd> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.indexoutofrangeexception">IndexOutOfRangeException</a></dt> <dd><p>The column index is out of range.</p> </dd> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.invalidcastexception">InvalidCastException</a></dt> <dd><p>The value returned by the database doesn't match or cannot be cast to <code class="typeparamref">T</code>.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_GetFloat_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetFloat*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_GetFloat_System_Int32_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetFloat(System.Int32)"> GetFloat(int) <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L225"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, gets the value of the specified column as a single-precision floating point number.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override float GetFloat(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>The 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.single">float</a></dt> <dd><p>The value of the specified column.</p> </dd> </dl> <h4 class="section">Exceptions</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.indexoutofrangeexception">IndexOutOfRangeException</a></dt> <dd><p>The column index is out of range.</p> </dd> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.invalidcastexception">InvalidCastException</a></dt> <dd><p>The specified cast is not valid.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_GetGuid_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetGuid*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_GetGuid_System_Int32_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetGuid(System.Int32)"> GetGuid(int) <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L232"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, gets the value of the specified column as a globally unique identifier (GUID).</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override Guid GetGuid(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>The 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.guid">Guid</a></dt> <dd><p>The value of the specified column.</p> </dd> </dl> <h4 class="section">Exceptions</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.indexoutofrangeexception">IndexOutOfRangeException</a></dt> <dd><p>The column index is out of range.</p> </dd> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.invalidcastexception">InvalidCastException</a></dt> <dd><p>The specified cast is not valid.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_GetInt16_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetInt16*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_GetInt16_System_Int32_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetInt16(System.Int32)"> GetInt16(int) <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L235"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, gets the value of the specified column as a 16-bit signed integer.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override short GetInt16(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>The 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.int16">short</a></dt> <dd><p>The value of the specified column.</p> </dd> </dl> <h4 class="section">Exceptions</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.indexoutofrangeexception">IndexOutOfRangeException</a></dt> <dd><p>The column index is out of range.</p> </dd> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.invalidcastexception">InvalidCastException</a></dt> <dd><p>The specified cast is not valid.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_GetInt32_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetInt32*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_GetInt32_System_Int32_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetInt32(System.Int32)"> GetInt32(int) <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L242"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, gets the value of the specified column as a 32-bit signed integer.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override int GetInt32(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>The 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.int32">int</a></dt> <dd><p>The value of the specified column.</p> </dd> </dl> <h4 class="section">Exceptions</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.indexoutofrangeexception">IndexOutOfRangeException</a></dt> <dd><p>The column index is out of range.</p> </dd> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.invalidcastexception">InvalidCastException</a></dt> <dd><p>The specified cast is not valid.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_GetInt64_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetInt64*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_GetInt64_System_Int32_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetInt64(System.Int32)"> GetInt64(int) <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L249"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, gets the value of the specified column as a 64-bit signed integer.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override long GetInt64(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>The 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.int64">long</a></dt> <dd><p>The value of the specified column.</p> </dd> </dl> <h4 class="section">Exceptions</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.indexoutofrangeexception">IndexOutOfRangeException</a></dt> <dd><p>The column index is out of range.</p> </dd> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.invalidcastexception">InvalidCastException</a></dt> <dd><p>The specified cast is not valid.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_GetName_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetName*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_GetName_System_Int32_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetName(System.Int32)"> GetName(int) <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L256"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, 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 override 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>The 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>The name of the specified column.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_GetOrdinal_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetOrdinal*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_GetOrdinal_System_String_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetOrdinal(System.String)"> GetOrdinal(string) <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L259"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, gets the column ordinal given the name of the column.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override 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>The name of the column.</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>The zero-based column ordinal.</p> </dd> </dl> <h4 class="section">Exceptions</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.indexoutofrangeexception">IndexOutOfRangeException</a></dt> <dd><p>The name specified is not a valid column name.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_GetSchemaTable_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetSchemaTable*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_GetSchemaTable" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetSchemaTable"> GetSchemaTable() <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L324"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>Returns a <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.datatable">DataTable</a> that describes the column metadata of the <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader">DbDataReader</a>. Returns <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/keywords/null">null</a> if the executed command returned no resultset, or after <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader.nextresult">NextResult()</a> returns <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override DataTable GetSchemaTable()</code></pre> </div> <h4 class="section">Returns</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.datatable">DataTable</a></dt> <dd><p>A <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.datatable">DataTable</a> that describes the column metadata.</p> </dd> </dl> <h4 class="section">Exceptions</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.invalidoperationexception">InvalidOperationException</a></dt> <dd><p>The <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbdatareader">DbDataReader</a> is closed.</p> </dd> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.indexoutofrangeexception">IndexOutOfRangeException</a></dt> <dd><p>The column index is out of range.</p> </dd> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.notsupportedexception">NotSupportedException</a></dt> <dd><p>.NET Core and .NET 5+ only: In all cases.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_GetString_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetString*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_GetString_System_Int32_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetString(System.Int32)"> GetString(int) <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L262"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, gets the value of the specified column as an instance of <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override string GetString(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>The 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>The value of the specified column.</p> </dd> </dl> <h4 class="section">Exceptions</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.indexoutofrangeexception">IndexOutOfRangeException</a></dt> <dd><p>The column index is out of range.</p> </dd> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.invalidcastexception">InvalidCastException</a></dt> <dd><p>The specified cast is not valid.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_GetValue_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetValue*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_GetValue_System_Int32_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetValue(System.Int32)"> GetValue(int) <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L265"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, gets the value of the specified column as an instance of <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override object GetValue(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>The 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.object">object</a></dt> <dd><p>The value of the specified column.</p> </dd> </dl> <h4 class="section">Exceptions</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.indexoutofrangeexception">IndexOutOfRangeException</a></dt> <dd><p>The column index is out of range.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_GetValues_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetValues*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_GetValues_System_Object___" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.GetValues(System.Object[])"> GetValues(object[]) <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L273"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, populates an array of objects with the column values of the current row.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override int GetValues(object[] values)</code></pre> </div> <h4 class="section">Parameters</h4> <dl class="parameters"> <dt><code>values</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a>[]</dt> <dd><p>An array of <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a> into which to copy the attribute columns.</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>The number of instances of <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a> in the array.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_IsDBNull_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.IsDBNull*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_IsDBNull_System_Int32_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.IsDBNull(System.Int32)"> IsDBNull(int) <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L291"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, gets a value that indicates whether the column contains nonexistent or missing values.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override bool IsDBNull(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>The 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.boolean">bool</a></dt> <dd><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if the specified column is equivalent to <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.dbnull">DBNull</a>; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p> </dd> </dl> <h4 class="section">Exceptions</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.indexoutofrangeexception">IndexOutOfRangeException</a></dt> <dd><p>The column index is out of range.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_NextResult_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.NextResult*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_NextResult" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.NextResult"> NextResult() <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L294"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, advances the reader to the next result when reading the results of a batch of statements.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override bool NextResult()</code></pre> </div> <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><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if there are more result sets; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_Read_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.Read*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_Read" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.Read"> Read() <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L297"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>When overridden in a derived class, advances the reader to the next record in a result set.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override bool Read()</code></pre> </div> <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><p><a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if there are more rows; otherwise, <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a>.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_ReadAsync_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.ReadAsync*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_ReadAsync_System_Threading_CancellationToken_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.ReadAsync(System.Threading.CancellationToken)"> ReadAsync(CancellationToken) <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L300"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>Asynchronously advances the reader to the next record in a result set.</p> </div> <div class="markdown level1 conceptual"></div> <div class="codewrapper"> <pre><code class="lang-csharp hljs">public override Task&lt;bool&gt; ReadAsync(CancellationToken cancellationToken)</code></pre> </div> <h4 class="section">Parameters</h4> <dl class="parameters"> <dt><code>cancellationToken</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</a></dt> <dd><p>The cancellation instruction.</p> </dd> </dl> <h4 class="section">Returns</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a>&gt;</dt> <dd><p>A <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task&lt;TResult&gt;</a> whose <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1.result">Result</a> property is <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">true</a> if there are more rows or <a href="https://learn.microsoft.com/dotnet/csharp/language-reference/builtin-types/bool">false</a> if there aren't.</p> </dd> </dl> <h4 class="section">Exceptions</h4> <dl class="parameters"> <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.data.common.dbexception">DbException</a></dt> <dd><p>An error occurred while executing the command text.</p> </dd> </dl> <a id="Apache_Ignite_Sql_IgniteDbDataReader_ToString_" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.ToString*"></a> <h3 id="Apache_Ignite_Sql_IgniteDbDataReader_ToString" data-uid="Apache.Ignite.Sql.IgniteDbDataReader.ToString"> ToString() <a class="header-action link-secondary" title="View source" href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L465"><i class="bi bi-code-slash"></i></a> </h3> <div class="markdown level1 summary"><p>Returns a string that represents the current object.</p> </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><p>A string that represents the current object.</p> </dd> </dl> </article> <div class="contribution d-print-none"> <a href="https://github.com/apache/ignite-3/blob/ignite-3.0/modules/platforms/dotnet/Apache.Ignite/Sql/IgniteDbDataReader.cs/#L40" 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 text-secondary"> <div class="container-xxl"> <div class="flex-fill"> Copyright 2023 The Apache Software Foundation </div> </div> </footer> </body> </html>