class

Bit::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_group(records : Enumerable, preload_query)
preload_group(record, preload_query)
preload_group(records : Enumerable)
preload_group(record)
preload_group(records : Enumerable, &)
preload_group(record, &)
preload_user(records : Enumerable, preload_query)
preload_user(record, preload_query)
preload_user(records : Enumerable)
preload_user(record)
preload_user(records : Enumerable, &)
preload_user(record, &)
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
description(value)
description
find(id)
full_join_group
full_join_user
group
group_id(value)
group_id
id(value)
id
inner_join_group
inner_join_user
join_group
join_user
left_join_group
left_join_user
preload_group(preload_query : Group::BaseQuery)
preload_group
preload_group
preload_user(preload_query : User::BaseQuery)
preload_user
preload_user
right_join_group
right_join_user
title(value)
title
update(id : Int64 | Avram::Nothing = Avram::Nothing.new, created_at : Time | Avram::Nothing = Avram::Nothing.new, updated_at : Time | Avram::Nothing = Avram::Nothing.new, title : String | Avram::Nothing = Avram::Nothing.new, url : String | Avram::Nothing = Avram::Nothing.new, description : String | Avram::Nothing | Nil = Avram::Nothing.new, user_id : User::PrimaryKeyType | Avram::Nothing = Avram::Nothing.new, group_id : Group::PrimaryKeyType | 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
url(value)
url
user
user_id(value)
user_id
where_group(assoc_query : Group::BaseQuery, auto_inner_join : Bool = true)
where_user(assoc_query : User::BaseQuery, auto_inner_join : Bool = true)

Macros

generate_criteria_method(name, type)