Replace repartition execs with sort preserving repartition execs (#6921)

* initialize replace_repartition_execs rule for SortPreservingRepartitionExec optimization
typo fix

* fix linter checks

* use common idioms
fix the inter children replacement issue
simplify replacement logic
use ordering_satisfy to compare orderings

* fix ordering satisfy parameters according to provided output orderings

* add Result wrappings on functions
aggresively replace repartitions and do the check on final step

* update RepartitionExec and HashJoinExec strings

* update the documentation
remove the unwrap method by using children() for sort exec

* use .any for checking input order maintaining

* Use existing order preserving RepartitionExec instead of dummy

* Move rule to function

* Simplifications

* Remove sub-sule from enforce sorting

* Run replace repartition for fixing pipeline

* Comment improvements

* Update comments

* Better commenting

* Address reviews

* Change test so that it doesn't contain unnecessary executor

---------

Co-authored-by: Mustafa Akur <[email protected]>
Co-authored-by: Mehmet Ozan Kabak <[email protected]>

Author: 3 people

datafusion/core/src/physical_optimizer/mod.rs

@@ -31,6 +31,7 @@ pub mod optimizer;
 pub mod pipeline_checker;
 pub mod pruning;
 pub mod repartition;
+pub mod replace_repartition_execs;
 pub mod sort_enforcement;
 mod sort_pushdown;
 mod utils;