From e3964e3dea051dc27ee117a066be858a1e71f8c0 Mon Sep 17 00:00:00 2001 From: Joel Lubinitsky Date: Mon, 15 Jul 2024 13:20:25 -0400 Subject: [PATCH 1/5] add to doc --- docs/source/format/CanonicalExtensions.rst | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/source/format/CanonicalExtensions.rst b/docs/source/format/CanonicalExtensions.rst index 1d86fcf23c4..a2cf14e5bdc 100644 --- a/docs/source/format/CanonicalExtensions.rst +++ b/docs/source/format/CanonicalExtensions.rst @@ -393,6 +393,28 @@ Examples: {"type_name": "OTHER", "vendor_name": "JDBC driver name"} +8-bit Boolean +==== + +Bool8 represents a boolean value using 1 byte (8 bits) to store each value instead of only 1 bit as in +the native Arrow Boolean type. Although less compact that the native representation, Bool8 may have +better zero-copy compatibility with various systems that also store booleans using 1 byte. + +* Extension name: ``arrow.bool8``. + +* The storage type of this extension is ``Int8`` where: + + * **false** is denoted by the value ``0``. + * **true** can be specified using any non-zero value. + +* Extension type parameters: + + This type does not have any parameters. + +* Description of the serialization: + + No metadata is required to interpret the type. Any metadata present should be ignored. + ========================= Community Extension Types ========================= From 6b53511ac5b6bdda64e05c9ebcd3a8cf5dfd8dc0 Mon Sep 17 00:00:00 2001 From: Joel Lubinitsky Date: Wed, 17 Jul 2024 07:28:52 -0400 Subject: [PATCH 2/5] doc formatting --- docs/source/format/CanonicalExtensions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/format/CanonicalExtensions.rst b/docs/source/format/CanonicalExtensions.rst index a2cf14e5bdc..ba99c42cb43 100644 --- a/docs/source/format/CanonicalExtensions.rst +++ b/docs/source/format/CanonicalExtensions.rst @@ -394,7 +394,7 @@ Examples: {"type_name": "OTHER", "vendor_name": "JDBC driver name"} 8-bit Boolean -==== +============= Bool8 represents a boolean value using 1 byte (8 bits) to store each value instead of only 1 bit as in the native Arrow Boolean type. Although less compact that the native representation, Bool8 may have From c0bd7e97953590e948fdd7b845d1139cc824cb56 Mon Sep 17 00:00:00 2001 From: Joel Lubinitsky <33523178+joellubi@users.noreply.github.com> Date: Fri, 19 Jul 2024 12:24:45 -0400 Subject: [PATCH 3/5] Update docs/source/format/CanonicalExtensions.rst Co-authored-by: Felipe Oliveira Carvalho --- docs/source/format/CanonicalExtensions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/format/CanonicalExtensions.rst b/docs/source/format/CanonicalExtensions.rst index ba99c42cb43..92d2cc08abb 100644 --- a/docs/source/format/CanonicalExtensions.rst +++ b/docs/source/format/CanonicalExtensions.rst @@ -405,7 +405,7 @@ better zero-copy compatibility with various systems that also store booleans usi * The storage type of this extension is ``Int8`` where: * **false** is denoted by the value ``0``. - * **true** can be specified using any non-zero value. + * **true** can be specified using any non-zero value. Preferably ``1``. * Extension type parameters: From f87061d2919987f15247dd2c3c7b83134db1a163 Mon Sep 17 00:00:00 2001 From: Joel Lubinitsky Date: Thu, 25 Jul 2024 14:38:56 -0400 Subject: [PATCH 4/5] fix wording and typo --- docs/source/format/CanonicalExtensions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/format/CanonicalExtensions.rst b/docs/source/format/CanonicalExtensions.rst index 92d2cc08abb..cc8f9519786 100644 --- a/docs/source/format/CanonicalExtensions.rst +++ b/docs/source/format/CanonicalExtensions.rst @@ -397,7 +397,7 @@ Examples: ============= Bool8 represents a boolean value using 1 byte (8 bits) to store each value instead of only 1 bit as in -the native Arrow Boolean type. Although less compact that the native representation, Bool8 may have +the original Arrow Boolean type. Although less compact than the original representation, Bool8 may have better zero-copy compatibility with various systems that also store booleans using 1 byte. * Extension name: ``arrow.bool8``. From 315c2431cac0685ed01b55e7b49bb140998e7062 Mon Sep 17 00:00:00 2001 From: Joel Lubinitsky Date: Mon, 5 Aug 2024 13:22:30 -0400 Subject: [PATCH 5/5] more specific serialization --- docs/source/format/CanonicalExtensions.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/format/CanonicalExtensions.rst b/docs/source/format/CanonicalExtensions.rst index cc8f9519786..5658f949cee 100644 --- a/docs/source/format/CanonicalExtensions.rst +++ b/docs/source/format/CanonicalExtensions.rst @@ -413,7 +413,7 @@ better zero-copy compatibility with various systems that also store booleans usi * Description of the serialization: - No metadata is required to interpret the type. Any metadata present should be ignored. + Metadata is an empty string. ========================= Community Extension Types