SQLite3 bindings for Crystal.
Check crystal-db for general db driver documentation. crystal-sqlite3 driver is registered under sqlite3:// uri.
Add this to your application's shard.yml:
dependencies:
sqlite3:
github: crystal-lang/crystal-sqlite3require "sqlite3"
DB.open "sqlite3://./data.db" do |db|
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: 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
endTimeis implemented asTEXTcolumn usingSQLite3::DATE_FORMAT_SUBSECONDformat (orSQLite3::DATE_FORMAT_SECONDif the text does not contain a dot).Boolis implemented asINTcolumn mapping0/1values.
You can adjust certain SQLite3 PRAGMAs automatically when the connection is created by using the query parameters:
require "sqlite3"
DB.open "sqlite3://./data.db?journal_mode=wal&synchronous=normal" do |db|
# this database now uses WAL journal and normal synchronous mode
# (defaults were `delete` and `full`, respectively)
endThe following is the list of supported options:
| Name | Connection key |
|---|---|
| Busy Timeout | busy_timeout |
| Cache Size | cache_size |
| Foreign Keys | foreign_keys |
| Journal Mode | journal_mode |
| Synchronous | synchronous |
| WAL autocheckoint | wal_autocheckpoint |
Please note there values passed using these connection keys are passed directly to SQLite3 without check or evaluation. Using incorrect values result in no error by the library.