vibhatha commented on a change in pull request #12033: URL: https://github.com/apache/arrow/pull/12033#discussion_r778483804
########## File path: cpp/examples/arrow/execution_plan_documentation_examples.cc ########## @@ -0,0 +1,1234 @@ +// Licensed to the Apache Software Foundation (ASF) under one +// or more contributor license agreements. See the NOTICE file +// distributed with this work for additional information +// regarding copyright ownership. The ASF licenses this file +// to you under the Apache License, Version 2.0 (the +// "License"); you may not use this file except in compliance +// with the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, +// software distributed under the License is distributed on an +// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +// KIND, either express or implied. See the License for the +// specific language governing permissions and limitations +// under the License. + +#include <memory> +#include <utility> + +#include <arrow/compute/api.h> +#include <arrow/compute/api_scalar.h> +#include <arrow/compute/api_vector.h> +#include <arrow/compute/cast.h> +#include <arrow/compute/exec/exec_plan.h> +#include <arrow/compute/exec/ir_consumer.h> +#include <arrow/compute/exec/test_util.h> + +#include <arrow/csv/api.h> + +#include <arrow/dataset/dataset.h> +#include <arrow/dataset/file_parquet.h> +#include <arrow/dataset/file_base.h> +#include <arrow/dataset/plan.h> +#include <arrow/dataset/scanner.h> +#include <arrow/dataset/dataset_writer.h> + +#include <arrow/io/interfaces.h> +#include <arrow/io/memory.h> +#include <arrow/io/slow.h> +#include <arrow/io/transform.h> +#include <arrow/io/stdio.h> + +#include "arrow/json/api.h" + +#include <arrow/result.h> +#include <arrow/status.h> +#include <arrow/table.h> + +#include <arrow/ipc/api.h> + +#include <arrow/util/future.h> +#include <arrow/util/range.h> +#include <arrow/util/thread_pool.h> +#include <arrow/util/vector.h> + +// Demonstrate various operators in Arrow Streaming Execution Engine + +#define ABORT_ON_FAILURE(expr) \ + do { \ + arrow::Status status_ = (expr); \ + if (!status_.ok()) { \ + std::cerr << status_.message() << std::endl; \ + abort(); \ + } \ + } while (0); + +#define CHECK_AND_RETURN(expr) \ + do { \ + arrow::Status status_ = (expr); \ + if (!status_.ok()) { \ + std::cerr << status_.message() << std::endl; \ + return EXIT_FAILURE; \ + } else { \ + return EXIT_SUCCESS; \ + } \ + } while (0); + +#define CHECK_AND_CONTINUE(expr) \ + do { \ + arrow::Status status_ = (expr); \ + if (!status_.ok()) { \ + std::cerr << status_.message() << std::endl; \ + return EXIT_FAILURE; \ + } \ + } while (0); + +constexpr char kSep[] = "******"; + +#define PRINT_BLOCK(msg) \ + std::cout << "" << std::endl; \ + std::cout << "\t" << kSep << " " << msg << " " << kSep << std::endl; \ + std::cout << "" << std::endl; + +namespace cp = ::arrow::compute; + +std::shared_ptr<arrow::Array> GetArrayFromJSON( + const std::shared_ptr<arrow::DataType>& type, arrow::util::string_view json) { + std::shared_ptr<arrow::Array> out; + ABORT_ON_FAILURE(arrow::ipc::internal::json::ArrayFromJSON(type, json, &out)); + return out; +} + +std::shared_ptr<arrow::RecordBatch> GetRecordBatchFromJSON( + const std::shared_ptr<arrow::Schema>& schema, arrow::util::string_view json) { + // Parse as a StructArray + auto struct_type = struct_(schema->fields()); + std::shared_ptr<arrow::Array> struct_array = GetArrayFromJSON(struct_type, json); + + // Convert StructArray to RecordBatch + return *arrow::RecordBatch::FromStructArray(struct_array); +} + +std::string GetDataAsCsvString() { + std::string data_str = R"csv(a,b +1,null +2,true +null,true +3,false +null,true +4,false +5,null +6,false +7,false +8,true +)csv"; + return data_str; +} +// TODO: Replace the GetArrayDataSample with tempates +arrow::Result<std::shared_ptr<arrow::Array>> GetInt32ArrayDataSample( + const std::vector<int> &int_values) { + arrow::Int32Builder int32_builder; + ABORT_ON_FAILURE(int32_builder.Reserve(int_values.size())); + std::shared_ptr<arrow::Int32Array> int32_array; + ABORT_ON_FAILURE(int32_builder.AppendValues(int_values)); + ABORT_ON_FAILURE(int32_builder.Finish(&int32_array)); + + arrow::Result<std::shared_ptr<arrow::Int32Array>> result(std::move(int32_array)); + + return result; +} + +arrow::Result<std::shared_ptr<arrow::Array>> GetBoolArrayDataSample( + const std::vector<uint8_t> &bool_values) { + arrow::BooleanBuilder boolean_builder; + ABORT_ON_FAILURE(boolean_builder.Reserve(bool_values.size())); + std::shared_ptr<arrow::BooleanArray> boolean_array; + ABORT_ON_FAILURE(boolean_builder.AppendValues(bool_values)); + ABORT_ON_FAILURE(boolean_builder.Finish(&boolean_array)); + + arrow::Result<std::shared_ptr<arrow::BooleanArray>> result(std::move(boolean_array)); + return result; +} + +arrow::Result<std::shared_ptr<arrow::Array>> GetUtf8ArrayDataSample( + const std::vector<uint8_t> &bool_values) { + arrow::BooleanBuilder boolean_builder; + ABORT_ON_FAILURE(boolean_builder.Reserve(bool_values.size())); + std::shared_ptr<arrow::BooleanArray> boolean_array; + ABORT_ON_FAILURE(boolean_builder.AppendValues(bool_values)); + ABORT_ON_FAILURE(boolean_builder.Finish(&boolean_array)); + + arrow::Result<std::shared_ptr<arrow::BooleanArray>> result(std::move(boolean_array)); + return result; +} + + +arrow::Result<std::shared_ptr<arrow::RecordBatch>> GetSampleRecordBatch( + const arrow::ArrayVector array_vector, +const arrow::FieldVector &field_vector) { + std::shared_ptr<arrow::RecordBatch> record_batch; + ARROW_ASSIGN_OR_RAISE(auto struct_result, + arrow::StructArray::Make(array_vector, field_vector)); + return record_batch->FromStructArray(struct_result); +} + +arrow::Result<std::shared_ptr<arrow::RecordBatch>> GetIntSampleRecordBatch( + const std::vector<int> &int_values, const arrow::FieldVector &field_vector) { + std::shared_ptr<arrow::RecordBatch> record_batch; + ARROW_ASSIGN_OR_RAISE(auto int32_array, GetInt32ArrayDataSample(int_values)); + ARROW_ASSIGN_OR_RAISE(auto struct_result, + arrow::StructArray::Make({int32_array}, field_vector)); + return record_batch->FromStructArray(struct_result); +} + + + +arrow::Status CreateDataSetFromCSVData( + std::shared_ptr<arrow::dataset::InMemoryDataset> &dataset) { + arrow::io::IOContext io_context = arrow::io::default_io_context(); + std::shared_ptr<arrow::io::InputStream> input; + std::string csv_data = GetDataAsCsvString(); + arrow::util::string_view sv = csv_data; + input = std::make_shared<arrow::io::BufferReader>(sv); + + auto read_options = arrow::csv::ReadOptions::Defaults(); + auto parse_options = arrow::csv::ParseOptions::Defaults(); + auto convert_options = arrow::csv::ConvertOptions::Defaults(); + + // Instantiate TableReader from input stream and options + ARROW_ASSIGN_OR_RAISE(std::shared_ptr<arrow::csv::TableReader> table_reader, + arrow::csv::TableReader::Make(io_context, + input, + read_options, + parse_options, + convert_options)); + + std::shared_ptr<arrow::csv::TableReader> reader = table_reader; + + // Read table from CSV file + ARROW_ASSIGN_OR_RAISE(auto maybe_table, + reader->Read()); + auto ds = std::make_shared<arrow::dataset::InMemoryDataset>(maybe_table); + dataset = std::move(ds); + return arrow::Status::OK(); +} + +std::shared_ptr<arrow::dataset::Dataset> CreateDataset() { + std::shared_ptr<arrow::dataset::InMemoryDataset> im_dataset; + ABORT_ON_FAILURE(CreateDataSetFromCSVData(im_dataset)); + return im_dataset; +} + +arrow::Status exec_plan_end_to_end_sample() { + cp::ExecContext exec_context(arrow::default_memory_pool(), + ::arrow::internal::GetCpuThreadPool()); + + // ensure arrow::dataset node factories are in the registry + arrow::dataset::internal::Initialize(); + + ARROW_ASSIGN_OR_RAISE(std::shared_ptr<cp::ExecPlan> plan, + cp::ExecPlan::Make(&exec_context)); + + std::shared_ptr<arrow::dataset::Dataset> dataset = CreateDataset(); + + auto options = std::make_shared<arrow::dataset::ScanOptions>(); + // sync scanning is not supported by ScanNode + options->use_async = true; + // specify the filter + cp::Expression b_is_true = cp::field_ref("b"); + options->filter = b_is_true; + // for now, specify the projection as the full project expression (eventually this can + // just be a list of materialized field names) + + cp::Expression a_times_2 = cp::call("multiply", {cp::field_ref("a"), cp::literal(2)}); + options->projection = + cp::call("make_struct", {a_times_2}, cp::MakeStructOptions{{"a * 2"}}); Review comment: When this is omitted, I get an segfault. I didn't go deep into checking why? Should we analyze it for this PR? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: github-unsubscr...@arrow.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
