You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datafusion.apache.org by gi...@apache.org on 2026/10/14 22:02:32 UTC

(datafusion) branch gh-readonly-queue/main/pr-26224-61766adfe8b982434032b45338e7d7970735b4cb created (now 5f3b4662a3)

This is an automated email from the ASF dual-hosted git repository.

github-merge-queue[bot] pushed a change to branch gh-readonly-queue/main/pr-26224-61766adfe8b982434032b45338e7d7970735b4cb
in repository https://gitbox.apache.org/repos/asf/datafusion.git


      at 5f3b4662a3 docs: document ^ as the bitwise xor operator (#26224)

This branch includes the following new commits:

     new 5f3b4662a3 docs: document ^ as the bitwise xor operator (#26224)

The 1 revisions listed above as "new" are entirely new to this
repository and will be described in separate emails.  The revisions
listed as "add" were already present in the repository and have only
been added to this reference.



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datafusion.apache.org
For additional commands, e-mail: commits-help@datafusion.apache.org


(datafusion) 01/01: docs: document ^ as the bitwise xor operator (#26224)

Posted by gi...@apache.org.
This is an automated email from the ASF dual-hosted git repository.

github-merge-queue[bot] pushed a commit to branch gh-readonly-queue/main/pr-26224-61766adfe8b982434032b45338e7d7970735b4cb
in repository https://gitbox.apache.org/repos/asf/datafusion.git

commit 5f3b4662a31884076451446c733607f84ce6beac
Author: Roshan Ramani <15...@users.noreply.github.com>
AuthorDate: Wed Oct 14 20:33:50 2026 +0000

    docs: document ^ as the bitwise xor operator (#26224)
    
    ## Which issue does this PR close?
    
    <!--
    We generally require a GitHub issue to be filed for all bug fixes and
    enhancements and this helps us generate change logs for our releases.
    You can link an issue to this PR using the GitHub syntax. For example
    `Closes #123` indicates that this PR will close issue #123.
    -->
    
    - None; documentation fix. Follows up #22314.
    
    ## Rationale for this change
    
    <!--
    Why are you proposing this change? If this is already explained clearly
    in the issue then this section is not needed.
    Explaining clearly why changes are proposed helps reviewers understand
    your changes and offer better suggestions for fixes.
    
    Please explain the problem you are trying to solve in terms of the
    user-visible
    behavior, rather than the implementation.
    
    For example, "The code in `foo.rs` doesn't handle nulls" is a symptom of
    the
    implementation. "COUNT(DISTINCT) returns wrong results when the column
    contains
    nulls" is the user-visible problem.
    -->
    
    The operators page documents `#` as bitwise xor, "interchangeable with
    `^`". On `main`, `SELECT 5 # 3;` fails with the default dialect
    (`ParserError("No infix parser for token Sharp ...")`); `#` is only xor
    in the PostgreSQL and Redshift dialects. The page describes the default
    dialect, where `^` is xor.
    
    ## What changes are included in this PR?
    
    <!--
    There is no need to duplicate the description in the issue here, but it
    is sometimes worth providing a summary of the individual changes in this
    PR.
    -->
    
    The xor section and its index entry now document `^` instead of `#`,
    with the current column name (`BIT_XOR`) in the example output. Per
    review, the page sticks to the default dialect rather than listing
    per-dialect exceptions.
    
    ## What is the testing strategy for this PR?
    
    <!--
    We typically require tests for all PRs in order to:
    1. Prevent the code from being accidentally broken by subsequent changes
    2. Serve as another way to document the expected behavior of the code
    
    Briefly describe how this PR is tested, and point to the specific tests
    you added. For example: 'This new feature is covered by the
    `sqllogictest` cases added in `foo.slt`'.
    
    If this PR does not add tests, explain why. For example, if the change
    is already covered by existing tests, please mention it.
    
    You should also check the `codecov` bot reply on this PR to confirm the
    changed code is exercised.
    -->
    
    Ran the new example against `datafusion-cli` built from `main`;
    `./ci/scripts/doc_prettier_check.sh` passes. Docs only, no test.
    
    ## Are there any user-facing changes?
    
    <!--
    If there are user-facing changes then we may require documentation to be
    updated before approving the PR.
    
    If there are any breaking changes to public APIs, please add the `api
    change` label.
    -->
    
    Documentation only.
    
    Generated with Claude Code (claude-opus-5-5). It came from running the
    documented SQL examples against `main`, not from an issue.
---
 docs/source/user-guide/sql/operators.md | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/docs/source/user-guide/sql/operators.md b/docs/source/user-guide/sql/operators.md
index b63f552396..de706cc21f 100644
--- a/docs/source/user-guide/sql/operators.md
+++ b/docs/source/user-guide/sql/operators.md
@@ -423,7 +423,7 @@ Logical Or
 
 - [& (bitwise and)](#op_bit_and)
 - [| (bitwise or)](#op_bit_or)
-- [# (bitwise xor)](#op_bit_xor)
+- [^ (bitwise xor)](#op_bit_xor)
 - [>> (bitwise shift right)](#op_shift_r)
 - [<< (bitwise shift left)](#op_shift_l)
 
@@ -459,17 +459,17 @@ Bitwise Or
 
 (op_bit_xor)=
 
-### `#`
+### `^`
 
-Bitwise Xor (interchangeable with `^`)
+Bitwise Xor
 
 ```sql
-> SELECT 5 # 3;
-+---------------------+
-| Int64(5) # Int64(3) |
-+---------------------+
-| 6                   |
-+---------------------+
+> SELECT 5 ^ 3;
++---------------------------+
+| Int64(5) BIT_XOR Int64(3) |
++---------------------------+
+| 6                         |
++---------------------------+
 ```
 
 (op_shift_r)=


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datafusion.apache.org
For additional commands, e-mail: commits-help@datafusion.apache.org