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-26818: [C++][Python] Preserve order when writing dataset multi-threaded #44470

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

Conversation

EnricoMi
Copy link
Contributor

@EnricoMi EnricoMi commented Oct 18, 2024

Rationale for this change

The order of rows in a dataset might be important for users and should be preserved when writing to a filesystem. With multi-threaded write, the order is currently not guaranteed,

What changes are included in this PR?

Preserving the dataset order of rows requires the SourceNode to use ImplicitOrdering (this gives exec batches an index), and the ConsumingSinkNode to sequence exec batches (preserve order of batches by their index).

User-facing changes:

  • Add option preserve_order to FileSystemDatasetWriteOptions

Dev-facing changes:

  • Add option ordering to SourceNodeOptions
  • Add option implicit_ordering to ScanNodeOptions

Default behaviour is current behaviour.

Are these changes tested?

Unit tests have been added,

Are there any user-facing changes?

Users can set FileSystemDatasetWriteOptions.preserve_order = true (C++) / arrow.dataset.write_dataset(..., preserve_order=True) (Python).

@EnricoMi EnricoMi requested a review from westonpace as a code owner October 18, 2024 11:07
Copy link

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

@gitmodimo
Copy link

This pull request seems to functionally overlap with this one. Some changes are almost exactly the same. Ordering of data is kept in threaded execution with use of batch index. Can you check whether it fixes your use case also?

@@ -103,8 +103,8 @@ class ARROW_ACERO_EXPORT SourceNodeOptions : public ExecNodeOptions {
std::shared_ptr<Schema> output_schema;
/// \brief an asynchronous stream of batches ending with std::nullopt
std::function<Future<std::optional<ExecBatch>>()> generator;

Ordering ordering = Ordering::Unordered();
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The constructor has a default value for ordering and initializes ordering with the value given to the constructor. No point for another default value here, I think.

@github-actions github-actions bot added awaiting committer review Awaiting committer review and removed awaiting review Awaiting review labels Oct 31, 2024
acero::ConsumingSinkNodeOptions{
std::move(consumer),
{},
/*sequence_output=*/write_options.preserve_order}));

Choose a reason for hiding this comment

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

TeeNode needs the same treatment

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Right, looks like this requires some refactoring, since TeeNode is not used for writing datasets I'd leave this to a separate PR.

@gitmodimo
Copy link

Since you are fixing dataset write ordering I think this check never fires. It should be moved to InsertBatch.
Also probaly AccumulationQueue, SequencingQueue and SerialSequencingQueue should be exported for acero nodes developers.

@EnricoMi
Copy link
Contributor Author

EnricoMi commented Dec 4, 2024

@gitmodimo I think that refactoring should be done in a separate PR keeping this PR focused on fixing the issue.

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

Successfully merging this pull request may close these issues.

2 participants