A small benchmark test for ruby ORMs.
Ruby
Pull request Compare This branch is 9 commits ahead, 2 commits behind jeremyevans:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
models
.gitignore
README
db.yml.example
results_aggregator.rb
simple_orm_benchmark.rb

README

Introduction
------------

simple_orm_benchmarker is a simple script to benchmark ruby ORMs.  It
currently supports ActiveRecord and Sequel.

Configuration
-------------

To use this, you first need to copy db.yml.example to db.yml, and modify it
accordingly.

Usage
-----

Then you can run the benchmarking via:

  ruby simple_orm_benchmark.rb -a
  ruby simple_orm_benchmark.rb sequel-postgresql
  ruby simple_orm_benchmark.rb -l 4 activerecord-mysql
  ruby simple_orm_benchmark.rb -l 6 -g activerecord-sqlite sequel-sqlite

Options:

* -a will test all configurations in the db.yml configuration file.
* -l is the testing level.  It's designed to be logrithmic, with a level 6
  test taking about twice as long as a level 5.  The default level is 5.
* -g will disable garbage collection during the test, to measure the amount
  of garbage the test generates.

You can list one or more configurations to test as arguments.  The
arguments should match keys in the hash parsed from the yaml file.

The output of the benchmark is in CSV, with columns in the following order:

configuration_name: Name of configuration
level: Testing level
benchmark_name: Name of benchmark
user_cpu_time: Amount of user CPU time
system_cpu_time: Amount of system CPU time
total_cpu_time: Amount of total CPU time
elapsed_real_time: Amount of actual/real/wallclock time
kb_of_memory_used: Difference in process memory usage from the benchmark
transaction_used: Whether a transaction was used

Most tests are run both inside of and outside of a transaction, so you get
results both ways.

There are also some JSON tests, but only modern versions of databases support JSON functions.
Even though SQLite doesn't enable JSON functions by default.
Benchmark script will just skip JSON tests for configurations that doesn't support it.
If you really want to enable them in SQLite you should install it with `functions` and `json1` extensions,
e.g. `brew install --with-functions --with-json1 sqlite`
Then just once run
```
require 'sqlite3'
c = SQLite3::Database.new('database')
c.enable_load_extension(1)
c.load_extension('/usr/local/Cellar/sqlite/3.14.2/lib/libsqlitefunctions.dylib')
```
It's not necessary if you use `amalgalite` adapter for `Sequel`, because it has enabled all extensions by default.

Reporting
---------

For easier comparison of different configurations, you can use the
results_aggregator.rb script:

  ruby ./simple_orm_benchmark.rb sequel-sqlite activerecord-sqlite > r.txt
  ruby ./results_aggregator.rb r.txt

That will output CSV, with columns in the following order:

activerecord-sqlite_real_time
sequel-sqlite_real_time
benchmark_name_with_transaction

Using this you can see comparitive results easily, not just for different
ORMs, but also for different databases with the same ORM.

Source
------

git://github.com/jeremyevans/simple_orm_benchmark.git
http://github.com/jeremyevans/simple_orm_benchmark

Author
------
  
Jeremy Evans (code@jeremyevans.net)

Contact me if you have questions about this benchmark script.  Contributions of
new benchmark tests are appreciated.

Thanks to tim.linquist@gmail.com (timo3377) for sequel-benchmark and
activerecord-benchmark, on which simple_orm_benchmark is based.