This is an automated email from the ASF dual-hosted git repository.
github-actions[bot] pushed a commit to branch asf-site
in repository https://gitbox.apache.org/repos/asf/arrow-dotnet.git
The following commit(s) were added to refs/heads/asf-site by this push:
new acaed9b Update docs for 862f3fc3e76dcd563ddef662758cdf2f8d6b51b0
acaed9b is described below
commit acaed9b30b7919ae192b22343d6d692698485279
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Sun Sep 13 23:51:09 2026 +0000
Update docs for 862f3fc3e76dcd563ddef662758cdf2f8d6b51b0
---
main/api/Apache.Arrow.Ipc.ArrowFileReader.html | 46 +++
main/api/Apache.Arrow.Ipc.ArrowFileWriter.html | 85 +-----
main/api/Apache.Arrow.Ipc.ArrowStreamReader.html | 117 ++++++--
main/api/Apache.Arrow.Ipc.ArrowStreamWriter.html | 89 +++++-
.../Apache.Arrow.Ipc.RecordBatchWithMetadata.html | 311 +++++++++++++++++++++
main/api/Apache.Arrow.Ipc.html | 9 +
main/api/toc.html | 3 +
main/api/toc.json | 2 +-
main/index.json | 15 +-
main/manifest.json | 14 +
main/xrefmap.yml | 153 ++++++++--
11 files changed, 712 insertions(+), 132 deletions(-)
diff --git a/main/api/Apache.Arrow.Ipc.ArrowFileReader.html
b/main/api/Apache.Arrow.Ipc.ArrowFileReader.html
index 844b737..dc63d50 100644
--- a/main/api/Apache.Arrow.Ipc.ArrowFileReader.html
+++ b/main/api/Apache.Arrow.Ipc.ArrowFileReader.html
@@ -148,6 +148,12 @@ Class ArrowFileReader <a class="header-action
link-secondary" title="View sourc
<div>
<a class="xref"
href="Apache.Arrow.Ipc.ArrowStreamReader.html#Apache_Arrow_Ipc_ArrowStreamReader_ReadNextRecordBatch">ArrowStreamReader.ReadNextRecordBatch()</a>
</div>
+ <div>
+ <a class="xref"
href="Apache.Arrow.Ipc.ArrowStreamReader.html#Apache_Arrow_Ipc_ArrowStreamReader_ReadNextRecordBatchWithCustomMetadataAsync_System_Threading_CancellationToken_">ArrowStreamReader.ReadNextRecordBatchWithCustomMetadataAsync(CancellationToken)</a>
+ </div>
+ <div>
+ <a class="xref"
href="Apache.Arrow.Ipc.ArrowStreamReader.html#Apache_Arrow_Ipc_ArrowStreamReader_ReadNextRecordBatchWithCustomMetadata">ArrowStreamReader.ReadNextRecordBatchWithCustomMetadata()</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>
@@ -565,6 +571,46 @@ Class ArrowFileReader <a class="header-action
link-secondary" title="View sourc
+ <a
id="Apache_Arrow_Ipc_ArrowFileReader_ReadRecordBatchWithCustomMetadataAsync_"
data-uid="Apache.Arrow.Ipc.ArrowFileReader.ReadRecordBatchWithCustomMetadataAsync*"></a>
+
+ <h3
id="Apache_Arrow_Ipc_ArrowFileReader_ReadRecordBatchWithCustomMetadataAsync_System_Int32_System_Threading_CancellationToken_"
data-uid="Apache.Arrow.Ipc.ArrowFileReader.ReadRecordBatchWithCustomMetadataAsync(System.Int32,System.Threading.CancellationToken)">
+ ReadRecordBatchWithCustomMetadataAsync(int, CancellationToken)
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowFileReader.cs/#L93"><i
class="bi bi-code-slash"></i></a>
+ </h3>
+
+ <div class="markdown level1 summary"><p>Reads the record batch at the given
index together with the custom metadata on its
+IPC Message, which is null if the message carried none.</p>
+</div>
+ <div class="markdown level1 conceptual"></div>
+
+ <div class="codewrapper">
+ <pre><code class="lang-csharp hljs">public
ValueTask<RecordBatchWithMetadata>
ReadRecordBatchWithCustomMetadataAsync(int index, CancellationToken
cancellationToken = default)</code></pre>
+ </div>
+
+ <h4 class="section">Parameters</h4>
+ <dl class="parameters">
+ <dt><code>index</code> <a class="xref"
href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></dt>
+ <dd></dd>
+ <dt><code>cancellationToken</code> <a class="xref"
href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</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.threading.tasks.valuetask-1">ValueTask</a><<a
class="xref"
href="Apache.Arrow.Ipc.RecordBatchWithMetadata.html">RecordBatchWithMetadata</a>></dt>
+ <dd></dd>
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
<a id="Apache_Arrow_Ipc_ArrowFileReader_RecordBatchCountAsync_"
data-uid="Apache.Arrow.Ipc.ArrowFileReader.RecordBatchCountAsync*"></a>
<h3 id="Apache_Arrow_Ipc_ArrowFileReader_RecordBatchCountAsync"
data-uid="Apache.Arrow.Ipc.ArrowFileReader.RecordBatchCountAsync">
diff --git a/main/api/Apache.Arrow.Ipc.ArrowFileWriter.html
b/main/api/Apache.Arrow.Ipc.ArrowFileWriter.html
index d989d01..e9e54a0 100644
--- a/main/api/Apache.Arrow.Ipc.ArrowFileWriter.html
+++ b/main/api/Apache.Arrow.Ipc.ArrowFileWriter.html
@@ -136,6 +136,18 @@ Class ArrowFileWriter <a class="header-action
link-secondary" title="View sourc
<div>
<a class="xref"
href="Apache.Arrow.Ipc.ArrowStreamWriter.html#Apache_Arrow_Ipc_ArrowStreamWriter_Schema">ArrowStreamWriter.Schema</a>
</div>
+ <div>
+ <a class="xref"
href="Apache.Arrow.Ipc.ArrowStreamWriter.html#Apache_Arrow_Ipc_ArrowStreamWriter_WriteRecordBatch_Apache_Arrow_RecordBatch_">ArrowStreamWriter.WriteRecordBatch(RecordBatch)</a>
+ </div>
+ <div>
+ <a class="xref"
href="Apache.Arrow.Ipc.ArrowStreamWriter.html#Apache_Arrow_Ipc_ArrowStreamWriter_WriteRecordBatch_Apache_Arrow_RecordBatch_System_Collections_Generic_IReadOnlyDictionary_System_String_System_String__">ArrowStreamWriter.WriteRecordBatch(RecordBatch,
IReadOnlyDictionary<string, string>)</a>
+ </div>
+ <div>
+ <a class="xref"
href="Apache.Arrow.Ipc.ArrowStreamWriter.html#Apache_Arrow_Ipc_ArrowStreamWriter_WriteRecordBatchAsync_Apache_Arrow_RecordBatch_System_Threading_CancellationToken_">ArrowStreamWriter.WriteRecordBatchAsync(RecordBatch,
CancellationToken)</a>
+ </div>
+ <div>
+ <a class="xref"
href="Apache.Arrow.Ipc.ArrowStreamWriter.html#Apache_Arrow_Ipc_ArrowStreamWriter_WriteRecordBatchAsync_Apache_Arrow_RecordBatch_System_Collections_Generic_IReadOnlyDictionary_System_String_System_String__System_Threading_CancellationToken_">ArrowStreamWriter.WriteRecordBatchAsync(RecordBatch,
IReadOnlyDictionary<string, string>, CancellationToken)</a>
+ </div>
<div>
<a class="xref"
href="Apache.Arrow.Ipc.ArrowStreamWriter.html#Apache_Arrow_Ipc_ArrowStreamWriter_WriteStart">ArrowStreamWriter.WriteStart()</a>
</div>
@@ -330,79 +342,6 @@ Class ArrowFileWriter <a class="header-action
link-secondary" title="View sourc
- <h2 class="section" id="methods">Methods
-</h2>
-
-
- <a id="Apache_Arrow_Ipc_ArrowFileWriter_WriteRecordBatch_"
data-uid="Apache.Arrow.Ipc.ArrowFileWriter.WriteRecordBatch*"></a>
-
- <h3
id="Apache_Arrow_Ipc_ArrowFileWriter_WriteRecordBatch_Apache_Arrow_RecordBatch_"
data-uid="Apache.Arrow.Ipc.ArrowFileWriter.WriteRecordBatch(Apache.Arrow.RecordBatch)">
- WriteRecordBatch(RecordBatch)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowFileWriter.cs/#L69"><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 void
WriteRecordBatch(RecordBatch recordBatch)</code></pre>
- </div>
-
- <h4 class="section">Parameters</h4>
- <dl class="parameters">
- <dt><code>recordBatch</code> <a class="xref"
href="Apache.Arrow.RecordBatch.html">RecordBatch</a></dt>
- <dd></dd>
- </dl>
-
-
-
-
-
-
-
-
-
-
-
-
- <a id="Apache_Arrow_Ipc_ArrowFileWriter_WriteRecordBatchAsync_"
data-uid="Apache.Arrow.Ipc.ArrowFileWriter.WriteRecordBatchAsync*"></a>
-
- <h3
id="Apache_Arrow_Ipc_ArrowFileWriter_WriteRecordBatchAsync_Apache_Arrow_RecordBatch_System_Threading_CancellationToken_"
data-uid="Apache.Arrow.Ipc.ArrowFileWriter.WriteRecordBatchAsync(Apache.Arrow.RecordBatch,System.Threading.CancellationToken)">
- WriteRecordBatchAsync(RecordBatch, CancellationToken)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowFileWriter.cs/#L78"><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 Task
WriteRecordBatchAsync(RecordBatch recordBatch, CancellationToken
cancellationToken = default)</code></pre>
- </div>
-
- <h4 class="section">Parameters</h4>
- <dl class="parameters">
- <dt><code>recordBatch</code> <a class="xref"
href="Apache.Arrow.RecordBatch.html">RecordBatch</a></dt>
- <dd></dd>
- <dt><code>cancellationToken</code> <a class="xref"
href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</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.threading.tasks.task">Task</a></dt>
- <dd></dd>
- </dl>
-
-
-
-
-
-
-
-
-
-
-
</article>
diff --git a/main/api/Apache.Arrow.Ipc.ArrowStreamReader.html
b/main/api/Apache.Arrow.Ipc.ArrowStreamReader.html
index 591eb5f..2249c2d 100644
--- a/main/api/Apache.Arrow.Ipc.ArrowStreamReader.html
+++ b/main/api/Apache.Arrow.Ipc.ArrowStreamReader.html
@@ -89,7 +89,7 @@
<h1 id="Apache_Arrow_Ipc_ArrowStreamReader"
data-uid="Apache.Arrow.Ipc.ArrowStreamReader" class="text-break">
-Class ArrowStreamReader <a class="header-action link-secondary" title="View
source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L27"><i
class="bi bi-code-slash"></i></a>
+Class ArrowStreamReader <a class="header-action link-secondary" title="View
source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L28"><i
class="bi bi-code-slash"></i></a>
</h1>
<div class="facts text-secondary">
@@ -171,7 +171,7 @@ Class ArrowStreamReader <a class="header-action
link-secondary" title="View sou
<h3
id="Apache_Arrow_Ipc_ArrowStreamReader__ctor_Apache_Arrow_ArrowContext_System_IO_Stream_System_Boolean_"
data-uid="Apache.Arrow.Ipc.ArrowStreamReader.#ctor(Apache.Arrow.ArrowContext,System.IO.Stream,System.Boolean)">
ArrowStreamReader(ArrowContext, Stream, bool)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L74"><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L75"><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -206,7 +206,7 @@ Class ArrowStreamReader <a class="header-action
link-secondary" title="View sou
<h3
id="Apache_Arrow_Ipc_ArrowStreamReader__ctor_Apache_Arrow_ArrowContext_System_ReadOnlyMemory_System_Byte__"
data-uid="Apache.Arrow.Ipc.ArrowStreamReader.#ctor(Apache.Arrow.ArrowContext,System.ReadOnlyMemory{System.Byte})">
ArrowStreamReader(ArrowContext, ReadOnlyMemory<byte>)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L94"><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L95"><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -239,7 +239,7 @@ Class ArrowStreamReader <a class="header-action
link-secondary" title="View sou
<h3 id="Apache_Arrow_Ipc_ArrowStreamReader__ctor_System_IO_Stream_"
data-uid="Apache.Arrow.Ipc.ArrowStreamReader.#ctor(System.IO.Stream)">
ArrowStreamReader(Stream)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L36"><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L37"><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -270,7 +270,7 @@ Class ArrowStreamReader <a class="header-action
link-secondary" title="View sou
<h3
id="Apache_Arrow_Ipc_ArrowStreamReader__ctor_System_IO_Stream_Apache_Arrow_Ipc_ICompressionCodecFactory_"
data-uid="Apache.Arrow.Ipc.ArrowStreamReader.#ctor(System.IO.Stream,Apache.Arrow.Ipc.ICompressionCodecFactory)">
ArrowStreamReader(Stream, ICompressionCodecFactory)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L46"><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L47"><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -303,7 +303,7 @@ Class ArrowStreamReader <a class="header-action
link-secondary" title="View sou
<h3
id="Apache_Arrow_Ipc_ArrowStreamReader__ctor_System_IO_Stream_Apache_Arrow_Ipc_ICompressionCodecFactory_System_Boolean_"
data-uid="Apache.Arrow.Ipc.ArrowStreamReader.#ctor(System.IO.Stream,Apache.Arrow.Ipc.ICompressionCodecFactory,System.Boolean)">
ArrowStreamReader(Stream, ICompressionCodecFactory, bool)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L61"><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L62"><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -338,7 +338,7 @@ Class ArrowStreamReader <a class="header-action
link-secondary" title="View sou
<h3
id="Apache_Arrow_Ipc_ArrowStreamReader__ctor_System_IO_Stream_Apache_Arrow_Memory_MemoryAllocator_"
data-uid="Apache.Arrow.Ipc.ArrowStreamReader.#ctor(System.IO.Stream,Apache.Arrow.Memory.MemoryAllocator)">
ArrowStreamReader(Stream, MemoryAllocator)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L41"><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L42"><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -371,7 +371,7 @@ Class ArrowStreamReader <a class="header-action
link-secondary" title="View sou
<h3
id="Apache_Arrow_Ipc_ArrowStreamReader__ctor_System_IO_Stream_Apache_Arrow_Memory_MemoryAllocator_Apache_Arrow_Ipc_ICompressionCodecFactory_System_Boolean_"
data-uid="Apache.Arrow.Ipc.ArrowStreamReader.#ctor(System.IO.Stream,Apache.Arrow.Memory.MemoryAllocator,Apache.Arrow.Ipc.ICompressionCodecFactory,System.Boolean)">
ArrowStreamReader(Stream, MemoryAllocator, ICompressionCodecFactory, bool)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L66"><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L67"><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -408,7 +408,7 @@ Class ArrowStreamReader <a class="header-action
link-secondary" title="View sou
<h3
id="Apache_Arrow_Ipc_ArrowStreamReader__ctor_System_IO_Stream_Apache_Arrow_Memory_MemoryAllocator_System_Boolean_"
data-uid="Apache.Arrow.Ipc.ArrowStreamReader.#ctor(System.IO.Stream,Apache.Arrow.Memory.MemoryAllocator,System.Boolean)">
ArrowStreamReader(Stream, MemoryAllocator, bool)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L56"><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L57"><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -443,7 +443,7 @@ Class ArrowStreamReader <a class="header-action
link-secondary" title="View sou
<h3
id="Apache_Arrow_Ipc_ArrowStreamReader__ctor_System_IO_Stream_System_Boolean_"
data-uid="Apache.Arrow.Ipc.ArrowStreamReader.#ctor(System.IO.Stream,System.Boolean)">
ArrowStreamReader(Stream, bool)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L51"><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L52"><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -476,7 +476,7 @@ Class ArrowStreamReader <a class="header-action
link-secondary" title="View sou
<h3
id="Apache_Arrow_Ipc_ArrowStreamReader__ctor_System_ReadOnlyMemory_System_Byte__"
data-uid="Apache.Arrow.Ipc.ArrowStreamReader.#ctor(System.ReadOnlyMemory{System.Byte})">
ArrowStreamReader(ReadOnlyMemory<byte>)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L84"><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L85"><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -507,7 +507,7 @@ Class ArrowStreamReader <a class="header-action
link-secondary" title="View sou
<h3
id="Apache_Arrow_Ipc_ArrowStreamReader__ctor_System_ReadOnlyMemory_System_Byte__Apache_Arrow_Ipc_ICompressionCodecFactory_"
data-uid="Apache.Arrow.Ipc.ArrowStreamReader.#ctor(System.ReadOnlyMemory{System.Byte},Apache.Arrow.Ipc.ICompressionCodecFactory)">
ArrowStreamReader(ReadOnlyMemory<byte>, ICompressionCodecFactory)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L89"><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L90"><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -544,7 +544,7 @@ Class ArrowStreamReader <a class="header-action
link-secondary" title="View sou
<h3 id="Apache_Arrow_Ipc_ArrowStreamReader_Schema"
data-uid="Apache.Arrow.Ipc.ArrowStreamReader.Schema">
Schema
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L34"><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L35"><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>May block if the schema hasn't yet
been read. To avoid blocking, use GetSchemaAsync.</p>
@@ -580,7 +580,7 @@ Class ArrowStreamReader <a class="header-action
link-secondary" title="View sou
<h3 id="Apache_Arrow_Ipc_ArrowStreamReader_Dispose"
data-uid="Apache.Arrow.Ipc.ArrowStreamReader.Dispose">
Dispose()
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L122"><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L123"><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -606,7 +606,7 @@ Class ArrowStreamReader <a class="header-action
link-secondary" title="View sou
<h3 id="Apache_Arrow_Ipc_ArrowStreamReader_Dispose_System_Boolean_"
data-uid="Apache.Arrow.Ipc.ArrowStreamReader.Dispose(System.Boolean)">
Dispose(bool)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L128"><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L129"><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -637,7 +637,7 @@ Class ArrowStreamReader <a class="header-action
link-secondary" title="View sou
<h3
id="Apache_Arrow_Ipc_ArrowStreamReader_GetSchema_System_Threading_CancellationToken_"
data-uid="Apache.Arrow.Ipc.ArrowStreamReader.GetSchema(System.Threading.CancellationToken)">
GetSchema(CancellationToken)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L136"><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L137"><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -673,7 +673,7 @@ Class ArrowStreamReader <a class="header-action
link-secondary" title="View sou
<h3 id="Apache_Arrow_Ipc_ArrowStreamReader_ReadNextRecordBatch"
data-uid="Apache.Arrow.Ipc.ArrowStreamReader.ReadNextRecordBatch">
ReadNextRecordBatch()
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L150"><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L151"><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -704,7 +704,7 @@ Class ArrowStreamReader <a class="header-action
link-secondary" title="View sou
<h3
id="Apache_Arrow_Ipc_ArrowStreamReader_ReadNextRecordBatchAsync_System_Threading_CancellationToken_"
data-uid="Apache.Arrow.Ipc.ArrowStreamReader.ReadNextRecordBatchAsync(System.Threading.CancellationToken)">
ReadNextRecordBatchAsync(CancellationToken)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L145"><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L146"><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -736,11 +736,90 @@ Class ArrowStreamReader <a class="header-action
link-secondary" title="View sou
+ <a
id="Apache_Arrow_Ipc_ArrowStreamReader_ReadNextRecordBatchWithCustomMetadata_"
data-uid="Apache.Arrow.Ipc.ArrowStreamReader.ReadNextRecordBatchWithCustomMetadata*"></a>
+
+ <h3
id="Apache_Arrow_Ipc_ArrowStreamReader_ReadNextRecordBatchWithCustomMetadata"
data-uid="Apache.Arrow.Ipc.ArrowStreamReader.ReadNextRecordBatchWithCustomMetadata">
+ ReadNextRecordBatchWithCustomMetadata()
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L183"><i
class="bi bi-code-slash"></i></a>
+ </h3>
+
+ <div class="markdown level1 summary"><p>Reads the next record batch together
with the custom metadata on its IPC Message,
+the counterpart of <a class="xref"
href="Apache.Arrow.Ipc.ArrowStreamWriter.html#Apache_Arrow_Ipc_ArrowStreamWriter_WriteRecordBatch_Apache_Arrow_RecordBatch_System_Collections_Generic_IReadOnlyDictionary_System_String_System_String__">WriteRecordBatch(RecordBatch,
IReadOnlyDictionary<string, string>)</a>.</p>
+</div>
+ <div class="markdown level1 conceptual"></div>
+
+ <div class="codewrapper">
+ <pre><code class="lang-csharp hljs">public RecordBatchWithMetadata
ReadNextRecordBatchWithCustomMetadata()</code></pre>
+ </div>
+
+
+ <h4 class="section">Returns</h4>
+ <dl class="parameters">
+ <dt><a class="xref"
href="Apache.Arrow.Ipc.RecordBatchWithMetadata.html">RecordBatchWithMetadata</a></dt>
+ <dd><p>The record batch and its custom metadata. At the end of the stream
both
+<a class="xref"
href="Apache.Arrow.Ipc.RecordBatchWithMetadata.html#Apache_Arrow_Ipc_RecordBatchWithMetadata_Batch">Batch</a>
and
+<a class="xref"
href="Apache.Arrow.Ipc.RecordBatchWithMetadata.html#Apache_Arrow_Ipc_RecordBatchWithMetadata_CustomMetadata">CustomMetadata</a>
are null; the metadata is also
+null for a batch whose message carried none.</p>
+</dd>
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ <a
id="Apache_Arrow_Ipc_ArrowStreamReader_ReadNextRecordBatchWithCustomMetadataAsync_"
data-uid="Apache.Arrow.Ipc.ArrowStreamReader.ReadNextRecordBatchWithCustomMetadataAsync*"></a>
+
+ <h3
id="Apache_Arrow_Ipc_ArrowStreamReader_ReadNextRecordBatchWithCustomMetadataAsync_System_Threading_CancellationToken_"
data-uid="Apache.Arrow.Ipc.ArrowStreamReader.ReadNextRecordBatchWithCustomMetadataAsync(System.Threading.CancellationToken)">
+ ReadNextRecordBatchWithCustomMetadataAsync(CancellationToken)
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L166"><i
class="bi bi-code-slash"></i></a>
+ </h3>
+
+ <div class="markdown level1 summary"><p>Reads the next record batch together
with the custom metadata on its IPC Message,
+the counterpart of <a class="xref"
href="Apache.Arrow.Ipc.ArrowStreamWriter.html#Apache_Arrow_Ipc_ArrowStreamWriter_WriteRecordBatch_Apache_Arrow_RecordBatch_System_Collections_Generic_IReadOnlyDictionary_System_String_System_String__">WriteRecordBatch(RecordBatch,
IReadOnlyDictionary<string, string>)</a>.</p>
+</div>
+ <div class="markdown level1 conceptual"></div>
+
+ <div class="codewrapper">
+ <pre><code class="lang-csharp hljs">public
ValueTask<RecordBatchWithMetadata>
ReadNextRecordBatchWithCustomMetadataAsync(CancellationToken cancellationToken
= default)</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></dd>
+ </dl>
+
+ <h4 class="section">Returns</h4>
+ <dl class="parameters">
+ <dt><a class="xref"
href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.valuetask-1">ValueTask</a><<a
class="xref"
href="Apache.Arrow.Ipc.RecordBatchWithMetadata.html">RecordBatchWithMetadata</a>></dt>
+ <dd><p>The record batch and its custom metadata. At the end of the stream
both
+<a class="xref"
href="Apache.Arrow.Ipc.RecordBatchWithMetadata.html#Apache_Arrow_Ipc_RecordBatchWithMetadata_Batch">Batch</a>
and
+<a class="xref"
href="Apache.Arrow.Ipc.RecordBatchWithMetadata.html#Apache_Arrow_Ipc_RecordBatchWithMetadata_CustomMetadata">CustomMetadata</a>
are null; the metadata is also
+null for a batch whose message carried none.</p>
+</dd>
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
</article>
<div class="contribution d-print-none">
- <a
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L27"
class="edit-link">Edit this page</a>
+ <a
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamReader.cs/#L28"
class="edit-link">Edit this page</a>
</div>
diff --git a/main/api/Apache.Arrow.Ipc.ArrowStreamWriter.html
b/main/api/Apache.Arrow.Ipc.ArrowStreamWriter.html
index f7da36d..bfdacba 100644
--- a/main/api/Apache.Arrow.Ipc.ArrowStreamWriter.html
+++ b/main/api/Apache.Arrow.Ipc.ArrowStreamWriter.html
@@ -413,7 +413,7 @@ Class ArrowStreamWriter <a class="header-action
link-secondary" title="View sou
<h3
id="Apache_Arrow_Ipc_ArrowStreamWriter_CalculatePadding_System_Int64_System_Int32_"
data-uid="Apache.Arrow.Ipc.ArrowStreamWriter.CalculatePadding(System.Int64,System.Int32)">
CalculatePadding(long, int)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamWriter.cs/#L1453"><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamWriter.cs/#L1525"><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -451,7 +451,7 @@ Class ArrowStreamWriter <a class="header-action
link-secondary" title="View sou
<h3 id="Apache_Arrow_Ipc_ArrowStreamWriter_Dispose"
data-uid="Apache.Arrow.Ipc.ArrowStreamWriter.Dispose">
Dispose()
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamWriter.cs/#L1489"><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamWriter.cs/#L1561"><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -477,7 +477,7 @@ Class ArrowStreamWriter <a class="header-action
link-secondary" title="View sou
<h3 id="Apache_Arrow_Ipc_ArrowStreamWriter_WriteEnd"
data-uid="Apache.Arrow.Ipc.ArrowStreamWriter.WriteEnd">
WriteEnd()
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamWriter.cs/#L1158"><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamWriter.cs/#L1189"><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -503,7 +503,7 @@ Class ArrowStreamWriter <a class="header-action
link-secondary" title="View sou
<h3
id="Apache_Arrow_Ipc_ArrowStreamWriter_WriteEndAsync_System_Threading_CancellationToken_"
data-uid="Apache.Arrow.Ipc.ArrowStreamWriter.WriteEndAsync(System.Threading.CancellationToken)">
WriteEndAsync(CancellationToken)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamWriter.cs/#L1167"><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamWriter.cs/#L1198"><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -539,7 +539,7 @@ Class ArrowStreamWriter <a class="header-action
link-secondary" title="View sou
<h3
id="Apache_Arrow_Ipc_ArrowStreamWriter_WriteRecordBatch_Apache_Arrow_RecordBatch_"
data-uid="Apache.Arrow.Ipc.ArrowStreamWriter.WriteRecordBatch(Apache.Arrow.RecordBatch)">
WriteRecordBatch(RecordBatch)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamWriter.cs/#L1130"><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamWriter.cs/#L1151"><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -566,11 +566,84 @@ Class ArrowStreamWriter <a class="header-action
link-secondary" title="View sou
+ <a id="Apache_Arrow_Ipc_ArrowStreamWriter_WriteRecordBatch_"
data-uid="Apache.Arrow.Ipc.ArrowStreamWriter.WriteRecordBatch*"></a>
+
+ <h3
id="Apache_Arrow_Ipc_ArrowStreamWriter_WriteRecordBatch_Apache_Arrow_RecordBatch_System_Collections_Generic_IReadOnlyDictionary_System_String_System_String__"
data-uid="Apache.Arrow.Ipc.ArrowStreamWriter.WriteRecordBatch(Apache.Arrow.RecordBatch,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String})">
+ WriteRecordBatch(RecordBatch, IReadOnlyDictionary<string, string>)
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamWriter.cs/#L1156"><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 virtual void
WriteRecordBatch(RecordBatch recordBatch, IReadOnlyDictionary<string,
string> customMetadata)</code></pre>
+ </div>
+
+ <h4 class="section">Parameters</h4>
+ <dl class="parameters">
+ <dt><code>recordBatch</code> <a class="xref"
href="Apache.Arrow.RecordBatch.html">RecordBatch</a></dt>
+ <dd></dd>
+ <dt><code>customMetadata</code> <a class="xref"
href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlydictionary-2">IReadOnlyDictionary</a><<a
class="xref"
href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a
class="xref"
href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
+ <dd></dd>
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+
+ <a id="Apache_Arrow_Ipc_ArrowStreamWriter_WriteRecordBatchAsync_"
data-uid="Apache.Arrow.Ipc.ArrowStreamWriter.WriteRecordBatchAsync*"></a>
+
+ <h3
id="Apache_Arrow_Ipc_ArrowStreamWriter_WriteRecordBatchAsync_Apache_Arrow_RecordBatch_System_Collections_Generic_IReadOnlyDictionary_System_String_System_String__System_Threading_CancellationToken_"
data-uid="Apache.Arrow.Ipc.ArrowStreamWriter.WriteRecordBatchAsync(Apache.Arrow.RecordBatch,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String},System.Threading.CancellationToken)">
+ WriteRecordBatchAsync(RecordBatch, IReadOnlyDictionary<string,
string>, CancellationToken)
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamWriter.cs/#L1166"><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 virtual Task
WriteRecordBatchAsync(RecordBatch recordBatch, IReadOnlyDictionary<string,
string> customMetadata, CancellationToken cancellationToken =
default)</code></pre>
+ </div>
+
+ <h4 class="section">Parameters</h4>
+ <dl class="parameters">
+ <dt><code>recordBatch</code> <a class="xref"
href="Apache.Arrow.RecordBatch.html">RecordBatch</a></dt>
+ <dd></dd>
+ <dt><code>customMetadata</code> <a class="xref"
href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlydictionary-2">IReadOnlyDictionary</a><<a
class="xref"
href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a
class="xref"
href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
+ <dd></dd>
+ <dt><code>cancellationToken</code> <a class="xref"
href="https://learn.microsoft.com/dotnet/api/system.threading.cancellationtoken">CancellationToken</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.threading.tasks.task">Task</a></dt>
+ <dd></dd>
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
<a id="Apache_Arrow_Ipc_ArrowStreamWriter_WriteRecordBatchAsync_"
data-uid="Apache.Arrow.Ipc.ArrowStreamWriter.WriteRecordBatchAsync*"></a>
<h3
id="Apache_Arrow_Ipc_ArrowStreamWriter_WriteRecordBatchAsync_Apache_Arrow_RecordBatch_System_Threading_CancellationToken_"
data-uid="Apache.Arrow.Ipc.ArrowStreamWriter.WriteRecordBatchAsync(Apache.Arrow.RecordBatch,System.Threading.CancellationToken)">
WriteRecordBatchAsync(RecordBatch, CancellationToken)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamWriter.cs/#L1135"><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamWriter.cs/#L1161"><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -608,7 +681,7 @@ Class ArrowStreamWriter <a class="header-action
link-secondary" title="View sou
<h3 id="Apache_Arrow_Ipc_ArrowStreamWriter_WriteStart"
data-uid="Apache.Arrow.Ipc.ArrowStreamWriter.WriteStart">
WriteStart()
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamWriter.cs/#L1140"><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamWriter.cs/#L1171"><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -634,7 +707,7 @@ Class ArrowStreamWriter <a class="header-action
link-secondary" title="View sou
<h3
id="Apache_Arrow_Ipc_ArrowStreamWriter_WriteStartAsync_System_Threading_CancellationToken_"
data-uid="Apache.Arrow.Ipc.ArrowStreamWriter.WriteStartAsync(System.Threading.CancellationToken)">
WriteStartAsync(CancellationToken)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamWriter.cs/#L1149"><i
class="bi bi-code-slash"></i></a>
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/ArrowStreamWriter.cs/#L1180"><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
diff --git a/main/api/Apache.Arrow.Ipc.RecordBatchWithMetadata.html
b/main/api/Apache.Arrow.Ipc.RecordBatchWithMetadata.html
new file mode 100644
index 0000000..a956ee5
--- /dev/null
+++ b/main/api/Apache.Arrow.Ipc.RecordBatchWithMetadata.html
@@ -0,0 +1,311 @@
+<!DOCTYPE html>
+<html>
+ <head>
+ <meta charset="utf-8">
+ <title>Struct RecordBatchWithMetadata | Apache Arrow .NET </title>
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+ <meta name="title" content="Struct RecordBatchWithMetadata | Apache
Arrow .NET ">
+
+ <meta name="description" content="A record batch read from an Arrow IPC
source, together with the custom metadata carried on the IPC Message that held
it.">
+ <link rel="icon" href="../images/favicon.png">
+ <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/arrow-dotnet/new/main/apiSpec/new?filename=Apache_Arrow_Ipc_RecordBatchWithMetadata.md&value=---%0Auid%3A%20Apache.Arrow.Ipc.RecordBatchWithMetadata%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">
+ <meta name="loc:inThisArticle" content="In this article">
+ <meta name="loc:searchResultsCount" content="{count} results for
"{query}"">
+ <meta name="loc:searchNoResults" content="No results for
"{query}"">
+ <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="Apache
Arrow .NET">
+ Apache Arrow .NET
+ </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.Arrow.Ipc.RecordBatchWithMetadata">
+
+
+
+ <h1 id="Apache_Arrow_Ipc_RecordBatchWithMetadata"
data-uid="Apache.Arrow.Ipc.RecordBatchWithMetadata" class="text-break">
+Struct RecordBatchWithMetadata <a class="header-action link-secondary"
title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/RecordBatchWithMetadata.cs/#L24"><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.Arrow.html">Arrow</a>.<a class="xref"
href="Apache.Arrow.Ipc.html">Ipc</a></dd></dl>
+ <dl><dt>Assembly</dt><dd>Apache.Arrow.dll</dd></dl>
+ </div>
+
+ <div class="markdown summary"><p>A record batch read from an Arrow IPC
source, together with the custom metadata
+carried on the IPC Message that held it.</p>
+</div>
+ <div class="markdown conceptual"></div>
+
+ <div class="codewrapper">
+ <pre><code class="lang-csharp hljs">public readonly struct
RecordBatchWithMetadata</code></pre>
+ </div>
+
+
+
+
+
+
+
+ <dl class="typelist inheritedMembers">
+ <dt>Inherited Members</dt>
+ <dd>
+ <div>
+ <a class="xref"
href="https://learn.microsoft.com/dotnet/api/system.valuetype.equals">ValueType.Equals(object)</a>
+ </div>
+ <div>
+ <a class="xref"
href="https://learn.microsoft.com/dotnet/api/system.valuetype.gethashcode">ValueType.GetHashCode()</a>
+ </div>
+ <div>
+ <a class="xref"
href="https://learn.microsoft.com/dotnet/api/system.valuetype.tostring">ValueType.ToString()</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.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_Arrow_Ipc_RecordBatchWithMetadata__ctor_"
data-uid="Apache.Arrow.Ipc.RecordBatchWithMetadata.#ctor*"></a>
+
+ <h3
id="Apache_Arrow_Ipc_RecordBatchWithMetadata__ctor_Apache_Arrow_RecordBatch_System_Collections_Generic_IReadOnlyDictionary_System_String_System_String__"
data-uid="Apache.Arrow.Ipc.RecordBatchWithMetadata.#ctor(Apache.Arrow.RecordBatch,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String})">
+ RecordBatchWithMetadata(RecordBatch, IReadOnlyDictionary<string,
string>)
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/RecordBatchWithMetadata.cs/#L26"><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
RecordBatchWithMetadata(RecordBatch batch, IReadOnlyDictionary<string,
string> customMetadata)</code></pre>
+ </div>
+
+ <h4 class="section">Parameters</h4>
+ <dl class="parameters">
+ <dt><code>batch</code> <a class="xref"
href="Apache.Arrow.RecordBatch.html">RecordBatch</a></dt>
+ <dd></dd>
+ <dt><code>customMetadata</code> <a class="xref"
href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlydictionary-2">IReadOnlyDictionary</a><<a
class="xref"
href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a
class="xref"
href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
+ <dd></dd>
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+
+ <h2 class="section" id="properties">Properties
+</h2>
+
+
+ <a id="Apache_Arrow_Ipc_RecordBatchWithMetadata_Batch_"
data-uid="Apache.Arrow.Ipc.RecordBatchWithMetadata.Batch*"></a>
+
+ <h3 id="Apache_Arrow_Ipc_RecordBatchWithMetadata_Batch"
data-uid="Apache.Arrow.Ipc.RecordBatchWithMetadata.Batch">
+ Batch
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/RecordBatchWithMetadata.cs/#L35"><i
class="bi bi-code-slash"></i></a>
+ </h3>
+
+ <div class="markdown level1 summary"><p>The record batch that was read, or
null at the end of the stream.</p>
+</div>
+ <div class="markdown level1 conceptual"></div>
+
+ <div class="codewrapper">
+ <pre><code class="lang-csharp hljs">public RecordBatch Batch { get;
}</code></pre>
+ </div>
+
+
+
+
+
+ <h4 class="section">Property Value</h4>
+ <dl class="parameters">
+ <dt><a class="xref"
href="Apache.Arrow.RecordBatch.html">RecordBatch</a></dt>
+ <dd></dd>
+ </dl>
+
+
+
+
+
+
+
+
+ <a id="Apache_Arrow_Ipc_RecordBatchWithMetadata_CustomMetadata_"
data-uid="Apache.Arrow.Ipc.RecordBatchWithMetadata.CustomMetadata*"></a>
+
+ <h3 id="Apache_Arrow_Ipc_RecordBatchWithMetadata_CustomMetadata"
data-uid="Apache.Arrow.Ipc.RecordBatchWithMetadata.CustomMetadata">
+ CustomMetadata
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/RecordBatchWithMetadata.cs/#L41"><i
class="bi bi-code-slash"></i></a>
+ </h3>
+
+ <div class="markdown level1 summary"><p>The Message-level custom metadata
accompanying <a class="xref"
href="Apache.Arrow.Ipc.RecordBatchWithMetadata.html#Apache_Arrow_Ipc_RecordBatchWithMetadata_Batch">Batch</a>,
or null if the
+message carried none.</p>
+</div>
+ <div class="markdown level1 conceptual"></div>
+
+ <div class="codewrapper">
+ <pre><code class="lang-csharp hljs">public IReadOnlyDictionary<string,
string> CustomMetadata { 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.collections.generic.ireadonlydictionary-2">IReadOnlyDictionary</a><<a
class="xref"
href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <a
class="xref"
href="https://learn.microsoft.com/dotnet/api/system.string">string</a>></dt>
+ <dd></dd>
+ </dl>
+
+
+
+
+
+
+
+
+ <h2 class="section" id="methods">Methods
+</h2>
+
+
+ <a id="Apache_Arrow_Ipc_RecordBatchWithMetadata_Deconstruct_"
data-uid="Apache.Arrow.Ipc.RecordBatchWithMetadata.Deconstruct*"></a>
+
+ <h3
id="Apache_Arrow_Ipc_RecordBatchWithMetadata_Deconstruct_Apache_Arrow_RecordBatch__System_Collections_Generic_IReadOnlyDictionary_System_String_System_String___"
data-uid="Apache.Arrow.Ipc.RecordBatchWithMetadata.Deconstruct(Apache.Arrow.RecordBatch@,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String}@)">
+ Deconstruct(out RecordBatch, out IReadOnlyDictionary<string, string>)
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/RecordBatchWithMetadata.cs/#L43"><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 void Deconstruct(out
RecordBatch batch, out IReadOnlyDictionary<string, string>
customMetadata)</code></pre>
+ </div>
+
+ <h4 class="section">Parameters</h4>
+ <dl class="parameters">
+ <dt><code>batch</code> <a class="xref"
href="Apache.Arrow.RecordBatch.html">RecordBatch</a></dt>
+ <dd></dd>
+ <dt><code>customMetadata</code> <a class="xref"
href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlydictionary-2">IReadOnlyDictionary</a><<a
class="xref"
href="https://learn.microsoft.com/dotnet/api/system.string">string</a>, <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/arrow-dotnet/blob/main/src/Apache.Arrow/Ipc/RecordBatchWithMetadata.cs/#L24"
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">
+ © 2018 The Apache Software Foundation
+ </div>
+ </div>
+ </footer>
+ </body>
+</html>
diff --git a/main/api/Apache.Arrow.Ipc.html b/main/api/Apache.Arrow.Ipc.html
index 2d6abf9..b00889c 100644
--- a/main/api/Apache.Arrow.Ipc.html
+++ b/main/api/Apache.Arrow.Ipc.html
@@ -116,6 +116,15 @@ Classes
<dt><a class="xref"
href="Apache.Arrow.Ipc.IpcOptions.html">IpcOptions</a></dt>
<dd></dd>
</dl>
+ <h3 id="structs">
+Structs
+</h3>
+ <dl class="jumplist">
+ <dt><a class="xref"
href="Apache.Arrow.Ipc.RecordBatchWithMetadata.html">RecordBatchWithMetadata</a></dt>
+ <dd><p>A record batch read from an Arrow IPC source, together with the
custom metadata
+carried on the IPC Message that held it.</p>
+</dd>
+ </dl>
<h3 id="interfaces">
Interfaces
</h3>
diff --git a/main/api/toc.html b/main/api/toc.html
index 6ec3828..ca859e8 100644
--- a/main/api/toc.html
+++ b/main/api/toc.html
@@ -787,6 +787,9 @@
<li>
<a href="Apache.Arrow.Ipc.IpcOptions.html"
name="" title="IpcOptions">IpcOptions</a>
</li>
+ <li>
+ <a
href="Apache.Arrow.Ipc.RecordBatchWithMetadata.html" name=""
title="RecordBatchWithMetadata">RecordBatchWithMetadata</a>
+ </li>
</ul>
</li>
<li>
diff --git a/main/api/toc.json b/main/api/toc.json
index dbdfb7b..08e84a3 100644
--- a/main/api/toc.json
+++ b/main/api/toc.json
@@ -1,2 +1,2 @@
-{"items":[{"name":"Apache.Arrow","href":"Apache.Arrow.html","topicHref":"Apache.Arrow.html","topicUid":"Apache.Arrow","type":"Namespace","items":[{"name":"Array","href":"Apache.Arrow.Array.html","topicHref":"Apache.Arrow.Array.html","topicUid":"Apache.Arrow.Array","type":"Class"},{"name":"ArrayData","href":"Apache.Arrow.ArrayData.html","topicHref":"Apache.Arrow.ArrayData.html","topicUid":"Apache.Arrow.ArrayData","type":"Class"},{"name":"ArrayDataConcatenator","href":"Apache.Arrow.ArrayDa
[...]
+{"items":[{"name":"Apache.Arrow","href":"Apache.Arrow.html","topicHref":"Apache.Arrow.html","topicUid":"Apache.Arrow","type":"Namespace","items":[{"name":"Array","href":"Apache.Arrow.Array.html","topicHref":"Apache.Arrow.Array.html","topicUid":"Apache.Arrow.Array","type":"Class"},{"name":"ArrayData","href":"Apache.Arrow.ArrayData.html","topicHref":"Apache.Arrow.ArrayData.html","topicUid":"Apache.Arrow.ArrayData","type":"Class"},{"name":"ArrayDataConcatenator","href":"Apache.Arrow.ArrayDa
[...]
diff --git a/main/index.json b/main/index.json
index 2804082..6026cd0 100644
--- a/main/index.json
+++ b/main/index.json
@@ -812,22 +812,22 @@
"api/Apache.Arrow.Ipc.ArrowFileReader.html": {
"href": "api/Apache.Arrow.Ipc.ArrowFileReader.html",
"title": "Class ArrowFileReader | Apache Arrow .NET",
- "summary": "Class ArrowFileReader Namespace Apache.Arrow.Ipc Assembly
Apache.Arrow.dll Implements an ArrowStreamReader that can read Arrow files.
public class ArrowFileReader : ArrowStreamReader, IArrowArrayStream,
IArrowReader, IDisposable Inheritance object ArrowStreamReader ArrowFileReader
Implements IArrowArrayStream IArrowReader IDisposable Inherited Members
ArrowStreamReader.Schema ArrowStreamReader.Dispose()
ArrowStreamReader.Dispose(bool) ArrowStreamReader.GetSchema(Cancellat [...]
+ "summary": "Class ArrowFileReader Namespace Apache.Arrow.Ipc Assembly
Apache.Arrow.dll Implements an ArrowStreamReader that can read Arrow files.
public class ArrowFileReader : ArrowStreamReader, IArrowArrayStream,
IArrowReader, IDisposable Inheritance object ArrowStreamReader ArrowFileReader
Implements IArrowArrayStream IArrowReader IDisposable Inherited Members
ArrowStreamReader.Schema ArrowStreamReader.Dispose()
ArrowStreamReader.Dispose(bool) ArrowStreamReader.GetSchema(Cancellat [...]
},
"api/Apache.Arrow.Ipc.ArrowFileWriter.html": {
"href": "api/Apache.Arrow.Ipc.ArrowFileWriter.html",
"title": "Class ArrowFileWriter | Apache Arrow .NET",
- "summary": "Class ArrowFileWriter Namespace Apache.Arrow.Ipc Assembly
Apache.Arrow.dll public class ArrowFileWriter : ArrowStreamWriter, IDisposable
Inheritance object ArrowStreamWriter ArrowFileWriter Implements IDisposable
Inherited Members ArrowStreamWriter.BaseStream
ArrowStreamWriter.HasWrittenSchema ArrowStreamWriter.Schema
ArrowStreamWriter.WriteStart()
ArrowStreamWriter.WriteStartAsync(CancellationToken)
ArrowStreamWriter.WriteEnd() ArrowStreamWriter.WriteEndAsync(Cancellatio [...]
+ "summary": "Class ArrowFileWriter Namespace Apache.Arrow.Ipc Assembly
Apache.Arrow.dll public class ArrowFileWriter : ArrowStreamWriter, IDisposable
Inheritance object ArrowStreamWriter ArrowFileWriter Implements IDisposable
Inherited Members ArrowStreamWriter.BaseStream
ArrowStreamWriter.HasWrittenSchema ArrowStreamWriter.Schema
ArrowStreamWriter.WriteRecordBatch(RecordBatch)
ArrowStreamWriter.WriteRecordBatch(RecordBatch, IReadOnlyDictionary<string,
string>) ArrowStreamWriter.Write [...]
},
"api/Apache.Arrow.Ipc.ArrowStreamReader.html": {
"href": "api/Apache.Arrow.Ipc.ArrowStreamReader.html",
"title": "Class ArrowStreamReader | Apache Arrow .NET",
- "summary": "Class ArrowStreamReader Namespace Apache.Arrow.Ipc Assembly
Apache.Arrow.dll Represents a reader that can read Arrow streams. public class
ArrowStreamReader : IArrowArrayStream, IArrowReader, IDisposable Inheritance
object ArrowStreamReader Implements IArrowArrayStream IArrowReader IDisposable
Derived ArrowFileReader Inherited Members object.Equals(object)
object.Equals(object, object) object.GetHashCode() object.GetType()
object.MemberwiseClone() object.ReferenceEquals(o [...]
+ "summary": "Class ArrowStreamReader Namespace Apache.Arrow.Ipc Assembly
Apache.Arrow.dll Represents a reader that can read Arrow streams. public class
ArrowStreamReader : IArrowArrayStream, IArrowReader, IDisposable Inheritance
object ArrowStreamReader Implements IArrowArrayStream IArrowReader IDisposable
Derived ArrowFileReader Inherited Members object.Equals(object)
object.Equals(object, object) object.GetHashCode() object.GetType()
object.MemberwiseClone() object.ReferenceEquals(o [...]
},
"api/Apache.Arrow.Ipc.ArrowStreamWriter.html": {
"href": "api/Apache.Arrow.Ipc.ArrowStreamWriter.html",
"title": "Class ArrowStreamWriter | Apache Arrow .NET",
- "summary": "Class ArrowStreamWriter Namespace Apache.Arrow.Ipc Assembly
Apache.Arrow.dll public class ArrowStreamWriter : IDisposable Inheritance
object ArrowStreamWriter Implements IDisposable Derived ArrowFileWriter
Inherited Members object.Equals(object) object.Equals(object, object)
object.GetHashCode() object.GetType() object.MemberwiseClone()
object.ReferenceEquals(object, object) object.ToString() Constructors
ArrowStreamWriter(Stream, Schema) public ArrowStreamWriter(Stream b [...]
+ "summary": "Class ArrowStreamWriter Namespace Apache.Arrow.Ipc Assembly
Apache.Arrow.dll public class ArrowStreamWriter : IDisposable Inheritance
object ArrowStreamWriter Implements IDisposable Derived ArrowFileWriter
Inherited Members object.Equals(object) object.Equals(object, object)
object.GetHashCode() object.GetType() object.MemberwiseClone()
object.ReferenceEquals(object, object) object.ToString() Constructors
ArrowStreamWriter(Stream, Schema) public ArrowStreamWriter(Stream b [...]
},
"api/Apache.Arrow.Ipc.CompressionCodecType.html": {
"href": "api/Apache.Arrow.Ipc.CompressionCodecType.html",
@@ -864,10 +864,15 @@
"title": "Class IpcOptions | Apache Arrow .NET",
"summary": "Class IpcOptions Namespace Apache.Arrow.Ipc Assembly
Apache.Arrow.dll public class IpcOptions Inheritance object IpcOptions
Inherited Members object.Equals(object) object.Equals(object, object)
object.GetHashCode() object.GetType() object.MemberwiseClone()
object.ReferenceEquals(object, object) object.ToString() Constructors
IpcOptions() public IpcOptions() Properties CompressionCodec The compression
codec to use to compress data buffers. If null (the default value), no c [...]
},
+ "api/Apache.Arrow.Ipc.RecordBatchWithMetadata.html": {
+ "href": "api/Apache.Arrow.Ipc.RecordBatchWithMetadata.html",
+ "title": "Struct RecordBatchWithMetadata | Apache Arrow .NET",
+ "summary": "Struct RecordBatchWithMetadata Namespace Apache.Arrow.Ipc
Assembly Apache.Arrow.dll A record batch read from an Arrow IPC source,
together with the custom metadata carried on the IPC Message that held it.
public readonly struct RecordBatchWithMetadata Inherited Members
ValueType.Equals(object) ValueType.GetHashCode() ValueType.ToString()
object.Equals(object, object) object.GetType() object.ReferenceEquals(object,
object) Constructors RecordBatchWithMetadata(RecordBatch, [...]
+ },
"api/Apache.Arrow.Ipc.html": {
"href": "api/Apache.Arrow.Ipc.html",
"title": "Namespace Apache.Arrow.Ipc | Apache Arrow .NET",
- "summary": "Namespace Apache.Arrow.Ipc Classes ArrowFileReader Implements
an ArrowStreamReader that can read Arrow files. ArrowFileWriter
ArrowStreamReader Represents a reader that can read Arrow streams.
ArrowStreamWriter IpcOptions Interfaces IArrowArrayStream IArrowReader
ICompressionCodec Codec for data compression and decompression (currently only
decompression is supported) ICompressionCodecFactory Provides compression codec
implementations for different compression codecs ITry [...]
+ "summary": "Namespace Apache.Arrow.Ipc Classes ArrowFileReader Implements
an ArrowStreamReader that can read Arrow files. ArrowFileWriter
ArrowStreamReader Represents a reader that can read Arrow streams.
ArrowStreamWriter IpcOptions Structs RecordBatchWithMetadata A record batch
read from an Arrow IPC source, together with the custom metadata carried on the
IPC Message that held it. Interfaces IArrowArrayStream IArrowReader
ICompressionCodec Codec for data compression and decompress [...]
},
"api/Apache.Arrow.LargeBinaryArray.Builder.html": {
"href": "api/Apache.Arrow.LargeBinaryArray.Builder.html",
diff --git a/main/manifest.json b/main/manifest.json
index a58860a..1443bf3 100644
--- a/main/manifest.json
+++ b/main/manifest.json
@@ -2432,6 +2432,20 @@
"Title": "Apache.Arrow.Ipc.IpcOptions",
"Summary": null
},
+ {
+ "type": "ManagedReference",
+ "source_relative_path":
"api/Apache.Arrow.Ipc.RecordBatchWithMetadata.yml",
+ "output": {
+ ".html": {
+ "relative_path": "api/Apache.Arrow.Ipc.RecordBatchWithMetadata.html"
+ }
+ },
+ "version": "",
+ "Uid": null,
+ "IsMRef": true,
+ "Title": "Apache.Arrow.Ipc.RecordBatchWithMetadata",
+ "Summary": "<p
sourcefile=\"api/Apache.Arrow.Ipc.RecordBatchWithMetadata.yml\"
sourcestartlinenumber=\"1\">A record batch read from an Arrow IPC source,
together with the custom metadata\ncarried on the IPC Message that held
it.</p>\n"
+ },
{
"type": "ManagedReference",
"source_relative_path": "api/Apache.Arrow.Ipc.yml",
diff --git a/main/xrefmap.yml b/main/xrefmap.yml
index e855d6c..73a179e 100644
--- a/main/xrefmap.yml
+++ b/main/xrefmap.yml
@@ -14206,6 +14206,22 @@ references:
isSpec: "True"
fullName: Apache.Arrow.Ipc.ArrowFileReader.ReadRecordBatchAsync
nameWithType: ArrowFileReader.ReadRecordBatchAsync
+- uid:
Apache.Arrow.Ipc.ArrowFileReader.ReadRecordBatchWithCustomMetadataAsync(System.Int32,System.Threading.CancellationToken)
+ name: ReadRecordBatchWithCustomMetadataAsync(int, CancellationToken)
+ href:
api/Apache.Arrow.Ipc.ArrowFileReader.html#Apache_Arrow_Ipc_ArrowFileReader_ReadRecordBatchWithCustomMetadataAsync_System_Int32_System_Threading_CancellationToken_
+ commentId:
M:Apache.Arrow.Ipc.ArrowFileReader.ReadRecordBatchWithCustomMetadataAsync(System.Int32,System.Threading.CancellationToken)
+ name.vb: ReadRecordBatchWithCustomMetadataAsync(Integer, CancellationToken)
+ fullName:
Apache.Arrow.Ipc.ArrowFileReader.ReadRecordBatchWithCustomMetadataAsync(int,
System.Threading.CancellationToken)
+ fullName.vb:
Apache.Arrow.Ipc.ArrowFileReader.ReadRecordBatchWithCustomMetadataAsync(Integer,
System.Threading.CancellationToken)
+ nameWithType: ArrowFileReader.ReadRecordBatchWithCustomMetadataAsync(int,
CancellationToken)
+ nameWithType.vb:
ArrowFileReader.ReadRecordBatchWithCustomMetadataAsync(Integer,
CancellationToken)
+- uid: Apache.Arrow.Ipc.ArrowFileReader.ReadRecordBatchWithCustomMetadataAsync*
+ name: ReadRecordBatchWithCustomMetadataAsync
+ href:
api/Apache.Arrow.Ipc.ArrowFileReader.html#Apache_Arrow_Ipc_ArrowFileReader_ReadRecordBatchWithCustomMetadataAsync_
+ commentId:
Overload:Apache.Arrow.Ipc.ArrowFileReader.ReadRecordBatchWithCustomMetadataAsync
+ isSpec: "True"
+ fullName:
Apache.Arrow.Ipc.ArrowFileReader.ReadRecordBatchWithCustomMetadataAsync
+ nameWithType: ArrowFileReader.ReadRecordBatchWithCustomMetadataAsync
- uid: Apache.Arrow.Ipc.ArrowFileReader.RecordBatchCountAsync
name: RecordBatchCountAsync()
href:
api/Apache.Arrow.Ipc.ArrowFileReader.html#Apache_Arrow_Ipc_ArrowFileReader_RecordBatchCountAsync
@@ -14271,32 +14287,6 @@ references:
fullName.vb: Apache.Arrow.Ipc.ArrowFileWriter.New
nameWithType: ArrowFileWriter.ArrowFileWriter
nameWithType.vb: ArrowFileWriter.New
-- uid:
Apache.Arrow.Ipc.ArrowFileWriter.WriteRecordBatch(Apache.Arrow.RecordBatch)
- name: WriteRecordBatch(RecordBatch)
- href:
api/Apache.Arrow.Ipc.ArrowFileWriter.html#Apache_Arrow_Ipc_ArrowFileWriter_WriteRecordBatch_Apache_Arrow_RecordBatch_
- commentId:
M:Apache.Arrow.Ipc.ArrowFileWriter.WriteRecordBatch(Apache.Arrow.RecordBatch)
- fullName:
Apache.Arrow.Ipc.ArrowFileWriter.WriteRecordBatch(Apache.Arrow.RecordBatch)
- nameWithType: ArrowFileWriter.WriteRecordBatch(RecordBatch)
-- uid: Apache.Arrow.Ipc.ArrowFileWriter.WriteRecordBatch*
- name: WriteRecordBatch
- href:
api/Apache.Arrow.Ipc.ArrowFileWriter.html#Apache_Arrow_Ipc_ArrowFileWriter_WriteRecordBatch_
- commentId: Overload:Apache.Arrow.Ipc.ArrowFileWriter.WriteRecordBatch
- isSpec: "True"
- fullName: Apache.Arrow.Ipc.ArrowFileWriter.WriteRecordBatch
- nameWithType: ArrowFileWriter.WriteRecordBatch
-- uid:
Apache.Arrow.Ipc.ArrowFileWriter.WriteRecordBatchAsync(Apache.Arrow.RecordBatch,System.Threading.CancellationToken)
- name: WriteRecordBatchAsync(RecordBatch, CancellationToken)
- href:
api/Apache.Arrow.Ipc.ArrowFileWriter.html#Apache_Arrow_Ipc_ArrowFileWriter_WriteRecordBatchAsync_Apache_Arrow_RecordBatch_System_Threading_CancellationToken_
- commentId:
M:Apache.Arrow.Ipc.ArrowFileWriter.WriteRecordBatchAsync(Apache.Arrow.RecordBatch,System.Threading.CancellationToken)
- fullName:
Apache.Arrow.Ipc.ArrowFileWriter.WriteRecordBatchAsync(Apache.Arrow.RecordBatch,
System.Threading.CancellationToken)
- nameWithType: ArrowFileWriter.WriteRecordBatchAsync(RecordBatch,
CancellationToken)
-- uid: Apache.Arrow.Ipc.ArrowFileWriter.WriteRecordBatchAsync*
- name: WriteRecordBatchAsync
- href:
api/Apache.Arrow.Ipc.ArrowFileWriter.html#Apache_Arrow_Ipc_ArrowFileWriter_WriteRecordBatchAsync_
- commentId: Overload:Apache.Arrow.Ipc.ArrowFileWriter.WriteRecordBatchAsync
- isSpec: "True"
- fullName: Apache.Arrow.Ipc.ArrowFileWriter.WriteRecordBatchAsync
- nameWithType: ArrowFileWriter.WriteRecordBatchAsync
- uid: Apache.Arrow.Ipc.ArrowStreamReader
name: ArrowStreamReader
href: api/Apache.Arrow.Ipc.ArrowStreamReader.html
@@ -14473,6 +14463,32 @@ references:
isSpec: "True"
fullName: Apache.Arrow.Ipc.ArrowStreamReader.ReadNextRecordBatchAsync
nameWithType: ArrowStreamReader.ReadNextRecordBatchAsync
+- uid: Apache.Arrow.Ipc.ArrowStreamReader.ReadNextRecordBatchWithCustomMetadata
+ name: ReadNextRecordBatchWithCustomMetadata()
+ href:
api/Apache.Arrow.Ipc.ArrowStreamReader.html#Apache_Arrow_Ipc_ArrowStreamReader_ReadNextRecordBatchWithCustomMetadata
+ commentId:
M:Apache.Arrow.Ipc.ArrowStreamReader.ReadNextRecordBatchWithCustomMetadata
+ fullName:
Apache.Arrow.Ipc.ArrowStreamReader.ReadNextRecordBatchWithCustomMetadata()
+ nameWithType: ArrowStreamReader.ReadNextRecordBatchWithCustomMetadata()
+- uid:
Apache.Arrow.Ipc.ArrowStreamReader.ReadNextRecordBatchWithCustomMetadata*
+ name: ReadNextRecordBatchWithCustomMetadata
+ href:
api/Apache.Arrow.Ipc.ArrowStreamReader.html#Apache_Arrow_Ipc_ArrowStreamReader_ReadNextRecordBatchWithCustomMetadata_
+ commentId:
Overload:Apache.Arrow.Ipc.ArrowStreamReader.ReadNextRecordBatchWithCustomMetadata
+ isSpec: "True"
+ fullName:
Apache.Arrow.Ipc.ArrowStreamReader.ReadNextRecordBatchWithCustomMetadata
+ nameWithType: ArrowStreamReader.ReadNextRecordBatchWithCustomMetadata
+- uid:
Apache.Arrow.Ipc.ArrowStreamReader.ReadNextRecordBatchWithCustomMetadataAsync(System.Threading.CancellationToken)
+ name: ReadNextRecordBatchWithCustomMetadataAsync(CancellationToken)
+ href:
api/Apache.Arrow.Ipc.ArrowStreamReader.html#Apache_Arrow_Ipc_ArrowStreamReader_ReadNextRecordBatchWithCustomMetadataAsync_System_Threading_CancellationToken_
+ commentId:
M:Apache.Arrow.Ipc.ArrowStreamReader.ReadNextRecordBatchWithCustomMetadataAsync(System.Threading.CancellationToken)
+ fullName:
Apache.Arrow.Ipc.ArrowStreamReader.ReadNextRecordBatchWithCustomMetadataAsync(System.Threading.CancellationToken)
+ nameWithType:
ArrowStreamReader.ReadNextRecordBatchWithCustomMetadataAsync(CancellationToken)
+- uid:
Apache.Arrow.Ipc.ArrowStreamReader.ReadNextRecordBatchWithCustomMetadataAsync*
+ name: ReadNextRecordBatchWithCustomMetadataAsync
+ href:
api/Apache.Arrow.Ipc.ArrowStreamReader.html#Apache_Arrow_Ipc_ArrowStreamReader_ReadNextRecordBatchWithCustomMetadataAsync_
+ commentId:
Overload:Apache.Arrow.Ipc.ArrowStreamReader.ReadNextRecordBatchWithCustomMetadataAsync
+ isSpec: "True"
+ fullName:
Apache.Arrow.Ipc.ArrowStreamReader.ReadNextRecordBatchWithCustomMetadataAsync
+ nameWithType: ArrowStreamReader.ReadNextRecordBatchWithCustomMetadataAsync
- uid: Apache.Arrow.Ipc.ArrowStreamReader.Schema
name: Schema
href:
api/Apache.Arrow.Ipc.ArrowStreamReader.html#Apache_Arrow_Ipc_ArrowStreamReader_Schema
@@ -14638,6 +14654,15 @@ references:
commentId:
M:Apache.Arrow.Ipc.ArrowStreamWriter.WriteRecordBatch(Apache.Arrow.RecordBatch)
fullName:
Apache.Arrow.Ipc.ArrowStreamWriter.WriteRecordBatch(Apache.Arrow.RecordBatch)
nameWithType: ArrowStreamWriter.WriteRecordBatch(RecordBatch)
+- uid:
Apache.Arrow.Ipc.ArrowStreamWriter.WriteRecordBatch(Apache.Arrow.RecordBatch,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String})
+ name: WriteRecordBatch(RecordBatch, IReadOnlyDictionary<string, string>)
+ href:
api/Apache.Arrow.Ipc.ArrowStreamWriter.html#Apache_Arrow_Ipc_ArrowStreamWriter_WriteRecordBatch_Apache_Arrow_RecordBatch_System_Collections_Generic_IReadOnlyDictionary_System_String_System_String__
+ commentId:
M:Apache.Arrow.Ipc.ArrowStreamWriter.WriteRecordBatch(Apache.Arrow.RecordBatch,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String})
+ name.vb: WriteRecordBatch(RecordBatch, IReadOnlyDictionary(Of String,
String))
+ fullName:
Apache.Arrow.Ipc.ArrowStreamWriter.WriteRecordBatch(Apache.Arrow.RecordBatch,
System.Collections.Generic.IReadOnlyDictionary<string, string>)
+ fullName.vb:
Apache.Arrow.Ipc.ArrowStreamWriter.WriteRecordBatch(Apache.Arrow.RecordBatch,
System.Collections.Generic.IReadOnlyDictionary(Of String, String))
+ nameWithType: ArrowStreamWriter.WriteRecordBatch(RecordBatch,
IReadOnlyDictionary<string, string>)
+ nameWithType.vb: ArrowStreamWriter.WriteRecordBatch(RecordBatch,
IReadOnlyDictionary(Of String, String))
- uid: Apache.Arrow.Ipc.ArrowStreamWriter.WriteRecordBatch*
name: WriteRecordBatch
href:
api/Apache.Arrow.Ipc.ArrowStreamWriter.html#Apache_Arrow_Ipc_ArrowStreamWriter_WriteRecordBatch_
@@ -14645,6 +14670,15 @@ references:
isSpec: "True"
fullName: Apache.Arrow.Ipc.ArrowStreamWriter.WriteRecordBatch
nameWithType: ArrowStreamWriter.WriteRecordBatch
+- uid:
Apache.Arrow.Ipc.ArrowStreamWriter.WriteRecordBatchAsync(Apache.Arrow.RecordBatch,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String},System.Threading.CancellationToken)
+ name: WriteRecordBatchAsync(RecordBatch, IReadOnlyDictionary<string,
string>, CancellationToken)
+ href:
api/Apache.Arrow.Ipc.ArrowStreamWriter.html#Apache_Arrow_Ipc_ArrowStreamWriter_WriteRecordBatchAsync_Apache_Arrow_RecordBatch_System_Collections_Generic_IReadOnlyDictionary_System_String_System_String__System_Threading_CancellationToken_
+ commentId:
M:Apache.Arrow.Ipc.ArrowStreamWriter.WriteRecordBatchAsync(Apache.Arrow.RecordBatch,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String},System.Threading.CancellationToken)
+ name.vb: WriteRecordBatchAsync(RecordBatch, IReadOnlyDictionary(Of String,
String), CancellationToken)
+ fullName:
Apache.Arrow.Ipc.ArrowStreamWriter.WriteRecordBatchAsync(Apache.Arrow.RecordBatch,
System.Collections.Generic.IReadOnlyDictionary<string, string>,
System.Threading.CancellationToken)
+ fullName.vb:
Apache.Arrow.Ipc.ArrowStreamWriter.WriteRecordBatchAsync(Apache.Arrow.RecordBatch,
System.Collections.Generic.IReadOnlyDictionary(Of String, String),
System.Threading.CancellationToken)
+ nameWithType: ArrowStreamWriter.WriteRecordBatchAsync(RecordBatch,
IReadOnlyDictionary<string, string>, CancellationToken)
+ nameWithType.vb: ArrowStreamWriter.WriteRecordBatchAsync(RecordBatch,
IReadOnlyDictionary(Of String, String), CancellationToken)
- uid:
Apache.Arrow.Ipc.ArrowStreamWriter.WriteRecordBatchAsync(Apache.Arrow.RecordBatch,System.Threading.CancellationToken)
name: WriteRecordBatchAsync(RecordBatch, CancellationToken)
href:
api/Apache.Arrow.Ipc.ArrowStreamWriter.html#Apache_Arrow_Ipc_ArrowStreamWriter_WriteRecordBatchAsync_Apache_Arrow_RecordBatch_System_Threading_CancellationToken_
@@ -14905,6 +14939,73 @@ references:
isSpec: "True"
fullName: Apache.Arrow.Ipc.IpcOptions.WriteLegacyIpcFormat
nameWithType: IpcOptions.WriteLegacyIpcFormat
+- uid: Apache.Arrow.Ipc.RecordBatchWithMetadata
+ name: RecordBatchWithMetadata
+ href: api/Apache.Arrow.Ipc.RecordBatchWithMetadata.html
+ commentId: T:Apache.Arrow.Ipc.RecordBatchWithMetadata
+ fullName: Apache.Arrow.Ipc.RecordBatchWithMetadata
+ nameWithType: RecordBatchWithMetadata
+- uid:
Apache.Arrow.Ipc.RecordBatchWithMetadata.#ctor(Apache.Arrow.RecordBatch,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String})
+ name: RecordBatchWithMetadata(RecordBatch, IReadOnlyDictionary<string,
string>)
+ href:
api/Apache.Arrow.Ipc.RecordBatchWithMetadata.html#Apache_Arrow_Ipc_RecordBatchWithMetadata__ctor_Apache_Arrow_RecordBatch_System_Collections_Generic_IReadOnlyDictionary_System_String_System_String__
+ commentId:
M:Apache.Arrow.Ipc.RecordBatchWithMetadata.#ctor(Apache.Arrow.RecordBatch,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String})
+ name.vb: New(RecordBatch, IReadOnlyDictionary(Of String, String))
+ fullName:
Apache.Arrow.Ipc.RecordBatchWithMetadata.RecordBatchWithMetadata(Apache.Arrow.RecordBatch,
System.Collections.Generic.IReadOnlyDictionary<string, string>)
+ fullName.vb:
Apache.Arrow.Ipc.RecordBatchWithMetadata.New(Apache.Arrow.RecordBatch,
System.Collections.Generic.IReadOnlyDictionary(Of String, String))
+ nameWithType: RecordBatchWithMetadata.RecordBatchWithMetadata(RecordBatch,
IReadOnlyDictionary<string, string>)
+ nameWithType.vb: RecordBatchWithMetadata.New(RecordBatch,
IReadOnlyDictionary(Of String, String))
+- uid: Apache.Arrow.Ipc.RecordBatchWithMetadata.#ctor*
+ name: RecordBatchWithMetadata
+ href:
api/Apache.Arrow.Ipc.RecordBatchWithMetadata.html#Apache_Arrow_Ipc_RecordBatchWithMetadata__ctor_
+ commentId: Overload:Apache.Arrow.Ipc.RecordBatchWithMetadata.#ctor
+ isSpec: "True"
+ name.vb: New
+ fullName: Apache.Arrow.Ipc.RecordBatchWithMetadata.RecordBatchWithMetadata
+ fullName.vb: Apache.Arrow.Ipc.RecordBatchWithMetadata.New
+ nameWithType: RecordBatchWithMetadata.RecordBatchWithMetadata
+ nameWithType.vb: RecordBatchWithMetadata.New
+- uid: Apache.Arrow.Ipc.RecordBatchWithMetadata.Batch
+ name: Batch
+ href:
api/Apache.Arrow.Ipc.RecordBatchWithMetadata.html#Apache_Arrow_Ipc_RecordBatchWithMetadata_Batch
+ commentId: P:Apache.Arrow.Ipc.RecordBatchWithMetadata.Batch
+ fullName: Apache.Arrow.Ipc.RecordBatchWithMetadata.Batch
+ nameWithType: RecordBatchWithMetadata.Batch
+- uid: Apache.Arrow.Ipc.RecordBatchWithMetadata.Batch*
+ name: Batch
+ href:
api/Apache.Arrow.Ipc.RecordBatchWithMetadata.html#Apache_Arrow_Ipc_RecordBatchWithMetadata_Batch_
+ commentId: Overload:Apache.Arrow.Ipc.RecordBatchWithMetadata.Batch
+ isSpec: "True"
+ fullName: Apache.Arrow.Ipc.RecordBatchWithMetadata.Batch
+ nameWithType: RecordBatchWithMetadata.Batch
+- uid: Apache.Arrow.Ipc.RecordBatchWithMetadata.CustomMetadata
+ name: CustomMetadata
+ href:
api/Apache.Arrow.Ipc.RecordBatchWithMetadata.html#Apache_Arrow_Ipc_RecordBatchWithMetadata_CustomMetadata
+ commentId: P:Apache.Arrow.Ipc.RecordBatchWithMetadata.CustomMetadata
+ fullName: Apache.Arrow.Ipc.RecordBatchWithMetadata.CustomMetadata
+ nameWithType: RecordBatchWithMetadata.CustomMetadata
+- uid: Apache.Arrow.Ipc.RecordBatchWithMetadata.CustomMetadata*
+ name: CustomMetadata
+ href:
api/Apache.Arrow.Ipc.RecordBatchWithMetadata.html#Apache_Arrow_Ipc_RecordBatchWithMetadata_CustomMetadata_
+ commentId: Overload:Apache.Arrow.Ipc.RecordBatchWithMetadata.CustomMetadata
+ isSpec: "True"
+ fullName: Apache.Arrow.Ipc.RecordBatchWithMetadata.CustomMetadata
+ nameWithType: RecordBatchWithMetadata.CustomMetadata
+- uid:
Apache.Arrow.Ipc.RecordBatchWithMetadata.Deconstruct(Apache.Arrow.RecordBatch@,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String}@)
+ name: Deconstruct(out RecordBatch, out IReadOnlyDictionary<string, string>)
+ href:
api/Apache.Arrow.Ipc.RecordBatchWithMetadata.html#Apache_Arrow_Ipc_RecordBatchWithMetadata_Deconstruct_Apache_Arrow_RecordBatch__System_Collections_Generic_IReadOnlyDictionary_System_String_System_String___
+ commentId:
M:Apache.Arrow.Ipc.RecordBatchWithMetadata.Deconstruct(Apache.Arrow.RecordBatch@,System.Collections.Generic.IReadOnlyDictionary{System.String,System.String}@)
+ name.vb: Deconstruct(RecordBatch, IReadOnlyDictionary(Of String, String))
+ fullName: Apache.Arrow.Ipc.RecordBatchWithMetadata.Deconstruct(out
Apache.Arrow.RecordBatch, out
System.Collections.Generic.IReadOnlyDictionary<string, string>)
+ fullName.vb:
Apache.Arrow.Ipc.RecordBatchWithMetadata.Deconstruct(Apache.Arrow.RecordBatch,
System.Collections.Generic.IReadOnlyDictionary(Of String, String))
+ nameWithType: RecordBatchWithMetadata.Deconstruct(out RecordBatch, out
IReadOnlyDictionary<string, string>)
+ nameWithType.vb: RecordBatchWithMetadata.Deconstruct(RecordBatch,
IReadOnlyDictionary(Of String, String))
+- uid: Apache.Arrow.Ipc.RecordBatchWithMetadata.Deconstruct*
+ name: Deconstruct
+ href:
api/Apache.Arrow.Ipc.RecordBatchWithMetadata.html#Apache_Arrow_Ipc_RecordBatchWithMetadata_Deconstruct_
+ commentId: Overload:Apache.Arrow.Ipc.RecordBatchWithMetadata.Deconstruct
+ isSpec: "True"
+ fullName: Apache.Arrow.Ipc.RecordBatchWithMetadata.Deconstruct
+ nameWithType: RecordBatchWithMetadata.Deconstruct
- uid: Apache.Arrow.LargeBinaryArray
name: LargeBinaryArray
href: api/Apache.Arrow.LargeBinaryArray.html