Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crystal-lang/crystal-sqlite3
SQLite3 bindings for Crystal
https://github.com/crystal-lang/crystal-sqlite3
crystal database driver sqlite3
Last synced: about 2 months ago
JSON representation
SQLite3 bindings for Crystal
- Host: GitHub
- URL: https://github.com/crystal-lang/crystal-sqlite3
- Owner: crystal-lang
- License: mit
- Created: 2015-03-12T23:31:27.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2023-12-13T01:16:33.000Z (7 months ago)
- Last Synced: 2024-04-10T02:08:18.080Z (3 months ago)
- Topics: crystal, database, driver, sqlite3
- Language: Crystal
- Size: 133 KB
- Stars: 131
- Watchers: 11
- Forks: 28
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Lists
- awesome-crystal - crystal-sqlite3 - SQLite3 bindings (Database Drivers/Clients)
- awesome-crystal - crystal-sqlite3 - SQLite3 bindings (Database Drivers/Clients)
- awesome-crystal - crystal-sqlite3 - SQLite3 bindings (Database Drivers/Clients)
README
# crystal-sqlite3 [](https://travis-ci.org/crystal-lang/crystal-sqlite3)
SQLite3 bindings for [Crystal](http://crystal-lang.org/).
Check [crystal-db](https://github.com/crystal-lang/crystal-db) for general db driver documentation. crystal-sqlite3 driver is registered under `sqlite3://` uri.
## Installation
Add this to your application's `shard.yml`:
```yml
dependencies:
sqlite3:
github: crystal-lang/crystal-sqlite3
```
### Usage
```crystal
require "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
end
```
### DB::Any
* `Time` is implemented as `TEXT` column using `SQLite3::DATE_FORMAT_SUBSECOND` format (or `SQLite3::DATE_FORMAT_SECOND` if the text does not contain a dot).
* `Bool` is implemented as `INT` column mapping `0`/`1` values.
### Setting PRAGMAs
You can adjust certain [SQLite3 PRAGMAs](https://www.sqlite.org/pragma.html)
automatically when the connection is created by using the query parameters:
```crystal
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)
end
```
The following is the list of supported options:
| Name | Connection key |
|---------------------------|-----------------|
| [Busy Timeout][pragma-to] | `busy_timeout` |
| [Cache Size][pragma-cs] | `cache_size` |
| [Foreign Keys][pragma-fk] | `foreign_keys` |
| [Journal Mode][pragma-jm] | `journal_mode` |
| [Synchronous][pragma-sync] | `synchronous` |
| [WAL autocheckoint][pragma-walck] | `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.
[pragma-to]: https://www.sqlite.org/pragma.html#pragma_busy_timeout
[pragma-cs]: https://www.sqlite.org/pragma.html#pragma_cache_size
[pragma-fk]: https://www.sqlite.org/pragma.html#pragma_foreign_keys
[pragma-jm]: https://www.sqlite.org/pragma.html#pragma_journal_mode
[pragma-sync]: https://www.sqlite.org/pragma.html#pragma_synchronous
[pragma-walck]: https://www.sqlite.org/pragma.html#pragma_wal_autocheckpoint