CQL Documentation

A high-performance, type-safe ORM for Crystal applications.

Build fast, reliable database applications with compile-time safety and exceptional performance.

Quick Navigation

Installation

Add CQL to your shard.yml:

Then run:

Quick Start

Documentation Structure

Tutorials

Learning-oriented - Step-by-step guides for beginners

• - Build your first application

• - Complete multi-part tutorial

How-to Guides

Task-oriented - Practical steps to accomplish specific goals

• - Define, validate, and enhance models

• - Set up associations

• - Find and filter data

Reference

Information-oriented - Technical descriptions and specifications

• - Common patterns at a glance

• - Terminology definitions

• - Error messages explained

Explanation

Understanding-oriented - Conceptual discussions

• - ORM fundamentals

• - Design pattern overview

Key Features

• Type Safety - Catch errors at compile time

• Multiple Databases - PostgreSQL, MySQL, SQLite

• Active Record - Familiar patterns for rapid development

Getting Help

• - Frequently asked questions

• - Common issues

• - Get support

License

CQL is available under the MIT license.