class

Group::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_memberships(records : Enumerable, preload_query)

preload_memberships(record, preload_query)

preload_memberships(records : Enumerable)

preload_memberships(record)

preload_memberships(records : Enumerable, &)

preload_memberships(record, &)

preload_users(records : Enumerable, preload_query)

preload_users(record, preload_query)

preload_users(records : Enumerable)

preload_users(record)

preload_users(records : Enumerable, &)

preload_users(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

find(id)

full_join_memberships

full_join_users

id(value)

inner_join_memberships

inner_join_users

join_memberships

join_users

left_join_memberships

left_join_users

memberships

preload_memberships(preload_query : Membership::BaseQuery)

preload_memberships

preload_users(preload_query : User::BaseQuery)

preload_users

right_join_memberships

right_join_users

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) : 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

users

where_memberships(assoc_query : Membership::BaseQuery, auto_inner_join : Bool = true)

where_users(assoc_query : User::BaseQuery, auto_inner_join : Bool = true)

Macros

generate_criteria_method(name, type)