cql

A SQL toolkit for Crystal, inspired by Java's jOOQ and Ruby's Sequel gem
0.3.2 Latest release Yanked release released
aisrael/cql
5 1 3
Alistair A. Israel

Build Status

cql

CQL is a SQL toolkit for Crystal, inspired by Ruby's Sequel and Java's jOOQ.

NOTE: Currently only supports PostgreSQL, mainly. See ticket #1

Installation

Add this to your application's shard.yml:

dependencies:
  cql:
    github: aisrael/cql

Usage

require "cql"

Connect to a PostgreSQL database

db = CQL.connect("postgres://postgres:@localhost/database")

Or, if the environment variable DATABASE_URL is set, just

db = CQL.connect

Using CQL::Command objects

Create Table

create_table = CQL::Command::CreateTable.new(db, "users")
create_table.column("id", CQL::SERIAL, null: false, primary_key: true)
create_table.column("name", CQL::VARCHAR, size: 40, null: false, unique: true)
sql = create_table.to_s # => "CREATE TABLE users (id SERIAL NOT NULL PRIMARY KEY, name VARCHAR(40) NOT NULL UNIQUE)"
create_table.exec       # => exec(sql)

Insert

insert = CQL::Command::Insert.new(db, "users").column("name")
sql = insert.to_s       # => "INSERT INTO users (name) VALUES ($1)"
insert.exec("test")     # => exec(sql, "test")

Delete

delete = CQL::Command::Delete.new(db, "users").where(name: "test")
sql = delete.to_s       # => "DELETE FROM users WHERE name = $1"
delete.exec             # => exec(sql, "test")

Using CQL::Database

Create Table

db.create_table("foobar").column("id", CQL::INTEGER).exec

Insert

db.insert("foobar").column("id").exec(123)

Count

db.count("users").as_i64

Using CQL::Schema (see

users_table = CQL::Schema.new(CQL.postgres, User, "users",
  id: Int32,
  name: String
)

users_table.count                 # => 0
users_table.insert.values("test") # => exec("INSERT INTO users (name) VALUES ($1)",
users_table.count                 # => 1

users = users_table.all           # => query_all("SELECT id, name FROM users")
users.first.id                    # => 1
users.first.name                  # => "test"

user_id_1 = users_table.where(id: 1).one
user_id_1.id                      # => 1
user_id_1.name                    # => "test"

users_named_test = users_table.where(name: "test").all
users_named_test.first.id         # => 1
users_named_test.first.name       # => "test"

users_table.where(id: 1).delete   # => 1
users_table.count                 # => 0

Development

TODO: Write development instructions here

Contributing

  1. Fork it ( https://github.com/aisrael/cql/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

  • aisrael Alistair A. Israel - creator, maintainer
cql:
  github: aisrael/cql
  version: ~> 0.3.2
License MIT
Crystal 0.26.1

Authors

Dependencies 1

  • logging 0.2
    {'github' => 'aisrael/logging.cr', 'version' => 0.2}

Development Dependencies 3

  • ameba 0.8.0
    {'github' => 'veelenga/ameba', 'version' => '0.8.0'}
  • pg 0.15.0
    {'github' => 'will/crystal-pg', 'version' => '0.15.0'}
  • spec2 ~> 0.9
    {'github' => 'waterlink/spec2.cr', 'version' => '~> 0.9'}

Dependents 1

Last synced .
search fire star recently