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-nanoarrow.git
The following commit(s) were added to refs/heads/asf-site by this push:
new c21a3084 update documentation for tag main
c21a3084 is described below
commit c21a3084283b1d8bf3c4fd6cf82aadbd359f3270
Author: GitHub Actions <[email protected]>
AuthorDate: Wed Oct 21 02:33:48 2026 +0000
update documentation for tag main
---
main/.doctrees/environment.pickle | Bin 1183657 -> 1183729 bytes
main/.doctrees/reference/ipc.doctree | Bin 473417 -> 478824 bytes
main/objects.inv | Bin 23790 -> 23813 bytes
main/r/pkgdown.yml | 2 +-
main/reference/ipc.html | 15 ++++++++++++---
main/searchindex.js | 2 +-
6 files changed, 14 insertions(+), 5 deletions(-)
diff --git a/main/.doctrees/environment.pickle
b/main/.doctrees/environment.pickle
index 040e1e0f..f6e29d24 100644
Binary files a/main/.doctrees/environment.pickle and
b/main/.doctrees/environment.pickle differ
diff --git a/main/.doctrees/reference/ipc.doctree
b/main/.doctrees/reference/ipc.doctree
index a7491b81..0ff8dd84 100644
Binary files a/main/.doctrees/reference/ipc.doctree and
b/main/.doctrees/reference/ipc.doctree differ
diff --git a/main/objects.inv b/main/objects.inv
index a8afd6a2..cf9db78d 100644
Binary files a/main/objects.inv and b/main/objects.inv differ
diff --git a/main/r/pkgdown.yml b/main/r/pkgdown.yml
index cf1d6800..dcef73d6 100644
--- a/main/r/pkgdown.yml
+++ b/main/r/pkgdown.yml
@@ -2,4 +2,4 @@ pandoc: 3.7.0.2
pkgdown: 2.2.1
pkgdown_sha: ~
articles: {}
-last_built: 2026-10-20T15:37Z
+last_built: 2026-10-21T02:33Z
diff --git a/main/reference/ipc.html b/main/reference/ipc.html
index fb49aa42..c189a3dd 100644
--- a/main/reference/ipc.html
+++ b/main/reference/ipc.html
@@ -961,7 +961,7 @@
<dt class="sig sig-object cpp">
<span class="target"
id="group__nanoarrow__ipc_1ga05db635e4c433c34f40e69db45b55e2b"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcEncoderSetMessageMetadata</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcEncoder</span> <span
class="pre">*encoder,</span> <span class="pre">struct</span> <span
class="pre">ArrowBuffer</span> <span class="pre">*metadata,</span> <span
class="pre" [...]
<dd><p>Set the custom metadata of the next encoded message. </p>
-<p>Attaches metadata to the next message encoded by <a class="reference
internal"
href="#group__nanoarrow__ipc_1gabd2af9c33984ccc5b349b5247ef4655f"><span
class="std std-ref">ArrowIpcEncoderEncodeSchema()</span></a> or <a
class="reference internal"
href="#group__nanoarrow__ipc_1ga08930a86ff9fb73a3e607967c9c84037"><span
class="std std-ref">ArrowIpcEncoderEncodeSimpleRecordBatch()</span></a> (i.e.,
Message::custom_metadata, which is distinct from the metadata of the Schema or
Field that the [...]
+<p>Attaches metadata to the next message encoded by <a class="reference
internal"
href="#group__nanoarrow__ipc_1gabd2af9c33984ccc5b349b5247ef4655f"><span
class="std std-ref">ArrowIpcEncoderEncodeSchema()</span></a>, <a
class="reference internal"
href="#group__nanoarrow__ipc_1ga08930a86ff9fb73a3e607967c9c84037"><span
class="std std-ref">ArrowIpcEncoderEncodeSimpleRecordBatch()</span></a>, or <a
class="reference internal"
href="#group__nanoarrow__ipc_1gaead4027cadb01eab3467726abd8e0688"><s [...]
<p>metadata contains the same representation as ArrowSchema::metadata, as
built by <a class="reference internal"
href="c.html#group__nanoarrow-metadata_1gaa5ec9643870d9fc0e55ef78c3a374ec3"><span
class="std
std-ref">ArrowMetadataBuilderInit()</span></a>/ArrowMetadataBuilderAppend().
The encoder takes ownership of it: unless metadata is NULL it is moved into the
encoder and left empty. Metadata containing no keys is equivalent to no
metadata at all and no custom_metadata is encoded for it. </p>
</dd></dl>
@@ -982,6 +982,13 @@
<p>The encoder takes ownership of compressor and replaces any compressor
previously set. The compressor’s compression_type member selects the codec (any
level is part of the compressor’s own configuration, like the one given to <a
class="reference internal"
href="#group__nanoarrow__ipc_1gac65aabe05ccb72cc846613c7e921e644"><span
class="std std-ref">ArrowIpcSerialCompressor()</span></a>), and its support is
not checked until a message is encoded. </p>
</dd></dl>
+<dl class="cpp function">
+<dt class="sig sig-object cpp">
+<span class="target"
id="group__nanoarrow__ipc_1gac4924087a4723e2f2fac28ed99c67f0b"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">void</span> <span
class="pre">ArrowIpcEncoderSetDictionaryReplacement</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcEncoder</span> <span
class="pre">*encoder,</span> <span class="pre">char</span> <span
class="pre">enabled)</span></span></dt>
+<dd><p>Declare dictionary replacement support in subsequently encoded schemas.
</p>
+<p>Enable this before encoding the schema of a stream that may contain more
than one non-delta DictionaryBatch with the same dictionary ID. The
DICTIONARY_REPLACEMENT feature is only written if the schema contains at least
one dictionary-encoded field. This option is disabled by default. </p>
+</dd></dl>
+
<dl class="cpp function">
<dt class="sig sig-object cpp">
<span class="target"
id="group__nanoarrow__ipc_1gabd2af9c33984ccc5b349b5247ef4655f"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcEncoderEncodeSchema</span> <span class="pre">(struct</span>
<span class="pre">ArrowIpcEncoder</span> <span class="pre">*encoder,</span>
<span class="pre">const</span> <span class="pre">struct</span> <span
class="pre">ArrowSchema</span> <span class="pre">*schema,</ [...]
@@ -1078,7 +1085,8 @@
<dt class="sig sig-object cpp">
<span class="target"
id="group__nanoarrow__ipc_1gaf8837005f77a2d365ff3d0154e4816ba"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcWriterWriteArrayViewWithDictionaries</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcWriter</span> <span
class="pre">*writer,</span> <span class="pre">const</span> <span
class="pre">struct</span> <span class="pre">ArrowArrayView</span> <span clas
[...]
<dd><p>Write an array view and the dictionaries it references. </p>
-<p>Writes a DictionaryBatch message for each dictionary-encoded field of in,
followed by the RecordBatch itself, exactly as <a class="reference internal"
href="#group__nanoarrow__ipc_1ga64d014567e9db57a7ccdb6f423082087"><span
class="std std-ref">ArrowIpcWriterWriteArrayStream()</span></a> does for each
array of a stream. This lets a caller that produces batches one at a time
(rather than from an <a class="reference internal"
href="c.html#struct_arrow_array_stream"><span class="std std-re [...]
+<p>Writes a DictionaryBatch message for each dictionary-encoded field of in,
followed by the RecordBatch itself, as <a class="reference internal"
href="#group__nanoarrow__ipc_1ga64d014567e9db57a7ccdb6f423082087"><span
class="std std-ref">ArrowIpcWriterWriteArrayStream()</span></a> does for each
array of a stream. This lets a caller that produces batches one at a time
(rather than from an <a class="reference internal"
href="c.html#struct_arrow_array_stream"><span class="std std-ref">Arrow [...]
+<p>Because in is borrowed, its dictionaries are not compared with those of
earlier batches (as <a class="reference internal"
href="#group__nanoarrow__ipc_1ga64d014567e9db57a7ccdb6f423082087"><span
class="std std-ref">ArrowIpcWriterWriteArrayStream()</span></a> does to skip
unchanged ones): each dictionary is written in full before every RecordBatch,
replacing the previous one. In file mode, where a dictionary ID may only be
written once, this means only one batch with dictionaries can be [...]
<p>Errors are propagated from the underlying encoder and output byte stream.
</p>
</dd></dl>
@@ -1086,7 +1094,7 @@
<dt class="sig sig-object cpp">
<span class="target"
id="group__nanoarrow__ipc_1gac56261b7cc2a81071b857895d64ba4ae"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcWriterWriteDictionaryBatch</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcWriter</span> <span
class="pre">*writer,</span> <span class="pre">int64_t</span> <span
class="pre">dictionary_id,</span> <span class="pre">char</span> <span
class="pre">is [...]
<dd><p>Write a DictionaryBatch message to the output byte stream. </p>
-<p>dictionary_id must match the id assigned to the dictionary-encoded field in
the schema. is_delta selects DictionaryBatch.isDelta. values_view must not
itself be dictionary-encoded. The writer does not check that a schema was
already written.</p>
+<p>dictionary_id must match the id assigned to the dictionary-encoded field in
the schema. is_delta selects DictionaryBatch.isDelta. values_view must not
itself be dictionary-encoded. The writer does not check that a schema was
already written. values_view is always written: the writer only sees a borrowed
view and cannot check whether it is identical to a dictionary that was already
written. When writing a file, returns ENOTSUP for a delta or for a
dictionary_id that was already written [...]
<p>Errors are propagated from the underlying encoder and output byte stream.
</p>
</dd></dl>
@@ -1094,6 +1102,7 @@
<dt class="sig sig-object cpp">
<span class="target"
id="group__nanoarrow__ipc_1ga64d014567e9db57a7ccdb6f423082087"></span><span
class="sig-name descname"><span class="pre">NANOARROW_DLL</span> <span
class="pre">ArrowErrorCode</span> <span
class="pre">ArrowIpcWriterWriteArrayStream</span> <span
class="pre">(struct</span> <span class="pre">ArrowIpcWriter</span> <span
class="pre">*writer,</span> <span class="pre">struct</span> <span
class="pre">ArrowArrayStream</span> <span class="pre">*in,</span> <span
class="pre">struc [...]
<dd><p>Write an entire stream (including EOS) to the output byte stream. </p>
+<p>Dictionaries are written before the first array that references them. For
subsequent arrays, a dictionary is written again (as a replacement) unless it
has the same length, offset, and null count and points to the same buffers as
the corresponding dictionary of the previous array (e.g., because the producer
shares one dictionary among all arrays of the stream). The variadic buffer
sizes of a BinaryView or StringView array are not compared, since producers may
generate them on each exp [...]
<p>Errors are propagated from the underlying encoder, array stream, and output
byte stream. </p>
</dd></dl>
diff --git a/main/searchindex.js b/main/searchindex.js
index c2c2c0dd..9d7f9a43 100644
--- a/main/searchindex.js
+++ b/main/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles":{"API Reference":[[8,null]],"Array Stream
utilities":[[6,"array-stream-utilities"]],"Array
Streams":[[3,"array-streams"]],"Array
streams":[[2,"array-streams"]],"Arrays":[[2,"arrays"],[3,"arrays"]],"Arrow C
Data Interface":[[5,"arrow-c-data-interface"]],"Arrow C Device
Interface":[[7,"arrow-c-device-interface"]],"Arrow C data/nanoarrow interface
basics":[[0,"arrow-c-data-nanoarrow-interface-basics"]],"Bitmap
utilities":[[5,"bitmap-utilities"]],"Buffer utilitie [...]
\ No newline at end of file
+Search.setIndex({"alltitles":{"API Reference":[[8,null]],"Array Stream
utilities":[[6,"array-stream-utilities"]],"Array
Streams":[[3,"array-streams"]],"Array
streams":[[2,"array-streams"]],"Arrays":[[2,"arrays"],[3,"arrays"]],"Arrow C
Data Interface":[[5,"arrow-c-data-interface"]],"Arrow C Device
Interface":[[7,"arrow-c-device-interface"]],"Arrow C data/nanoarrow interface
basics":[[0,"arrow-c-data-nanoarrow-interface-basics"]],"Bitmap
utilities":[[5,"bitmap-utilities"]],"Buffer utilitie [...]
\ No newline at end of file
