Comment on page
Clear offers a CLI (Command Line Interface) which is still in Alpha. Documentation for building a new project with Clear + Kemal will be written once the feature is done. As of now, you can just follow the paragraph below.
$ crystal init app <yourappname>
$ cd <yourappname>
Add your dependency in the dependencies list of your
Then download the library:
$ shards install
Assuming your main entry point of your application is
src/main.cr, you can require and initialize Clear:
# append to your require list on top:
# initialize a pool of database connection:
require "clear"load the source code of Clear and provide everything needed to use the library.
Clear::SQL.initprepare a certain number of connection to your database. The URL is a convention used to connect to the database, and follow this schema:
connection_pool_size: 5is 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...).