This is an automated email from the ASF dual-hosted git repository.
github-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 f0aca4e Update docs for 009762ed78eab160c1b31774e4db6480a5ae5f80
f0aca4e is described below
commit f0aca4ec2cd8846ccbceadedb54ae5f008028ce9
Author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
AuthorDate: Wed Mar 25 17:48:02 2026 +0000
Update docs for 009762ed78eab160c1b31774e4db6480a5ae5f80
---
main/api/Apache.Arrow.Decimal128Array.html | 60 +++++++++++++++++++++++++++---
main/api/Apache.Arrow.Decimal256Array.html | 59 ++++++++++++++++++++++++++---
main/index.json | 4 +-
main/xrefmap.yml | 32 ++++++++++++++++
4 files changed, 143 insertions(+), 12 deletions(-)
diff --git a/main/api/Apache.Arrow.Decimal128Array.html
b/main/api/Apache.Arrow.Decimal128Array.html
index bf9fb21..d6d1206 100644
--- a/main/api/Apache.Arrow.Decimal128Array.html
+++ b/main/api/Apache.Arrow.Decimal128Array.html
@@ -371,7 +371,7 @@ Class Decimal128Array <a class="header-action
link-secondary" title="View sourc
<h3 id="Apache_Arrow_Decimal128Array_GetSqlDecimal_System_Int32_"
data-uid="Apache.Arrow.Decimal128Array.GetSqlDecimal(System.Int32)">
GetSqlDecimal(int)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/Decimal128Array.cs/#L183";><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/Arrays/Decimal128Array.cs/#L217";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -407,7 +407,7 @@ Class Decimal128Array <a class="header-action
link-secondary" title="View sourc
<h3 id="Apache_Arrow_Decimal128Array_GetString_System_Int32_"
data-uid="Apache.Arrow.Decimal128Array.GetString(System.Int32)">
GetString(int)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/Decimal128Array.cs/#L174";><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/Arrays/Decimal128Array.cs/#L208";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -443,10 +443,13 @@ Class Decimal128Array <a class="header-action
link-secondary" title="View sourc
<h3 id="Apache_Arrow_Decimal128Array_GetValue_System_Int32_"
data-uid="Apache.Arrow.Decimal128Array.GetValue(System.Int32)">
GetValue(int)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/Decimal128Array.cs/#L141";><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/Arrays/Decimal128Array.cs/#L146";><i
class="bi bi-code-slash"></i></a>
</h3>
- <div class="markdown level1 summary"></div>
+ <div class="markdown level1 summary"><p>Gets the decimal value at the index
of the array. May throw an exception if the value can't be
+expressed as a <a class="xref"
href="https://learn.microsoft.com/dotnet/api/system.decimal";>decimal</a>. See
<a class="xref"
href="Apache.Arrow.Decimal128Array.html#Apache_Arrow_Decimal128Array_TryGetValue_System_Int32_System_Nullable_System_Decimal___">TryGetValue(int,
out decimal?)</a> for
+details.</p>
+</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -479,7 +482,7 @@ Class Decimal128Array <a class="header-action
link-secondary" title="View sourc
<h3 id="Apache_Arrow_Decimal128Array_ToList_System_Boolean_"
data-uid="Apache.Arrow.Decimal128Array.ToList(System.Boolean)">
ToList(bool)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/Decimal128Array.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/Arrays/Decimal128Array.cs/#L184";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -511,6 +514,53 @@ Class Decimal128Array <a class="header-action
link-secondary" title="View sourc
+ <a id="Apache_Arrow_Decimal128Array_TryGetValue_"
data-uid="Apache.Arrow.Decimal128Array.TryGetValue*"></a>
+
+ <h3
id="Apache_Arrow_Decimal128Array_TryGetValue_System_Int32_System_Nullable_System_Decimal___"
data-uid="Apache.Arrow.Decimal128Array.TryGetValue(System.Int32,System.Nullable{System.Decimal}@)">
+ TryGetValue(int, out decimal?)
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/Decimal128Array.cs/#L166";><i
class="bi bi-code-slash"></i></a>
+ </h3>
+
+ <div class="markdown level1 summary"><p>Gets the decimal value at the index
of the array. Returns false if the value can't be
+expressed as a <a class="xref"
href="https://learn.microsoft.com/dotnet/api/system.decimal";>decimal</a>. <a
class="xref"
href="https://learn.microsoft.com/dotnet/api/system.decimal";>decimal</a> is a
128-bit
+floating point value with a 5 bit base-10 exponent and a 96-bit base-10
mantissa. Decimal128
+is a fixed point 128 bit value where up to 128 bits can be used for the
mantissa, and both
+the number of bits and the exponent are determined by the array's type (which
is out-of-band).
+This means that a <a class="xref"
href="Apache.Arrow.Types.Decimal128Type.html">Decimal128Type</a> whose
precision minus scale is greater than 28
+might produce an overflow when stored as a .NET decimal. It may also cause
rounding for
+precisions greater than 28. These will silently succeed. By contrast, <a
class="xref"
href="https://learn.microsoft.com/dotnet/api/system.data.sqltypes.sqldecimal";>SqlDecimal</a>
+can store a decimal128 value with full fidelity.</p>
+</div>
+ <div class="markdown level1 conceptual"></div>
+
+ <div class="codewrapper">
+ <pre><code class="lang-csharp hljs">public bool TryGetValue(int index, out
decimal? value)</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>value</code> <a class="xref"
href="https://learn.microsoft.com/dotnet/api/system.decimal";>decimal</a>?</dt>
+ <dd></dd>
+ </dl>
+
+ <h4 class="section">Returns</h4>
+ <dl class="parameters">
+ <dt><a class="xref"
href="https://learn.microsoft.com/dotnet/api/system.boolean";>bool</a></dt>
+ <dd></dd>
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
</article>
diff --git a/main/api/Apache.Arrow.Decimal256Array.html
b/main/api/Apache.Arrow.Decimal256Array.html
index b67e9c6..6a4f681 100644
--- a/main/api/Apache.Arrow.Decimal256Array.html
+++ b/main/api/Apache.Arrow.Decimal256Array.html
@@ -374,7 +374,7 @@ Class Decimal256Array <a class="header-action
link-secondary" title="View sourc
<h3 id="Apache_Arrow_Decimal256Array_GetString_System_Int32_"
data-uid="Apache.Arrow.Decimal256Array.GetString(System.Int32)">
GetString(int)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/Decimal256Array.cs/#L183";><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/Arrays/Decimal256Array.cs/#L216";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -410,10 +410,13 @@ Class Decimal256Array <a class="header-action
link-secondary" title="View sourc
<h3 id="Apache_Arrow_Decimal256Array_GetValue_System_Int32_"
data-uid="Apache.Arrow.Decimal256Array.GetValue(System.Int32)">
GetValue(int)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/Decimal256Array.cs/#L149";><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/Arrays/Decimal256Array.cs/#L154";><i
class="bi bi-code-slash"></i></a>
</h3>
- <div class="markdown level1 summary"></div>
+ <div class="markdown level1 summary"><p>Gets the decimal value at the index
of the array. May throw an exception if the value can't be
+expressed as a <a class="xref"
href="https://learn.microsoft.com/dotnet/api/system.decimal";>decimal</a>. See
<a class="xref"
href="Apache.Arrow.Decimal256Array.html#Apache_Arrow_Decimal256Array_TryGetValue_System_Int32_System_Nullable_System_Decimal___">TryGetValue(int,
out decimal?)</a> for
+details.</p>
+</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
@@ -446,7 +449,7 @@ Class Decimal256Array <a class="header-action
link-secondary" title="View sourc
<h3 id="Apache_Arrow_Decimal256Array_ToList_System_Boolean_"
data-uid="Apache.Arrow.Decimal256Array.ToList(System.Boolean)">
ToList(bool)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/Decimal256Array.cs/#L159";><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/Arrays/Decimal256Array.cs/#L192";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -482,7 +485,7 @@ Class Decimal256Array <a class="header-action
link-secondary" title="View sourc
<h3
id="Apache_Arrow_Decimal256Array_TryGetSqlDecimal_System_Int32_System_Nullable_System_Data_SqlTypes_SqlDecimal___"
data-uid="Apache.Arrow.Decimal256Array.TryGetSqlDecimal(System.Int32,System.Nullable{System.Data.SqlTypes.SqlDecimal}@)">
TryGetSqlDecimal(int, out SqlDecimal?)
- <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/Decimal256Array.cs/#L192";><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/Arrays/Decimal256Array.cs/#L225";><i
class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"></div>
@@ -516,6 +519,52 @@ Class Decimal256Array <a class="header-action
link-secondary" title="View sourc
+ <a id="Apache_Arrow_Decimal256Array_TryGetValue_"
data-uid="Apache.Arrow.Decimal256Array.TryGetValue*"></a>
+
+ <h3
id="Apache_Arrow_Decimal256Array_TryGetValue_System_Int32_System_Nullable_System_Decimal___"
data-uid="Apache.Arrow.Decimal256Array.TryGetValue(System.Int32,System.Nullable{System.Decimal}@)">
+ TryGetValue(int, out decimal?)
+ <a class="header-action link-secondary" title="View source"
href="https://github.com/apache/arrow-dotnet/blob/main/src/Apache.Arrow/Arrays/Decimal256Array.cs/#L174";><i
class="bi bi-code-slash"></i></a>
+ </h3>
+
+ <div class="markdown level1 summary"><p>Gets the decimal value at the index
of the array. Returns false if the value can't be
+expressed as a <a class="xref"
href="https://learn.microsoft.com/dotnet/api/system.decimal";>decimal</a>. <a
class="xref"
href="https://learn.microsoft.com/dotnet/api/system.decimal";>decimal</a> is a
128-bit
+floating point value with a 5 bit base-10 exponent and a 96-bit base-10
mantissa. Decimal256
+is a fixed point 256 bit value where up to 256 bits can be used for the
mantissa, and both
+the number of bits and the exponent are determined by the array's type (which
is out-of-band).
+This means that a <a class="xref"
href="Apache.Arrow.Types.Decimal256Type.html">Decimal256Type</a> whose
precision minus scale is greater than 28
+might produce an overflow when stored as a .NET decimal. It may also cause
rounding for
+precisions greater than 28. These will silently succeed.</p>
+</div>
+ <div class="markdown level1 conceptual"></div>
+
+ <div class="codewrapper">
+ <pre><code class="lang-csharp hljs">public bool TryGetValue(int index, out
decimal? value)</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>value</code> <a class="xref"
href="https://learn.microsoft.com/dotnet/api/system.decimal";>decimal</a>?</dt>
+ <dd></dd>
+ </dl>
+
+ <h4 class="section">Returns</h4>
+ <dl class="parameters">
+ <dt><a class="xref"
href="https://learn.microsoft.com/dotnet/api/system.boolean";>bool</a></dt>
+ <dd></dd>
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
</article>
diff --git a/main/index.json b/main/index.json
index 6c1c6e4..8c371d9 100644
--- a/main/index.json
+++ b/main/index.json
@@ -252,7 +252,7 @@
"api/Apache.Arrow.Decimal128Array.html": {
"href": "api/Apache.Arrow.Decimal128Array.html",
"title": "Class Decimal128Array | Apache Arrow .NET",
- "summary": "Class Decimal128Array Namespace Apache.Arrow Assembly
Apache.Arrow.dll public class Decimal128Array : FixedSizeBinaryArray,
IArrowArray, IDisposable, IReadOnlyList<byte[]>, IReadOnlyCollection<byte[]>,
IEnumerable<byte[]>, IReadOnlyList<SqlDecimal?>,
IReadOnlyCollection<SqlDecimal?>, IEnumerable<SqlDecimal?>, IEnumerable
Inheritance object Array FixedSizeBinaryArray Decimal128Array Implements
IArrowArray IDisposable IReadOnlyList<byte[]> IReadOnlyCollection<byte[]>
IEnume [...]
+ "summary": "Class Decimal128Array Namespace Apache.Arrow Assembly
Apache.Arrow.dll public class Decimal128Array : FixedSizeBinaryArray,
IArrowArray, IDisposable, IReadOnlyList<byte[]>, IReadOnlyCollection<byte[]>,
IEnumerable<byte[]>, IReadOnlyList<SqlDecimal?>,
IReadOnlyCollection<SqlDecimal?>, IEnumerable<SqlDecimal?>, IEnumerable
Inheritance object Array FixedSizeBinaryArray Decimal128Array Implements
IArrowArray IDisposable IReadOnlyList<byte[]> IReadOnlyCollection<byte[]>
IEnume [...]
},
"api/Apache.Arrow.Decimal256Array.Builder.html": {
"href": "api/Apache.Arrow.Decimal256Array.Builder.html",
@@ -262,7 +262,7 @@
"api/Apache.Arrow.Decimal256Array.html": {
"href": "api/Apache.Arrow.Decimal256Array.html",
"title": "Class Decimal256Array | Apache Arrow .NET",
- "summary": "Class Decimal256Array Namespace Apache.Arrow Assembly
Apache.Arrow.dll public class Decimal256Array : FixedSizeBinaryArray,
IArrowArray, IDisposable, IReadOnlyList<byte[]>, IReadOnlyCollection<byte[]>,
IEnumerable<byte[]>, IReadOnlyList<SqlDecimal?>,
IReadOnlyCollection<SqlDecimal?>, IEnumerable<SqlDecimal?>,
IReadOnlyList<string?>, IReadOnlyCollection<string?>, IEnumerable<string?>,
IEnumerable Inheritance object Array FixedSizeBinaryArray Decimal256Array
Implements IArr [...]
+ "summary": "Class Decimal256Array Namespace Apache.Arrow Assembly
Apache.Arrow.dll public class Decimal256Array : FixedSizeBinaryArray,
IArrowArray, IDisposable, IReadOnlyList<byte[]>, IReadOnlyCollection<byte[]>,
IEnumerable<byte[]>, IReadOnlyList<SqlDecimal?>,
IReadOnlyCollection<SqlDecimal?>, IEnumerable<SqlDecimal?>,
IReadOnlyList<string?>, IReadOnlyCollection<string?>, IEnumerable<string?>,
IEnumerable Inheritance object Array FixedSizeBinaryArray Decimal256Array
Implements IArr [...]
},
"api/Apache.Arrow.Decimal32Array.Builder.html": {
"href": "api/Apache.Arrow.Decimal32Array.Builder.html",
diff --git a/main/xrefmap.yml b/main/xrefmap.yml
index 4745901..a63f568 100644
--- a/main/xrefmap.yml
+++ b/main/xrefmap.yml
@@ -5207,6 +5207,22 @@ references:
isSpec: "True"
fullName: Apache.Arrow.Decimal128Array.ToList
nameWithType: Decimal128Array.ToList
+- uid:
Apache.Arrow.Decimal128Array.TryGetValue(System.Int32,System.Nullable{System.Decimal}@)
+ name: TryGetValue(int, out decimal?)
+ href:
api/Apache.Arrow.Decimal128Array.html#Apache_Arrow_Decimal128Array_TryGetValue_System_Int32_System_Nullable_System_Decimal___
+ commentId:
M:Apache.Arrow.Decimal128Array.TryGetValue(System.Int32,System.Nullable{System.Decimal}@)
+ name.vb: TryGetValue(Integer, Decimal?)
+ fullName: Apache.Arrow.Decimal128Array.TryGetValue(int, out decimal?)
+ fullName.vb: Apache.Arrow.Decimal128Array.TryGetValue(Integer, Decimal?)
+ nameWithType: Decimal128Array.TryGetValue(int, out decimal?)
+ nameWithType.vb: Decimal128Array.TryGetValue(Integer, Decimal?)
+- uid: Apache.Arrow.Decimal128Array.TryGetValue*
+ name: TryGetValue
+ href:
api/Apache.Arrow.Decimal128Array.html#Apache_Arrow_Decimal128Array_TryGetValue_
+ commentId: Overload:Apache.Arrow.Decimal128Array.TryGetValue
+ isSpec: "True"
+ fullName: Apache.Arrow.Decimal128Array.TryGetValue
+ nameWithType: Decimal128Array.TryGetValue
- uid: Apache.Arrow.Decimal256Array
name: Decimal256Array
href: api/Apache.Arrow.Decimal256Array.html
@@ -5480,6 +5496,22 @@ references:
isSpec: "True"
fullName: Apache.Arrow.Decimal256Array.TryGetSqlDecimal
nameWithType: Decimal256Array.TryGetSqlDecimal
+- uid:
Apache.Arrow.Decimal256Array.TryGetValue(System.Int32,System.Nullable{System.Decimal}@)
+ name: TryGetValue(int, out decimal?)
+ href:
api/Apache.Arrow.Decimal256Array.html#Apache_Arrow_Decimal256Array_TryGetValue_System_Int32_System_Nullable_System_Decimal___
+ commentId:
M:Apache.Arrow.Decimal256Array.TryGetValue(System.Int32,System.Nullable{System.Decimal}@)
+ name.vb: TryGetValue(Integer, Decimal?)
+ fullName: Apache.Arrow.Decimal256Array.TryGetValue(int, out decimal?)
+ fullName.vb: Apache.Arrow.Decimal256Array.TryGetValue(Integer, Decimal?)
+ nameWithType: Decimal256Array.TryGetValue(int, out decimal?)
+ nameWithType.vb: Decimal256Array.TryGetValue(Integer, Decimal?)
+- uid: Apache.Arrow.Decimal256Array.TryGetValue*
+ name: TryGetValue
+ href:
api/Apache.Arrow.Decimal256Array.html#Apache_Arrow_Decimal256Array_TryGetValue_
+ commentId: Overload:Apache.Arrow.Decimal256Array.TryGetValue
+ isSpec: "True"
+ fullName: Apache.Arrow.Decimal256Array.TryGetValue
+ nameWithType: Decimal256Array.TryGetValue
- uid: Apache.Arrow.Decimal32Array
name: Decimal32Array
href: api/Apache.Arrow.Decimal32Array.html
