class

User::BaseQuery

Inherits Avram::PrimaryKeyQueryable < Avram::Queryable < Enumerable < Reference < Object

Constructors

all

Class methods

any?

Returns true if at least one of the collection's members is truthy.

[nil, true, 99].any? # => true
[nil, false].any?    # => false
([] of Int32).any?   # => false
  • #present? does not consider truthiness of elements.
  • #any?(&) and #any(pattern) allow custom conditions.

NOTE: #any? usually has the same semantics as #present?. They only differ if the element type can be falsey (i.e. T <= Nil || T <= Pointer || T <= Bool). It's typically advised to prefer #present? unless these specific truthiness semantics are required.

find(id)
first

Returns the first element in the collection. Raises Enumerable::EmptyError if the collection is empty.

([1, 2, 3]).first   # => 1
([] of Int32).first # raises Enumerable::EmptyError
first?

Returns the first element in the collection. When the collection is empty, returns nil.

([1, 2, 3]).first?   # => 1
([] of Int32).first? # => nil
last
last?
new_with_existing_query(query : Avram::QueryBuilder)
none?

Returns true if all of the elements of the collection are falsey.

[nil, false].none?       # => true
[nil, false, true].none? # => false

It's the opposite of all?.

preload_bonus_account(record : User, force : Bool = false) : User
preload_bonus_account(record : User, force : Bool = false, &) : User
preload_bonus_account(record : User, preload_query : BonusAccount::BaseQuery, force : Bool = false) : User
preload_bonus_account(records : Enumerable(User), force : Bool = false) : Array(User)
preload_bonus_account(records : Enumerable(User), force : Bool = false, &) : Array(User)
preload_bonus_account(records : Enumerable(User), preload_query : BonusAccount::BaseQuery, force : Bool = false) : Array(User)
preload_user_orders(record : User, force : Bool = false) : User
preload_user_orders(record : User, force : Bool = false, &) : User
preload_user_orders(record : User, preload_query : UserOrder::BaseQuery, force : Bool = false) : User
preload_user_orders(records : Enumerable(User), force : Bool = false) : Array(User)
preload_user_orders(records : Enumerable(User), force : Bool = false, &) : Array(User)
preload_user_orders(records : Enumerable(User), preload_query : UserOrder::BaseQuery, force : Bool = false) : Array(User)
truncate(*, cascade : Bool = false)

Removes all data from a table using the TRUNCATE postgres SQL command.

You should run this command with cascade: true if your table columns are referenced by other foreign key constraints. Use delete instead if you don't want to accidentally delete rows referenced elsewhere.

To delete all data referenced by foreign keys as well, set cascade to true.

Instance methods

clone

Returns a copy of self with all instance variables cloned.

created_at(value)
created_at
email(value)
email
find(id)
full_join_bonus_account
full_join_user_orders
id(value)
id
inner_join_bonus_account
inner_join_user_orders
join_bonus_account
join_user_orders
left_join_bonus_account
left_join_user_orders
preload_bonus_account(preload_query : BonusAccount::BaseQuery) : self
preload_bonus_account
preload_user_orders(preload_query : UserOrder::BaseQuery) : self
preload_user_orders
preload_user_orders
right_join_bonus_account
right_join_user_orders
update(id : Int64 | Avram::Nothing = Avram::Nothing.new, created_at : Time | Avram::Nothing = Avram::Nothing.new, updated_at : Time | Avram::Nothing = Avram::Nothing.new, email : String | Avram::Nothing = Avram::Nothing.new) : Int64

Update the records using the query's where clauses, or all records if no wheres are added.

Returns the number of records updated as Int64.

# Update all comments with the word "spam" as spam
CommentQuery.new.body.ilike("spam").update(spam: true)
updated_at(value)
updated_at
where_bonus_account(assoc_query : BonusAccount::BaseQuery, auto_inner_join : Bool = true)
where_user_orders(assoc_query : UserOrder::BaseQuery, auto_inner_join : Bool = true)

Macros

generate_criteria_method(name, type)