No description
Find a file
Brian J. Cardiff 889000dba3 Remove call to obsolete Spec.matches?
It was an optimization but it does not work (and is not needed) since the changes in spec for Crystal 0.31
2019-09-12 10:36:38 -03:00
spec Add type argument to QueryMethods module (#108) 2019-08-02 11:54:52 -03:00
src Remove call to obsolete Spec.matches? 2019-09-12 10:36:38 -03:00
.gitignore Update .gitignore to latest template 2018-11-07 15:41:44 -03:00
.travis.yml Add travis nightly (#106) 2019-06-25 13:51:38 -03:00
CHANGELOG.md Release 0.6.0 2019-08-02 12:06:53 -03:00
LICENSE initial commit 2016-02-25 22:22:54 -03:00
README.md Documentation improvements (#107) 2019-07-02 10:01:17 -03:00
shard.yml Release 0.6.0 2019-08-02 12:06:53 -03:00

Build Status

crystal-db

Common db api for crystal. You will need to have a specific driver to access a database.

Installation

If you are creating a shard that will work with any driver, then add crystal-db as a dependency in shard.yml:

dependencies:
  db:
    github: crystal-lang/crystal-db

If you are creating an application that will work with some specific driver(s), then add them in shard.yml:

dependencies:
  sqlite3:
    github: crystal-lang/crystal-sqlite3

crystal-db itself will be a nested dependency if drivers are included.

Note: Multiple drivers can be included in the same application.

Documentation

Usage

This shard only provides an abstract database API. In order to use it, a specific driver for the intended database has to be required as well:

The following example uses SQLite where ? indicates the arguments. If PostgreSQL is used $1, $2, etc. should be used. crystal-db does not interpret the statements.

require "db"
require "sqlite3"

DB.open "sqlite3:./file.db" do |db|
  # When using the pg driver, use $1, $2, etc. instead of ?
  db.exec "create table contacts (name text, age integer)"
  db.exec "insert into contacts values (?, ?)", "John Doe", 30

  args = [] of DB::Any
  args << "Sarah"
  args << 33
  db.exec "insert into contacts values (?, ?)", args

  puts "max age:"
  puts db.scalar "select max(age) from contacts" # => 33

  puts "contacts:"
  db.query "select name, age from contacts order by age desc" do |rs|
    puts "#{rs.column_name(0)} (#{rs.column_name(1)})"
    # => name (age)
    rs.each do
      puts "#{rs.read(String)} (#{rs.read(Int32)})"
      # => Sarah (33)
      # => John Doe (30)
    end
  end
end

Roadmap

Issues not yet addressed:

  • Support non prepared statements. #25
  • Time data type. (implementation details depends on actual drivers)
  • Data type extensibility. Allow each driver to extend the data types allowed.
  • Transactions & nested transactions. #27
  • Connection pool.
  • Logging
  • Direct access to IO to avoid memory allocation for blobs.

Contributing

  1. Fork it ( https://github.com/crystal-lang/crystal-db/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors

  • bcardiff Brian J. Cardiff - creator, maintainer