Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GH-33592: [C++] support casting nullable fields to non-nullable if there are no null values #43782

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

NickCrews
Copy link
Contributor

@NickCrews NickCrews commented Aug 21, 2024

Notes for myself/fixer:

  • tests that need to get updated (almost definitely not a complete list)
  • [update: actually we should handle the go implementation in the go repository.] hmm, looks like go wrapper does its own nullability checks. I assume this is just an optimization to not have to go into the C++ and hit the error down there. So if we just delete this check then I think the C++ logic will handle all of it???
  • how the plain column handles this cast, some logic like this probably needs to get ported over to the struct implementation
  • (running from /cpp/build) cmake .. --preset ninja-debug-basic, then cmake --build . && PYTHON=python ctest -R 'arrow-compute-scalar-cast-test' --output-on-failure to run the specific test
  • to format: uvx pre-commit run --all-files clang-format

Copy link

Thanks for opening a pull request!

If this is not a minor PR. Could you open an issue for this pull request on GitHub? https://github.com/apache/arrow/issues/new/choose

Opening GitHub issues ahead of time contributes to the Openness of the Apache Arrow project.

Then could you also rename the pull request title in the following format?

GH-${GITHUB_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}

or

MINOR: [${COMPONENT}] ${SUMMARY}

In the case of PARQUET issues on JIRA the title also supports:

PARQUET-${JIRA_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}

See also:

@NickCrews NickCrews changed the title [C++][Go]: support casting nullable fields to non-nullable if there are no null values GH-33592 [C++][Go]: support casting nullable fields to non-nullable if there are no null values Aug 21, 2024
Copy link

⚠️ GitHub issue #33592 has been automatically assigned in GitHub to PR creator.

@NickCrews NickCrews force-pushed the field-cast-nullable-to-nonnullable branch 3 times, most recently from 52100dd to 49d5a99 Compare August 22, 2024 00:40
@rustyconover
Copy link

This PR looks pretty good to me, what additional help would you like getting it merged?

@NickCrews
Copy link
Contributor Author

Thanks for the help! I'm a random contributor, so I'm not sure about the exact workflow, but I think both getting the CI run approved and having a C++ owner approve it are needed.

Any more detailed thoughts on if the tests are adequate, if there's anywhere else in the code base that you think needs to change, my handling of the go implementation by just deleting the shortcircuit, or any other more detailed thoughts? Basically anything that would reduce the mental load on the code owner I think would increase the odds they approve it :)

@mapleFU
Copy link
Member

mapleFU commented Sep 15, 2024

You can mark as ready for review? Or this is still wip?

@NickCrews NickCrews marked this pull request as ready for review September 15, 2024 20:11
@NickCrews
Copy link
Contributor Author

Oops, didn't mean for this to still be marked WIP. Looks like a few failures that need to get fixed, but still a high-level review of the general approach would still be appreciated in the meantime.

@zeroshade
Copy link
Member

You probably need the same corresponding check on the Go side to verify that it's only allowed if there are no nulls.

Also, the Go implementation has been moved to the apache/arrow-go repository. So please file the PR there for the Go side. Sorry for the confusion, we just haven't removed the Go code from here yet.

@NickCrews
Copy link
Contributor Author

Thanks @zeroshade , will do. Do we need both PRs to land at about the same time, or can I do that independently?

I will undo my changes to the go code here, leaving it untouched.

@zeroshade
Copy link
Member

They can land independently, no issues there. Thanks!

@NickCrews NickCrews force-pushed the field-cast-nullable-to-nonnullable branch from 49d5a99 to eb9e7b6 Compare September 16, 2024 16:27
@NickCrews
Copy link
Contributor Author

Just pushed a new version:

  • dropped the Go changes
  • rebased on top of 3600db8, which is one commit behind main, because main is failing CI, but the commit I chose passed CI. I did this because I think the failing CI checks in this PR are not related to this PR
  • I discovered archery and formatted the files with archery lint --clang-format --fix

We will see if this passes CI now...

@NickCrews NickCrews force-pushed the field-cast-nullable-to-nonnullable branch from eb9e7b6 to e6d54d3 Compare September 18, 2024 07:49
@NickCrews
Copy link
Contributor Author

Pushed a new version, hopefully that fixed the broken tests:

  • To go from nullable to non-nullable type, need to use the unsafe cast option
  • fix typo of int8 to int64 so the precision matches
  • removed the [Go] tag from the commit message

@NickCrews
Copy link
Contributor Author

@zeroshade I think this is ready to review/merge, the failing CI runs look like flakes when trying to setup the environment?

@kou
Copy link
Member

kou commented Sep 19, 2024

Can we move this to apache/arrow-go?

@kou kou changed the title GH-33592 [C++][Go]: support casting nullable fields to non-nullable if there are no null values GH-33592: [C++] support casting nullable fields to non-nullable if there are no null values Sep 19, 2024
@kou
Copy link
Member

kou commented Sep 19, 2024

Ah, the Go part was removed from this PR.
I've removed "[Go]" from the PR title.

@NickCrews NickCrews force-pushed the field-cast-nullable-to-nonnullable branch from e6d54d3 to 106e627 Compare September 24, 2024 18:53
@NickCrews NickCrews force-pushed the field-cast-nullable-to-nonnullable branch 4 times, most recently from fdb99d1 to 1b2c940 Compare December 13, 2024 10:19
@NickCrews
Copy link
Contributor Author

The current CI failures look to be caused by #44985 (or similar), not by this PR.

I rebased on main, everything looks pretty much the same as before.

@zeroshade can you give this a review when you get the chance, or let me know how I can make it easier for you to do so? @rustyconover if you want to take a look again, maybe that will help. Thank you both!

Copy link
Contributor

@zanmato1984 zanmato1984 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A small question about null count checking.

cpp/src/arrow/compute/kernels/scalar_cast_nested.cc Outdated Show resolved Hide resolved
@github-actions github-actions bot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Dec 18, 2024
if (field_index == kFillNullSentinel) {
ARROW_ASSIGN_OR_RAISE(auto nulls,
MakeArrayOfNull(target_type->GetSharedPtr(), batch.length));
out_array->child_data.push_back(nulls->data());
} else {
const auto& values = (in_array.child_data[field_index].ToArrayData()->Slice(
in_array.offset, in_array.length));
if (!target_field->nullable() && values->null_count > 0) {
return Status::TypeError("field '", target_field->name(),
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Besides, should we discard the buffer[0] if new data doesn't contains any nulls?

Copy link
Contributor Author

@NickCrews NickCrews Feb 5, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mapleFU can you elaborate a little more? I don't think I understand neither why we should do this, or how. Does buffer[0] contain the null bitmap, and if there are no nulls then we can get away without storing one??

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ignore me, i previously think we can

        auto values = (in_array.child_data[field_index].ToArrayData()->Slice(
            in_array.offset, in_array.length));
       if (out field not nullable but in field nullable) {
          if (values->GetNullCount() > 0) {
             return error
          }
          values->buffers[0].reset();
       }

But I also think this doesn't matter here

@NickCrews NickCrews force-pushed the field-cast-nullable-to-nonnullable branch 3 times, most recently from f159275 to 40ae139 Compare February 5, 2025 23:02
@NickCrews
Copy link
Contributor Author

@pitrou @mapleFU I applied your two suggestions, and I think this is ready for review again. Still one outstanding question about buffer[0]. CI is passing, except for one flaky test that failed during git checkout.

@NickCrews NickCrews force-pushed the field-cast-nullable-to-nonnullable branch from 40ae139 to ed9b368 Compare February 7, 2025 01:36
@NickCrews NickCrews force-pushed the field-cast-nullable-to-nonnullable branch from ed9b368 to 56c0d88 Compare February 7, 2025 06:29
Copy link
Member

@mapleFU mapleFU left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

General LGTM!

cpp/src/arrow/compute/kernels/scalar_cast_test.cc Outdated Show resolved Hide resolved
@NickCrews NickCrews closed this Feb 7, 2025
@NickCrews NickCrews force-pushed the field-cast-nullable-to-nonnullable branch from 56c0d88 to 9016a83 Compare February 7, 2025 06:34
@NickCrews NickCrews reopened this Feb 7, 2025
@NickCrews
Copy link
Contributor Author

whoops, I accidentally force-pushed with no changes, which closed the PR. Now it's back up

@NickCrews NickCrews force-pushed the field-cast-nullable-to-nonnullable branch from b124c64 to ebe9a5a Compare February 7, 2025 08:01
@NickCrews
Copy link
Contributor Author

@mapleFU as I added the slicing tests, I also refactored the tests to make them much more consistent and concise. Take another look and make sure that your "LGTM" still holds after those changes.

Copy link
Member

@pitrou pitrou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a nit!

Comment on lines +416 to +419
return Status::Invalid("field '", in_field->name(), "' of type ",
in_field_type->ToString(),
" has nulls. Can't cast to field '", out_field->name(),
"' of non-nullable type ", out_field_type->ToString());
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's the field that's non-nullable

Suggested change
return Status::Invalid("field '", in_field->name(), "' of type ",
in_field_type->ToString(),
" has nulls. Can't cast to field '", out_field->name(),
"' of non-nullable type ", out_field_type->ToString());
return Status::Invalid("field '", in_field->name(), "' of type ",
in_field_type->ToString(),
" has nulls. Can't cast to non-nullable field '",
out_field->name(), "' of type ",
out_field_type->ToString());

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants