module Onyx::SQL

Overview

An SQL ORM for Crystal.

Defined in:

Class Method Summary

.exec(*args, **nargs)
Call #exec on the singleton .repo instance.
.query(*args, **nargs)
Call #query on the singleton .repo instance.
.repo : Onyx::SQL::Repository
Singleton Onyx::SQL::Repository instance.
.repo=(repo : Onyx::SQL::Repository)
Singleton Onyx::SQL::Repository instance.
.scalar(*args, **nargs)
Call #scalar on the singleton .repo instance.
.transaction(&block : DB::Transaction -> )
Put the .repo's current database connection into transaction mode and yield that DB::Transaction object.

Class Method Detail

def self.exec(*args, **nargs) #

Call #exec on the singleton .repo instance.

[View source]

def self.query(*args, **nargs) #

Call #query on the singleton .repo instance.

[View source]

def self.repo : Onyx::SQL::Repository #

Singleton Onyx::SQL::Repository instance. Has Onyx.db as a db and and Onyx.logger as a logger.

[View source]

def self.repo=(repo : Onyx::SQL::Repository) #

Singleton Onyx::SQL::Repository instance. Has Onyx.db as a db and and Onyx.logger as a logger.

[View source]

def self.scalar(*args, **nargs) #

Call #scalar on the singleton .repo instance.

[View source]

def self.transaction(&block : DB::Transaction -> ) #

Put the .repo's current database connection into transaction mode and yield that DB::Transaction object.

All repository requests would be made within the transaction. The transaction is closed after the yield unless it's explicitly closed before (i.e. committed or rolled back).

Onyx::SQL.transaction do |tx|
  Onyx.query(User.where(id: 1)) # Request is made within the transaction
  tx.connection                 # You have access to the raw `DB::Connection` instance
end

[View source]