red-arrow-duckdb 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d9abf186818144a8c4bcd7520f9d95c13f8dc1f1aec94b1a14317e3f904f8cbb
+  data.tar.gz: 910219122fb854cd0772a1b48a53c688f67d1a597482bed2462a0eda3109b01d
+SHA512:
+  metadata.gz: 35141392b47728e0ad929d97d1afc100f137465519d7da270f44fbb07e93ed8a8bd1bcdf99f14f26371da2d2f990d48c8565ef96cc8380293d90634b95011d53
+  data.tar.gz: 0cb4e44a168f4dc92cfee10dabc938765981de4823e852f96649e6a8ffad1f61705ac5c722270ea7ba26ec2077083870c12377e1e47d1fb7442613f1598b3269

data/README.md

@@ -0,0 +1,111 @@
+# README
+
+## Name
+
+Red Arrow DuckDB
+
+## Description
+
+Red Arrow DuckDB is a library that provides Apache Arrow support to ruby-duckdb.
+
+## Install
+
+```bash
+gem install red-arrow-duckdb
+```
+
+## Usage
+
+### Receive result as Apache Arrow data
+
+```ruby
+require "arrow-duckdb"
+
+DuckDB::Database.open do |db|
+  db.connect do |connection|
+    connection.query('CREATE TABLE users (id INTEGER, name VARCHAR(30))')
+
+    connection.query("INSERT into users VALUES(1, 'Alice')")
+    connection.query("INSERT into users VALUES(2, 'Bob')")
+    connection.query("INSERT into users VALUES(3, 'Cathy')")
+
+    result = connection.query("SELECT * FROM users", output: :arrow)
+    puts(result.to_table)
+    # 	id	name
+    # 0	 1	Alice
+    # 1	 2	Bob 
+    # 2	 3	Cathy
+  end
+end
+```
+
+### Use Apache Arrow data as input
+
+```ruby
+require "arrow-duckdb"
+
+users = Arrow::Table.new("id" => [1, 2, 3],
+                         "name" => ["Alice", "Bob", "Cathy"])
+DuckDB::Database.open do |db|
+  db.connect do |connection|
+    connection.register("users", users) do
+      connection.query("SELECT * FROM users").each do |row|
+        p row
+        # ["1", "Alice"]
+        # ["2", "Bob"]
+        # ["3", "Cathy"]
+      end
+    end
+  end
+end
+```
+
+### Filter Apache Arrow data by DuckDB
+
+```ruby
+require "arrow-duckdb"
+
+users = Arrow::Table.new("id" => [1, 2, 3],
+                         "name" => ["Alice", "Bob", "Cathy"])
+DuckDB::Database.open do |db|
+  db.connect do |connection|
+    filtered_users = connection.register("users", users) do
+      result = connection.query("SELECT * FROM users WHERE id > ?",
+                                1,
+                                output: :arrow)
+      result.to_table
+    end
+    puts(filtered_users)
+    # 	id	name
+    # 0	 2	Bob 
+    # 1	 3	Cathy
+
+    # Use filtered data again
+    connection.register("filtered_users", filtered_users) do
+      result = connection.query("SELECT * FROM filtered_users",
+                                output: :arrow)
+      puts(result.to_table)
+      # 	id	name
+      # 0	 2	Bob 
+      # 1	 3	Cathy
+    end
+  end
+end
+```
+
+## Dependencies
+
+* [Red Arrow](https://github.com/apache/arrow/tree/master/ruby/red-arrow)
+
+* [ruby-duckdb](https://github.com/suketa/ruby-duckdb)
+
+## Authors
+
+* Sutou Kouhei \<kou@clear-code.com\>
+
+## License
+
+Apache License 2.0. See doc/text/apache-2.0.txt for details.
+
+(Sutou Kouhei has a right to change the license including contributed
+patches.)

data/doc/text/apache-2.0.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed 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.

data/doc/text/news.md

@@ -0,0 +1,5 @@
+# News
+
+## 1.0.0 - 2021-08-12
+
+Initial release!!!

data/ext/arrow-duckdb/arrow-duckdb-registration.cpp

@@ -0,0 +1,238 @@
+/*
+ * Copyright 2021  Sutou Kouhei <kou@clear-code.com>
+ *
+ * Licensed 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 <arrow-glib/arrow-glib.hpp>
+
+#include <arrow/c/bridge.h>
+#include <arrow/dataset/api.h>
+
+#include <rbgobject.h>
+
+#include <duckdb.hpp>
+#ifndef DUCKDB_AMALGAMATION
+#  include <duckdb.h>
+#  include <duckdb/common/arrow_wrapper.hpp>
+#  include <duckdb/function/table_function.hpp>
+#  include <duckdb/main/connection.hpp>
+#  include <duckdb/planner/filter/conjunction_filter.hpp>
+#  include <duckdb/planner/filter/constant_filter.hpp>
+#  include <duckdb/planner/table_filter.hpp>
+#endif
+
+#include "arrow-duckdb-registration.hpp"
+
+namespace {
+  std::shared_ptr<arrow::Scalar>
+  convert_constant(duckdb::Value &value)
+  {
+    switch (value.type().id()) {
+    case duckdb::LogicalTypeId::BOOLEAN:
+      return arrow::MakeScalar(value.GetValue<bool>());
+    case duckdb::LogicalTypeId::TINYINT:
+      return arrow::MakeScalar(value.GetValue<int8_t>());
+    case duckdb::LogicalTypeId::SMALLINT:
+      return arrow::MakeScalar(value.GetValue<int16_t>());
+    case duckdb::LogicalTypeId::INTEGER:
+      return arrow::MakeScalar(value.GetValue<int32_t>());
+    case duckdb::LogicalTypeId::BIGINT:
+      return arrow::MakeScalar(value.GetValue<int64_t>());
+    // case duckdb::LogicalTypeId::HUGEINT:
+    //   return arrow::MakeScalar(value.GetValue<duckdb::hugeint_t>());
+    // case duckdb::LogicalTypeId::DATE:
+    //   return arrow::MakeScalar(arrow::date32(), value.GetValue<int32_t>());
+    // case duckdb::LogicalTypeId::TIME:
+    //   return arrow::MakeScalar(arrow::time64(), value.GetValue<int64_t>());
+    // case duckdb::LogicalTypeId::TIMESTAMP:
+    //   return arrow::MakeScalar(arrow::timestamp(),
+    //                            value.GetValue<int64_t>());
+    case duckdb::LogicalTypeId::UTINYINT:
+      return arrow::MakeScalar(value.GetValue<uint8_t>());
+    case duckdb::LogicalTypeId::USMALLINT:
+      return arrow::MakeScalar(value.GetValue<uint16_t>());
+    case duckdb::LogicalTypeId::UINTEGER:
+      return arrow::MakeScalar(value.GetValue<uint32_t>());
+    case duckdb::LogicalTypeId::UBIGINT:
+      return arrow::MakeScalar(value.GetValue<uint64_t>());
+    case duckdb::LogicalTypeId::FLOAT:
+      return arrow::MakeScalar(value.GetValue<float>());
+    case duckdb::LogicalTypeId::DOUBLE:
+      return arrow::MakeScalar(value.GetValue<double>());
+    case duckdb::LogicalTypeId::VARCHAR:
+      return arrow::MakeScalar(value.ToString());
+    // case LogicalTypeId::DECIMAL:
+    default:
+      throw duckdb::NotImplementedException(
+        "[arrow][filter][pushdown] not implemented value type: %s",
+        value.type().ToString());
+    }
+  }
+
+  arrow::compute::Expression
+  convert_filter(duckdb::TableFilter *filter,
+                 std::string &column_name)
+  {
+    auto field = arrow::compute::field_ref(column_name);
+    switch (filter->filter_type) {
+    case duckdb::TableFilterType::CONSTANT_COMPARISON:
+      {
+        auto constant_filter = static_cast<duckdb::ConstantFilter *>(filter);
+        auto constant_scalar = convert_constant(constant_filter->constant);
+        auto constant = arrow::compute::literal(constant_scalar);
+        switch (constant_filter->comparison_type) {
+        case duckdb::ExpressionType::COMPARE_EQUAL:
+          return arrow::compute::equal(field, constant);
+        case duckdb::ExpressionType::COMPARE_LESSTHAN:
+          return arrow::compute::less(field, constant);
+        case duckdb::ExpressionType::COMPARE_GREATERTHAN:
+          return arrow::compute::greater(field, constant);
+        case duckdb::ExpressionType::COMPARE_LESSTHANOREQUALTO:
+          return arrow::compute::less_equal(field, constant);
+        case duckdb::ExpressionType::COMPARE_GREATERTHANOREQUALTO:
+          return arrow::compute::greater_equal(field, constant);
+        default:
+          throw duckdb::NotImplementedException(
+            "[arrow][filter][pushdown] not implemented comparison type: %s",
+            duckdb::ExpressionTypeToString(constant_filter->comparison_type));
+        }
+        break;
+      }
+    case duckdb::TableFilterType::IS_NULL:
+      return arrow::compute::is_null(field);
+    case duckdb::TableFilterType::IS_NOT_NULL:
+      return arrow::compute::is_valid(field);
+    case duckdb::TableFilterType::CONJUNCTION_OR:
+      {
+        auto or_filter = static_cast<duckdb::ConjunctionOrFilter *>(filter);
+        std::vector<arrow::compute::Expression> sub_expressions;
+        for (auto &child_filter : or_filter->child_filters) {
+          sub_expressions.emplace_back(
+            std::move(convert_filter(child_filter.get(), column_name)));
+        }
+        return arrow::compute::or_(sub_expressions);
+      }
+    case duckdb::TableFilterType::CONJUNCTION_AND:
+      {
+        auto and_filter = static_cast<duckdb::ConjunctionAndFilter *>(filter);
+        std::vector<arrow::compute::Expression> sub_expressions;
+        for (auto &child_filter : and_filter->child_filters) {
+          sub_expressions.emplace_back(
+            std::move(convert_filter(child_filter.get(), column_name)));
+        }
+        return arrow::compute::and_(sub_expressions);
+      }
+    default:
+      throw duckdb::NotImplementedException(
+        "[arrow][filter][pushdown] unknown filter type: %u",
+        filter->filter_type);
+    }
+  }
+
+  arrow::compute::Expression
+  convert_filters(std::unordered_map<
+                    idx_t,
+                    std::unique_ptr<duckdb::TableFilter>
+                  > &filters,
+                  std::unordered_map<idx_t, std::string> &column_names)
+  {
+    std::vector<arrow::compute::Expression> expressions;
+    for (auto it = filters.begin(); it != filters.end(); ++it) {
+      expressions.emplace_back(
+        std::move(convert_filter(it->second.get(), column_names[it->first])));
+    }
+    return arrow::compute::and_(expressions);
+  }
+
+  arrow::Result<std::unique_ptr<duckdb::ArrowArrayStreamWrapper>>
+  arrow_table_produce_internal(uintptr_t data,
+                               std::pair<
+                                 std::unordered_map<idx_t, std::string>,
+                                 std::vector<std::string>
+                               > &project_columns,
+                               duckdb::TableFilterCollection *filters)
+  {
+    auto garrow_table = GARROW_TABLE(reinterpret_cast<gpointer>(data));
+    auto arrow_table = garrow_table_get_raw(garrow_table);
+    auto dataset =
+      std::make_shared<arrow::dataset::InMemoryDataset>(arrow_table);
+    ARROW_ASSIGN_OR_RAISE(auto scanner_builder, dataset->NewScan());
+    bool have_filter =
+      filters &&
+      filters->table_filters &&
+      !filters->table_filters->filters.empty();
+    if (have_filter) {
+      ARROW_RETURN_NOT_OK(
+        scanner_builder->Filter(convert_filters(filters->table_filters->filters,
+                                                project_columns.first)));
+    }
+    if (!project_columns.second.empty()) {
+      ARROW_RETURN_NOT_OK(scanner_builder->Project(project_columns.second));
+    }
+    ARROW_ASSIGN_OR_RAISE(auto scanner, scanner_builder->Finish());
+    ARROW_ASSIGN_OR_RAISE(auto reader, scanner->ToRecordBatchReader());
+    auto stream_wrapper = duckdb::make_unique<duckdb::ArrowArrayStreamWrapper>();
+    ARROW_RETURN_NOT_OK(
+      arrow::ExportRecordBatchReader(reader,
+                                     &(stream_wrapper->arrow_array_stream)));
+    return stream_wrapper;
+  }
+
+  std::unique_ptr<duckdb::ArrowArrayStreamWrapper>
+  arrow_table_produce(uintptr_t data,
+                      std::pair<
+                        std::unordered_map<idx_t, std::string>,
+                        std::vector<std::string>
+                      > &project_columns,
+                      duckdb::TableFilterCollection *filters)
+  {
+    auto stream_wrapper_result =
+      arrow_table_produce_internal(data, project_columns, filters);
+    if (!stream_wrapper_result.ok()) {
+      throw std::runtime_error(
+        std::string("[arrow][produce] failed to produce: ") +
+        stream_wrapper_result.status().ToString());
+    }
+    return std::move(*stream_wrapper_result);
+  }
+}
+
+namespace arrow_duckdb {
+  void
+  connection_unregister(duckdb_connection connection, VALUE name)
+  {
+    auto c_name = StringValueCStr(name);
+    reinterpret_cast<duckdb::Connection *>(connection)
+      ->Query(std::string("DROP VIEW \"") + c_name + "\"");
+  }
+
+  void
+  connection_register(duckdb_connection connection,
+                      VALUE name,
+                      VALUE arrow_table)
+  {
+    auto c_name = StringValueCStr(name);
+    auto garrow_table = RVAL2GOBJ(arrow_table);
+    const idx_t rows_per_tuple = 1000000;
+    reinterpret_cast<duckdb::Connection *>(connection)
+      ->TableFunction(
+        "arrow_scan",
+        {
+          duckdb::Value::POINTER(reinterpret_cast<uintptr_t>(garrow_table)),
+          duckdb::Value::POINTER(reinterpret_cast<uintptr_t>(arrow_table_produce)),
+          duckdb::Value::UBIGINT(rows_per_tuple)
+        })
+      ->CreateView(c_name, true, true);
+  }
+}

data/ext/arrow-duckdb/arrow-duckdb-registration.hpp

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2021  Sutou Kouhei <kou@clear-code.com>
+ *
+ * Licensed 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.
+ */
+
+#pragma once
+
+namespace arrow_duckdb {
+  void
+  connection_unregister(duckdb_connection connection, VALUE name);
+  void
+  connection_register(duckdb_connection connection,
+                      VALUE name,
+                      VALUE arrow_table);
+}
+

data/ext/arrow-duckdb/arrow-duckdb.cpp

@@ -0,0 +1,404 @@
+/*
+ * Copyright 2021  Sutou Kouhei <kou@clear-code.com>
+ *
+ * Licensed 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 <arrow-glib/arrow-glib.hpp>
+
+#include <arrow/c/bridge.h>
+
+#include <rbgobject.h>
+
+#include <ruby-duckdb.h>
+
+#include "arrow-duckdb-registration.hpp"
+
+extern "C" void Init_arrow_duckdb(void);
+
+namespace {
+#  if !GARROW_VERSION_CHECK(6, 0, 0)
+  GArrowSchema *
+  garrow_schema_import(gpointer c_abi_schema,
+                       GError **error)
+  {
+    auto arrow_schema =
+      *arrow::ImportSchema(static_cast<ArrowSchema *>(c_abi_schema));
+    return garrow_schema_new_raw(&arrow_schema);
+  }
+
+  GArrowRecordBatch *
+  garrow_record_batch_import(gpointer c_abi_array,
+                             GArrowSchema *schema,
+                             GError **error)
+  {
+    auto arrow_schema = garrow_schema_get_raw(schema);
+    auto arrow_record_batch =
+      *arrow::ImportRecordBatch(static_cast<ArrowArray *>(c_abi_array),
+                                arrow_schema);
+    return garrow_record_batch_new_raw(&arrow_record_batch);
+  }
+#  endif
+
+  VALUE cArrowTable;
+  VALUE cArrowDuckDBResult;
+
+  struct Result {
+    duckdb_arrow arrow;
+    char *error_message;
+    GArrowSchema *gschema;
+  };
+
+  void
+  result_free(void *data)
+  {
+    Result *result = static_cast<Result *>(data);
+    if (result->gschema) {
+      g_object_unref(result->gschema);
+    }
+    free(result->error_message);
+    duckdb_destroy_arrow(&(result->arrow));
+  }
+
+  static const rb_data_type_t result_type = {
+    "ArrowDuckDB::Result",
+    {
+      nullptr,
+      result_free,
+    },
+    nullptr,
+    nullptr,
+    RUBY_TYPED_FREE_IMMEDIATELY,
+  };
+
+  VALUE
+  result_alloc_func(VALUE klass)
+  {
+    Result *result;
+    auto rb_result = TypedData_Make_Struct(klass,
+                                           Result,
+                                           &result_type,
+                                           result);
+    result->arrow = nullptr;
+    result->error_message = nullptr;
+    result->gschema = nullptr;
+    return rb_result;
+  }
+
+  void
+  result_ensure_gschema(Result *result)
+  {
+    ArrowSchema c_abi_schema;
+    duckdb_arrow_schema schema = &c_abi_schema;
+    auto state = duckdb_query_arrow_schema(result->arrow, &schema);
+    if (state == DuckDBError) {
+      free(result->error_message);
+      result->error_message =
+        const_cast<char *>(duckdb_query_arrow_error(result->arrow));
+      rb_raise(eDuckDBError,
+               "Failed to fetch Apache Arrow schema: %s",
+               result->error_message);
+    }
+
+    GError *gerror = nullptr;
+    result->gschema = garrow_schema_import(&c_abi_schema, &gerror);
+    if (gerror) {
+      RG_RAISE_ERROR(gerror);
+    }
+  }
+
+  VALUE
+  result_fetch_internal(VALUE self, Result *result)
+  {
+    ArrowArray c_abi_array = {};
+    duckdb_arrow_array array = &c_abi_array;
+    auto state = duckdb_query_arrow_array(result->arrow, &array);
+    if (state == DuckDBError) {
+      free(result->error_message);
+      result->error_message =
+        const_cast<char *>(duckdb_query_arrow_error(result->arrow));
+      rb_raise(eDuckDBError,
+               "Failed to fetch Apache Arrow array: %s",
+               result->error_message);
+    }
+    if (!c_abi_array.release) {
+      return Qnil;
+    }
+
+    GError *gerror = nullptr;
+    auto grecord_batch = garrow_record_batch_import(&c_abi_array,
+                                                    result->gschema,
+                                                    &gerror);
+    if (gerror) {
+      RG_RAISE_ERROR(gerror);
+      return Qnil;
+    }
+    return GOBJ2RVAL_UNREF(grecord_batch);
+  }
+
+  VALUE
+  result_fetch(VALUE self)
+  {
+    Result *result;
+    TypedData_Get_Struct(self, Result, &result_type, result);
+
+    result_ensure_gschema(result);
+
+    return result_fetch_internal(self, result);
+  }
+
+  VALUE
+  result_each(VALUE self)
+  {
+    RETURN_ENUMERATOR(self, 0, 0);
+
+    Result *result;
+    TypedData_Get_Struct(self, Result, &result_type, result);
+
+    result_ensure_gschema(result);
+
+    while (true) {
+      auto record_batch = result_fetch_internal(self, result);
+      if (NIL_P(record_batch)) {
+        break;
+      }
+      rb_yield(record_batch);
+    }
+
+    return self;
+  }
+
+  VALUE
+  result_schema(VALUE self)
+  {
+    Result *result;
+    TypedData_Get_Struct(self, Result, &result_type, result);
+
+    result_ensure_gschema(result);
+
+    return GOBJ2RVAL(result->gschema);
+  }
+
+  VALUE
+  result_n_columns(VALUE self)
+  {
+    Result *result;
+    TypedData_Get_Struct(self, Result, &result_type, result);
+
+    return ULL2NUM(duckdb_arrow_column_count(result->arrow));
+  }
+
+  VALUE
+  result_n_rows(VALUE self)
+  {
+    Result *result;
+    TypedData_Get_Struct(self, Result, &result_type, result);
+
+    return ULL2NUM(duckdb_arrow_row_count(result->arrow));
+  }
+
+  VALUE
+  result_n_changed_rows(VALUE self)
+  {
+    Result *result;
+    TypedData_Get_Struct(self, Result, &result_type, result);
+
+    return ULL2NUM(duckdb_arrow_rows_changed(result->arrow));
+  }
+
+  VALUE
+  query_sql_arrow(VALUE self, VALUE sql)
+  {
+    rubyDuckDBConnection *ctx;
+    Data_Get_Struct(self, rubyDuckDBConnection, ctx);
+
+    if (!(ctx->con)) {
+      rb_raise(eDuckDBError, "Database connection closed");
+    }
+
+    ID id_new;
+    CONST_ID(id_new, "new");
+    auto result = rb_funcall(cArrowDuckDBResult, id_new, 0);
+    Result *arrow_duckdb_result;
+    TypedData_Get_Struct(result, Result, &result_type, arrow_duckdb_result);
+    auto state = duckdb_query_arrow(ctx->con,
+                                    StringValueCStr(sql),
+                                    &(arrow_duckdb_result->arrow));
+    if (state == DuckDBError) {
+      if (arrow_duckdb_result->arrow) {
+        arrow_duckdb_result->error_message =
+          const_cast<char *>(
+            duckdb_query_arrow_error(arrow_duckdb_result->arrow));
+        rb_raise(eDuckDBError,
+                 "Failed to execute query: %s",
+                 arrow_duckdb_result->error_message);
+      } else {
+        rb_raise(eDuckDBError, "Failed to execute query");
+      }
+    }
+
+    return result;
+  }
+
+  VALUE
+  query_unregister_arrow(VALUE self, VALUE name)
+  {
+    rubyDuckDBConnection *ctx;
+    Data_Get_Struct(self, rubyDuckDBConnection, ctx);
+
+    if (!(ctx->con)) {
+      rb_raise(eDuckDBError, "Database connection closed");
+    }
+
+    arrow_duckdb::connection_unregister(ctx->con, name);
+
+    auto arrow_tables = rb_iv_get(self, "@arrow_tables");
+    if (NIL_P(arrow_tables)) {
+      arrow_tables = rb_hash_new();
+      rb_iv_set(self, "@arrow_tables", arrow_tables);
+    }
+    rb_hash_delete(arrow_tables, name);
+
+    return self;
+  }
+
+  VALUE
+  query_register_arrow_body(VALUE)
+  {
+    return rb_yield_values(0);
+  }
+
+  struct QueryRegisterArrowData {
+    VALUE self;
+    VALUE name;
+  };
+
+  VALUE
+  query_register_arrow_ensure(VALUE user_data)
+  {
+    auto data = reinterpret_cast<QueryRegisterArrowData *>(user_data);
+    return query_unregister_arrow(data->self, data->name);
+  }
+
+  VALUE
+  query_register_arrow(VALUE self, VALUE name, VALUE arrow_table)
+  {
+    rubyDuckDBConnection *ctx;
+    Data_Get_Struct(self, rubyDuckDBConnection, ctx);
+
+    if (!(ctx->con)) {
+      rb_raise(eDuckDBError, "Database connection closed");
+    }
+
+    if (!RVAL2CBOOL(rb_obj_is_kind_of(arrow_table, cArrowTable))) {
+      rb_raise(rb_eArgError, "must be Arrow::Table: %" PRIsVALUE, arrow_table);
+    }
+
+    arrow_duckdb::connection_register(ctx->con, name, arrow_table);
+
+    auto arrow_tables = rb_iv_get(self, "@arrow_tables");
+    if (NIL_P(arrow_tables)) {
+      arrow_tables = rb_hash_new();
+      rb_iv_set(self, "@arrow_tables", arrow_tables);
+    }
+    rb_hash_aset(arrow_tables, name, arrow_table);
+
+    if (rb_block_given_p()) {
+      QueryRegisterArrowData data;
+      data.self = self;
+      data.name = name;
+      return rb_ensure(query_register_arrow_body,
+                       Qnil,
+                       query_register_arrow_ensure,
+                       reinterpret_cast<VALUE>(&data));
+    } else {
+      return self;
+    }
+  }
+
+  VALUE
+  prepared_statement_execute_arrow(VALUE self)
+  {
+    rubyDuckDBPreparedStatement *ctx;
+    Data_Get_Struct(self, rubyDuckDBPreparedStatement, ctx);
+
+    ID id_new;
+    CONST_ID(id_new, "new");
+    auto result = rb_funcall(cArrowDuckDBResult, id_new, 0);
+    Result *arrow_duckdb_result;
+    TypedData_Get_Struct(result, Result, &result_type, arrow_duckdb_result);
+
+    auto state = duckdb_execute_prepared_arrow(ctx->prepared_statement,
+                                               &(arrow_duckdb_result->arrow));
+    if (state == DuckDBError) {
+      if (arrow_duckdb_result->arrow) {
+        arrow_duckdb_result->error_message =
+          const_cast<char *>(
+            duckdb_query_arrow_error(arrow_duckdb_result->arrow));
+        rb_raise(eDuckDBError,
+                 "Failed to execute prepared statement: %s",
+                 arrow_duckdb_result->error_message);
+      } else {
+        rb_raise(eDuckDBError, "Failed to execute prepared statement");
+      }
+    }
+
+    return result;
+  }
+
+  void init()
+  {
+    cArrowTable = rb_const_get(rb_const_get(rb_cObject, rb_intern("Arrow")),
+                               rb_intern("Table"));
+
+    auto mArrowDuckDB = rb_define_module("ArrowDuckDB");
+    cArrowDuckDBResult = rb_define_class_under(mArrowDuckDB,
+                                               "Result",
+                                               rb_cObject);
+    rb_define_alloc_func(cArrowDuckDBResult, result_alloc_func);
+    rb_include_module(cArrowDuckDBResult, rb_mEnumerable);
+    rb_define_method(cArrowDuckDBResult, "fetch", result_fetch, 0);
+    rb_define_method(cArrowDuckDBResult, "each", result_each, 0);
+    rb_define_method(cArrowDuckDBResult, "schema", result_schema, 0);
+    rb_define_method(cArrowDuckDBResult, "n_columns", result_n_columns, 0);
+    rb_define_method(cArrowDuckDBResult, "n_rows", result_n_rows, 0);
+    rb_define_method(cArrowDuckDBResult,
+                     "n_changed_rows",
+                     result_n_changed_rows,
+                     0);
+
+    rb_define_method(cDuckDBConnection, "query_sql_arrow", query_sql_arrow, 1);
+    rb_define_method(cDuckDBConnection,
+                     "register_arrow",
+                     query_register_arrow,
+                     2);
+    rb_define_method(cDuckDBConnection,
+                     "unregister_arrow",
+                     query_unregister_arrow,
+                     1);
+
+    auto cDuckDBPreparedStatement =
+      rb_const_get(rb_const_get(rb_cObject, rb_intern("DuckDB")),
+                   rb_intern("PreparedStatement"));
+    rb_define_method(cDuckDBPreparedStatement,
+                     "execute_arrow",
+                     prepared_statement_execute_arrow,
+                     0);
+  }
+}
+
+extern "C" void
+Init_arrow_duckdb(void)
+{
+  init();
+}

data/ext/arrow-duckdb/extconf.rb

@@ -0,0 +1,33 @@
+# Copyright 2021  Sutou Kouhei <kou@clear-code.com>
+#
+# Licensed 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.
+
+require "extpp"
+require "mkmf-gnome"
+
+required_pkg_config_package("arrow-glib")
+required_pkg_config_package("arrow-dataset")
+
+[
+  ["glib2", "ext/glib2"],
+  ["duckdb", "ext/duckdb"],
+].each do |name, source_dir|
+  spec = find_gem_spec(name)
+  source_dir = File.join(spec.full_gem_path, source_dir)
+  build_dir = source_dir
+  add_depend_package_path(name, source_dir, build_dir)
+end
+
+have_library("duckdb") or exit(false)
+
+create_makefile("arrow_duckdb")

data/lib/arrow-duckdb.rb

@@ -0,0 +1,23 @@
+# Copyright 2021  Sutou Kouhei <kou@clear-code.com>
+#
+# Licensed 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.
+
+require "arrow"
+require "duckdb"
+
+require "arrow-duckdb/version"
+
+require "arrow_duckdb.so"
+
+require "arrow-duckdb/connection"
+require "arrow-duckdb/result"

data/lib/arrow-duckdb/connection.rb

@@ -0,0 +1,37 @@
+# Copyright 2021  Sutou Kouhei <kou@clear-code.com>
+#
+# Licensed 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.
+
+module ArrowDuckDB
+  module ArrowableQuery
+    def query(sql, *args, output: nil)
+      return super(sql, *args) if output != :arrow
+
+      return query_sql_arrow(sql) if args.empty?
+
+      stmt = DuckDB::PreparedStatement.new(self, sql)
+      args.each_with_index do |arg, i|
+        stmt.bind(i + 1, arg)
+      end
+      stmt.execute_arrow
+    end
+  end
+end
+
+module DuckDB
+  class Connection
+    prepend ArrowDuckDB::ArrowableQuery
+
+    alias_method :register, :register_arrow
+  end
+end

data/lib/arrow-duckdb/result.rb

@@ -0,0 +1,21 @@
+# Copyright 2021  Sutou Kouhei <kou@clear-code.com>
+#
+# Licensed 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.
+
+module ArrowDuckDB
+  class Result
+    def to_table
+      Arrow::Table.new(schema, to_a)
+    end
+  end
+end

data/lib/arrow-duckdb/version.rb

@@ -0,0 +1,17 @@
+# Copyright 2021  Sutou Kouhei <kou@clear-code.com>
+#
+# Licensed 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.
+
+module ArrowDuckDB
+  VERSION = "1.0.0"
+end

data/red-arrow-duckdb.gemspec

@@ -0,0 +1,50 @@
+# -*- ruby -*-
+#
+# Copyright 2021  Sutou Kouhei <kou@clear-code.com>
+#
+# Licensed 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.
+
+clean_white_space = lambda do |entry|
+  entry.gsub(/(\A\n+|\n+\z)/, '') + "\n"
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "lib"))
+require "arrow-duckdb/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "red-arrow-duckdb"
+  spec.version = ArrowDuckDB::VERSION
+  spec.homepage = "https://github.com/red-data-tools/red-arrow-duckdb"
+  spec.authors = ["Sutou Kouhei"]
+  spec.email = ["kou@clear-code.com"]
+
+  readme = File.read("README.md")
+  readme.force_encoding("UTF-8")
+  entries = readme.split(/^\#\#\s(.*)$/)
+  clean_white_space.call(entries[entries.index("Description") + 1])
+  description = clean_white_space.call(entries[entries.index("Description") + 1])
+  spec.summary, spec.description, = description.split(/\n\n+/, 3)
+  spec.license = "Apache-2.0"
+  spec.files = ["README.md", "#{spec.name}.gemspec"]
+  spec.files += Dir.glob("lib/**/*.rb")
+  spec.files += Dir.glob("ext/**/*.{cpp,hpp}")
+  spec.files += Dir.glob("doc/text/*")
+  spec.extensions = ["ext/arrow-duckdb/extconf.rb"]
+
+  spec.add_runtime_dependency("duckdb")
+  spec.add_runtime_dependency("red-arrow")
+
+  spec.add_development_dependency("bundler")
+  spec.add_development_dependency("rake")
+  spec.add_development_dependency("test-unit")
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: red-arrow-duckdb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Sutou Kouhei
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-08-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: duckdb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: red-arrow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- kou@clear-code.com
+executables: []
+extensions:
+- ext/arrow-duckdb/extconf.rb
+extra_rdoc_files: []
+files:
+- README.md
+- doc/text/apache-2.0.txt
+- doc/text/news.md
+- ext/arrow-duckdb/arrow-duckdb-registration.cpp
+- ext/arrow-duckdb/arrow-duckdb-registration.hpp
+- ext/arrow-duckdb/arrow-duckdb.cpp
+- ext/arrow-duckdb/extconf.rb
+- lib/arrow-duckdb.rb
+- lib/arrow-duckdb/connection.rb
+- lib/arrow-duckdb/result.rb
+- lib/arrow-duckdb/version.rb
+- red-arrow-duckdb.gemspec
+homepage: https://github.com/red-data-tools/red-arrow-duckdb
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.0.dev
+signing_key: 
+specification_version: 4
+summary: Red Arrow DuckDB is a library that provides Apache Arrow support to ruby-duckdb.
+test_files: []