automatthew / activemdb Goto Github PK

ActiveMDB
by Matthew King
http://rubyforge.org/projects/activemdb/

== DESCRIPTION:
  
ActiveMDB is a developer's tool for exploration and migration of MS Access (.mdb) files. It uses ActiveRecord-ish reflection to parse table and column names and provide attribute readers.  Yes, it is  *READ ONLY*. ActiveMDB is little more than a wrapper of varying thickness around the utilities from Brian Bruns's MDB Tools project (http://mdbtools.sourceforge.net/).  Kudos to Mr. Bruns.

== FEATURES/PROBLEMS:
  
* MDBTools - Straightforward wrapper around the CLI tools that you get with libmdb
* ActiveMDB::Base - Subclass to make your models, just like the big shots do.


== SYNOPSIS:

  # When your Access database schema conforms to the 37s stylebook:
  class Bacon < ActiveMDB::Base
    set_mdb_file 'db/wherefore.mdb'
  end

  # in the find_* methods, the entries in the hash 
  # get turned into "WHERE #{key} like %#{value}%" conditions,
  # which fails when the column is a boolean, which is a regression from 0.1.0.
  # I could fix this tonight, but my son is yelling at me to come out for dinner.
  best_bacon = Bacon.find_all(:rind => 'creamy', :sodium_content => 'Awesome!' )
  
  # When it doesn't:
  class Employee < ActiveMDB::Base
    set_mdb_file 'db/sample.mdb'
    set_table_name 'Employee'
    set_primary_key 'Emp_Id'
  end

  paula = Employee.find_first(:Department => 'Engineering', :Specialty => 'paulaBeans')


== REQUIREMENTS:

* http://mdbtools.sourceforge.net/

== INSTALL:

* Sadly, no easy install of MDB Tools at this time.  It compiles on Mac OS X 10.4.x, both PPC and Intel.  Haven't tested on Linuxes yet, but that's what Parallels is for, right?

== Some blog posts

* http://www.automatthew.com/2007/04/activemdb-for-that-not-so-fresh-feeling.html
* http://www.automatthew.com/2008/02/how-to-compile-mdbtools-on-mac-os-x.html
* http://www.automatthew.com/2007/04/whats-better-than-activemdb.html

== LICENSE:

(The MIT License)

Copyright (c) 2007 

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.