$ crystal init app <yourappname>$ cd <yourappname>
Add your dependency in the dependencies list of your
dependencies:clear:github: anykeyh/clearbranch: master
Then download the library:
$ shards install
Assuming your main entry point of your application is
src/main.cr , you can require and initialize Clear:
require "clear" load the source code of Clear and provide everything needed to use the library.
Clear::SQL.init prepare a certain number of connection to your database. The URL is a convention used to connect to the database, and follow this schema:
More information about the URL notation can be found here
connection_pool_size: 5 is optional but offers the possibility to concurrent fibers to run query at the same time. It's useful if you use an event-driven server, like Kemal.
You may want to install a smaller version of Clear by calling :
This will add clear without the build-in CLI and without some extensions (jsonb, bcrypt etc...).