class

Chat::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_characters(records : Enumerable, preload_query)

preload_characters(record, preload_query)

preload_characters(records : Enumerable)

preload_characters(record)

preload_characters(records : Enumerable, &)

preload_characters(record, &)

preload_creator(records : Enumerable, preload_query)

preload_creator(record, preload_query)

preload_creator(records : Enumerable)

preload_creator(record)

preload_creator(records : Enumerable, &)

preload_creator(record, &)

preload_participants(records : Enumerable, preload_query)

preload_participants(record, preload_query)

preload_participants(records : Enumerable)

preload_participants(record)

preload_participants(records : Enumerable, &)

preload_participants(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.

creator_id(value)

creator_id

find(id)

full_join_characters

full_join_creator

full_join_participants

id(value)

inner_join_characters

inner_join_creator

inner_join_participants

join_characters

join_creator

join_participants

left_join_characters

left_join_creator

left_join_participants

name(value)

name

preload_characters(preload_query : Character::BaseQuery)

preload_characters

preload_creator(preload_query : User::BaseQuery)

preload_creator

preload_participants(preload_query : ChatParticipant::BaseQuery)

preload_participants

right_join_characters

right_join_creator

right_join_participants

update(id : UUID | Avram::Nothing = Avram::Nothing.new, creator_id : User::PrimaryKeyType | Avram::Nothing = Avram::Nothing.new, name : String | Avram::Nothing | Nil = 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)

where_characters(assoc_query : Character::BaseQuery, auto_inner_join : Bool = true)

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

where_participants(assoc_query : ChatParticipant::BaseQuery, auto_inner_join : Bool = true)

Macros

generate_criteria_method(name, type)