squealer 1.0.0 → 1.0.1

data/README.md

@@ -1,13 +1,33 @@
 # Squealer
 
+## Warning
+Squealer is for standalone operation. Do not use it from within your application. To make the DSL easy to use, we alter `Object`, `NilClass`, `Time`, and `Hash`.
+
+* `Object` - `#import`, `#export`, `#target`, and `#assign` "keywords" are provided for convenience
+* `NilClass`
+ * `#each` - As you are importing from schemaless repositories and you may be trying to iterate on fields that contain embedded collections, if a specific parent does not contain one of those child collections, the driver will be returning "nil" as the value for that field. Having `NilClass#each` return a `[]` for a nil is convenient, semantically correct in this context, and removes the need for many nil checks in the block you provide to `Object#assign`
+* `Time`
+ * `#to_s` - As you are exporting to a SQL database, we represent your timestamp in a format that it will parse unequivocally (mongodb stores all temporal data as a timestamp)
+* `Hash`
+ * `#method_missing` - You prefer dot notation. JSON uses dot notation. You are importing from a data store which represents collections as arrays of hashmaps. Dot notation for navigating those collections is convenient. If you use a field name that happens to be a method on Hash you will have to use index notation. (e.g. `kitten.toys` is good, however `kitten.freeze` is not good. Use `kitten['freeze']` instead.)
+
+To run standalone, simply make your data squeal thusly:
+
+`> ruby example_squeal.rb`
+
+where the squeal script requires 'squealer'.
+
+Squealer doesn't use your application classes. It doesn't use your ActiveRecord models. It's an ETL tool. It could even be called a HRM (Hashmap-Relational-Mapper), but only in hushed tones in the corner boothes of dark pubs.
+
+## Databases supported
 For now, this is specifically for MongoDB exporting to mySQL with the assumption that the data will be heavily denormalized.
 
-The target SQL database must have no foreign keys.
+## Notes
+The target SQL database must have no foreign keys (because it can't rely on the primary key values and referential integrity is the responsibility of the source data store or the application that uses it).
 
 The target SQL database must use a primary key of char(16) with value of the MongoDB id.
 
-It is assumed no indexes are present in the target database table.
-
-The target row is inserted, or updated if present. We are using MySQL INSERT ... UPDATE ON DUPLICATE KEY extended syntax to achieve this for now. This allows an event-driven update of exported data as well as a bulk batch process.
+It is assumed no indexes are present in the target database table (performance drag). You may want to create indexes for pulling data out of the database Squealer exports to. You should drop them again when you've done the pull.
 
+The target row is inserted, or updated if present. We are using MySQL `INSERT ... UPDATE ON DUPLICATE KEY` extended syntax to achieve this for now. This allows an event-driven update of exported data as well as a bulk batch process.
 

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.0.1

data/squealer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{squealer}
-  s.version = "1.0.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Josh Graham", "Durran Jordan"]
-  s.date = %q{2010-03-23}
+  s.date = %q{2010-03-26}
   s.description = %q{Exports mongodb to mysql. More later.}
   s.email = %q{joshua.graham@grahamis.com}
   s.extra_rdoc_files = [

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Josh Graham
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-03-23 00:00:00 -05:00
+date: 2010-03-26 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency