class

Event::BaseQuery

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

soft delete (archived at)

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) : T
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_creator(record : Event, force : Bool = false) : Event
preload_creator(record : Event, force : Bool = false, &) : Event
preload_creator(record : Event, preload_query : User::BaseQuery, force : Bool = false) : Event
preload_creator(records : Enumerable(Event), force : Bool = false) : Array(Event)
preload_creator(records : Enumerable(Event), force : Bool = false, &) : Array(Event)
preload_creator(records : Enumerable(Event), preload_query : User::BaseQuery, force : Bool = false) : Array(Event)
preload_guests(record : Event, force : Bool = false) : Event
preload_guests(record : Event, force : Bool = false, &) : Event
preload_guests(record : Event, preload_query : Guest::BaseQuery, force : Bool = false) : Event
preload_guests(records : Enumerable(Event), force : Bool = false) : Array(Event)
preload_guests(records : Enumerable(Event), force : Bool = false, &) : Array(Event)
preload_guests(records : Enumerable(Event), preload_query : Guest::BaseQuery, force : Bool = false) : Array(Event)
preload_location(record : Event, force : Bool = false) : Event
preload_location(record : Event, force : Bool = false, &) : Event
preload_location(record : Event, preload_query : Location::BaseQuery, force : Bool = false) : Event
preload_location(records : Enumerable(Event), force : Bool = false) : Array(Event)
preload_location(records : Enumerable(Event), force : Bool = false, &) : Array(Event)
preload_location(records : Enumerable(Event), preload_query : Location::BaseQuery, force : Bool = false) : Array(Event)
truncate(*, cascade : Bool = false, restart_identity : 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

budget(value)
budget
clone

Returns a copy of self with all instance variables cloned.

created_at(value)
created_at
creator_id(value)
creator_id
description(value)
description
end_at(value)
end_at
event_type(value)
event_type
find(id) : T
full_join_creator(where_creator : User::BaseQuery)
full_join_creator
full_join_guests(where_guests : Guest::BaseQuery)
full_join_guests
full_join_location(where_location : Location::BaseQuery)
full_join_location
id(value)
id
inner_join_creator(where_creator : User::BaseQuery)
inner_join_creator
inner_join_guests(where_guests : Guest::BaseQuery)
inner_join_guests
inner_join_location(where_location : Location::BaseQuery)
inner_join_location
join_creator(where_creator : User::BaseQuery)
join_creator
join_guests(where_guests : Guest::BaseQuery)
join_guests
join_location(where_location : Location::BaseQuery)
join_location
left_join_creator(where_creator : User::BaseQuery)
left_join_creator
left_join_guests(where_guests : Guest::BaseQuery)
left_join_guests
left_join_location(where_location : Location::BaseQuery)
left_join_location
location_id(value)
location_id
name(value)
name
organizer_notes(value)
organizer_notes
preload_creator(preload_query : User::BaseQuery) : self
preload_creator
preload_creator
preload_guests(preload_query : Guest::BaseQuery) : self
preload_guests
preload_guests
preload_location(preload_query : Location::BaseQuery) : self
preload_location
preload_location
right_join_creator(where_creator : User::BaseQuery)
right_join_creator
right_join_guests(where_guests : Guest::BaseQuery)
right_join_guests
right_join_location(where_location : Location::BaseQuery)
right_join_location
slug(value)
slug
start_at(value)
start_at
status(value)
status
total_cost(value)
total_cost
update(id : Int64 | Avram::Nothing = IGNORE, created_at : Time | Avram::Nothing = IGNORE, updated_at : Time | Avram::Nothing = IGNORE, name : String | Avram::Nothing = IGNORE, slug : String | Avram::Nothing = IGNORE, description : String | Avram::Nothing | Nil = IGNORE, organizer_notes : String | Avram::Nothing | Nil = IGNORE, status : Event::Status | Avram::Nothing = IGNORE, start_at : Time | Avram::Nothing | Nil = IGNORE, end_at : Time | Avram::Nothing | Nil = IGNORE, total_cost : Float64 | Avram::Nothing | Nil = IGNORE, budget : Float64 | Avram::Nothing | Nil = IGNORE, event_type : String | Avram::Nothing | Nil = IGNORE, creator_id : User::PrimaryKeyType | Avram::Nothing = IGNORE, location_id : Location::PrimaryKeyType | Avram::Nothing | Nil = IGNORE) : 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_creator(assoc_query : User::BaseQuery, auto_inner_join : Bool = true)

DEPRECATED Use any of the join methods with a where_creator argument instead

where_guests(assoc_query : Guest::BaseQuery, auto_inner_join : Bool = true)

DEPRECATED Use any of the join methods with a where_guests argument instead

where_location(assoc_query : Location::BaseQuery, auto_inner_join : Bool = true)

DEPRECATED Use any of the join methods with a where_location argument instead

Macros

generate_criteria_method(name, type)