Topaz is a simple and useful db wrapper for crystal lang.
Topaz is inspired by active record design pattern, but not fully implemented.
See sample code for detail.
Here is another sample that shows how Topaz works in Kemal.
Depends on crystal-lang/crystal-mysql, crystal-lang/crystal-sqlite3 and crystal-pg
1. Setup DB
Topaz::Db.setup("mysql://root@localhost/topaz") # For MySQL
Topaz::Db.setup("postgres://root@localhost/topaz") # For PostgreSQL
Topaz::Db.setup("sqlite3://./db/data.db") # For SQLite32. Define models
class SampleModel < Topaz::Model
columns(
name: String
)
end
# You can drop or create a table
SampleModel.create_table
SampleModel.drop_table3. Create, find, update and delete models
s = SampleModel.create("Sample Name")
SampleModel.find(1).name
# => "Sample Name"
SampleModel.where("name = 'Sample Name'").size
# => 1See sample code for detail.
4. Define associations between models
require "topaz"
class SampleParent < Topaz::Model
columns # Empty columns
has_many(children: {model: SampleChild, key: parent_id})
end
class SampleChild < Topaz::Model
columns( # Define foreign key
parent_id: Int32
)
belongs_to(parent: {model: SampleParent, key: parent_id})
end
p = SampleParent.create
child1 = SampleChild.create(p.id)
child2 = SampleChild.create(p.id)
child3 = SampleChild.create(p.id)
p.children.size
# => 3
child1.parent.id
# => 1See sample code for detail.
Other features
- Transaction
- Table migration
Model#to_jsonandModel#from_jsoncreated_atandupdated_atcolumn- Nullable column
- Column with default value
- Change id from Int32 to Int64
See sample codes for detail.
Supported data types.
String, Int32, Int64, Float32, Float64
Setting up PostgreSQL:
$ psql
# CREATE USER root WITH CREATEDB;
# CREATE DATABASE topaz_test WITH OWNER = root;
Setting up MySQL:
$ mysql -u root
mysql> create database topaz_test;
- Fork it ( https://github.com/topaz-crystal/topaz/fork )
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create a new Pull Request
- tbrand Taichiro Suzuki - creator, maintainer