janko 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a5f76b26c5b29eb65e50fbbe8d8c3a8acd2eb5b6
+  data.tar.gz: bd01f51b7d9429a19f29f380cb0a24345724b85e
+SHA512:
+  metadata.gz: 59ceb7446c4bd158045a97b131ee9b9252985d9ec605a7e7acd224a1ab7e68d13b50ff45925e50dc40df4e62cfeb65e7299580648943f25f57dedbc9166ec027
+  data.tar.gz: 0fa2f245c863fd613fa0c0f3da7f855f799fc07038c6612249b6f496c10fd322ff6c1817f43a03ac975fc586a1159067727ca105cae1f766494e088bef110463

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+*.log
+config/*.yml
+*.sw?
+*.DS_Store

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Guardfile

@@ -0,0 +1,7 @@
+rspec_options = { cmd: "bundle exec rspec", all_on_start: false,
+    all_after_pass: false }
+guard "rspec", rspec_options do
+    watch("spec/spec_helper.rb") { "spec" }
+    watch(%r{^spec/.+_spec\.rb$}) { "spec" }
+    watch(%r{^lib/.+\.rb$}) { "spec" }
+end

data/LICENSE.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/README.md

@@ -0,0 +1,186 @@
+## Janko
+
+One day, your Ruby app may meed to feed a metric shit-ton of data into
+PostgreSQL.
+
+On that day, you need Janko.
+
+Janko imports and merges large datasets with truly stupid levels of
+performance (see the benchmarks below).
+
+## Installation
+
+Run `gem install janko`, or add `gem "janko"` to your `Gemfile`.
+
+Janko has been tested against PostgreSQL 9.3, and requires at least
+PostgreSQL 9.1, as it makes use of a [writable
+CTE](http://www.postgresql.org/docs/9.1/static/queries-with.html). As soon
+as PostgreSQL 9.5 goes platinum, Janko support will be added there as well.
+
+## Putting It to Work
+
+#### Importing
+
+`Janko::Import` needs to be configured for each table you want to load with
+data:
+
+```ruby
+require "janko/import"
+
+# Let's import some data with Janko::Import
+importer = Janko::Import.new
+
+# Use the same database connection as ActiveRecord.
+importer.connect(ActiveRecord::Base)
+
+# Import lots of records at once.
+importer.use(Janko::CopyImporter)
+
+# Let's only import a few columns into the "users" table.
+importer.table("users").columns(:id, :email, :password)
+
+# And feed it some data from an array
+importer.start
+rows.each { |row| importer.push(row) }
+importer.stop
+```
+
+Out of the box, `Janko::Import` offers a choice of two different
+data-loading behaviors: `Janko::InsertImporter` and `Janko::CopyImporter`.
+
+`Janko::CopyImporter` is notably faster, but only throws errors after
+feeding the entire dataset into PostgreSQL. `Janko::InsertImporter` is half
+as fast as copy, but will error immediately if the database is unhappy with
+what its being fed.
+
+Both will have the same final result regardless of errors, the only
+differences are speed, and whether or not errors occur immediately on
+`importer.push`, or when `importer.stop` is called.
+
+## Merging / Upserting
+
+`Janko::Merge` works similarly to `Janko::Import`:
+
+```ruby
+require "janko/merge"
+
+# Create a Merger, and fetch a Builder.
+merge = Janko::Merge.new
+
+# Tell it about our connection.
+merge.connect(ActiveRecord::Base)
+
+# Set the target table.
+merge.table("users")
+
+# Use the email address as the key column, used to determine whether
+# to UPDATE an existing row, or INSERT a new one.
+merge.key(:email)
+
+# Feed it some data from an array
+merge.start
+rows.each { |row| merge.push(row) }
+merge.stop
+```
+
+By default, `Merge` will attempt to fill all columns on both INSERT and
+UPDATE *except* the `id` column. You can choose to UPDATE or INSERT only on
+specific columns with `merge.update("column")` and `merge.insert("column")`,
+respectively.
+
+Multiple `key` columns are allowed.
+
+#### Returning
+
+`Merge` can return both updated and inserted rows via `returning`:
+
+```ruby
+# Return inserted rows.
+merge.returning(:inserted)
+
+# Return updated rows.
+merge.returning(:updated)
+
+# Return all rows.
+merge.returning(:all)
+
+# Return nothing.
+merge.returning(:none)
+```
+
+Results are stored in `merge.result`.
+
+#### Column Defaults
+
+PostgreSQL provides a lot of functionality that is difficult or impossible
+to expose through an ORM, so Janko provides some shockingly unsafe ways to
+interact with the database.
+
+**`Merge#alter` is dangerous as all hell.** It provides *zero* safety
+against stupidity, intentional or otherwise, and is injected directly into
+the database without escaping.
+
+Here's how it works:
+
+```ruby
+# Use the database default value for a column if nil.
+merge.alter(:updated_at) { |c| c.default(Janko::DEFAULT) }
+
+# Preserve the existing value of a column if nil.
+merge.alter(:created_at) { |c| c.default(Janko::KEEP) }
+
+# Do both of those things.
+merge.alter(:updated_at) { |c| c.default(Janko::KEEP | Janko::DEFAULT) }
+
+# Have the vote column increment whenever a row is updated.
+merge.alter(:votes) { |c| c.on_update("$OLD + 1") }
+
+# Make all post titles really, really shouty.
+merge.alter(:title) { |c| c.wrap("upper($NEW)") }
+
+# Completely nuke every record in the users table via SQL injection. Did I
+# mention that Merge#alter should fill you with a sense of great danger?
+merge.alter(:title) { |c| c.wrap("; rollback; delete * from users;" }
+```
+
+When alterting columns, `$NEW` is a placeholder for the value to be inserted
+from the Ruby side, and `$OLD` is the existing value in the database.
+
+Both of these use parameter binding, *not* string escaping or quoting, so
+you don't need to worry about SQL injection on the values themselves, just
+on any raw query you might supply with `wrap` or `on_update`.
+
+## Benchmarks
+
+Benchmarks were run under a single-processor virtual machine on my laptop (a
+Macbook Air, 1.3GhZ Core i5), and yielded surprisingly nice results.
+
+#### Import
+
+![Insert Performance Graph](assets/insert-performance-graph.png)
+
+#### Merge
+
+![Merge Performance Graph](assets/merge-performance-graph.png)
+
+## Other Considerations.
+
+Both Insert and Merge *should* be threadsafe insofar as the underlaying
+connection library is.
+
+## The FUTURE!
+
+Better documentation.
+
+Returning rows into a custom handler or other table.
+
+JRuby and Sequel support should be fairly straightforward.
+
+Integration with `ActiveRecord` and `Sequel::Model`.
+
+Profiling, optimization, and concurrency testing.
+
+Binary-format COPY support and/or faster CSV encoding.
+
+No plans to support other databases, just PostgreSQL, but I wouldn't turn
+down a well-implemented pull request.

data/Rakefile

@@ -0,0 +1,14 @@
+root = File.dirname(File.expand_path(__FILE__))
+$LOAD_PATH.unshift(root) unless $LOAD_PATH.include?(root)
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "config/environment"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :console do
+    require "pry"
+    ARGV.clear
+    Pry.start
+end