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) : 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_events(record : User, force : Bool = false) : User

preload_events(record : User, force : Bool = false, &) : User

preload_events(record : User, preload_query : Event::BaseQuery, force : Bool = false) : User

preload_events(records : Enumerable(User), force : Bool = false) : Array(User)

preload_events(records : Enumerable(User), force : Bool = false, &) : Array(User)

preload_events(records : Enumerable(User), preload_query : Event::BaseQuery, force : Bool = false) : Array(User)

force is an accepted argument, but is ignored

preload_invitations(record : User, force : Bool = false) : User

preload_invitations(record : User, force : Bool = false, &) : User

preload_invitations(record : User, preload_query : Guest::BaseQuery, force : Bool = false) : User

preload_invitations(records : Enumerable(User), force : Bool = false) : Array(User)

preload_invitations(records : Enumerable(User), force : Bool = false, &) : Array(User)

preload_invitations(records : Enumerable(User), preload_query : Guest::BaseQuery, force : Bool = false) : Array(User)

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

avatar_url(value)

avatar_url

clone

Returns a copy of self with all instance variables cloned.

created_at(value)

created_at

email(value)

encrypted_password(value)

encrypted_password

find(id) : T

full_join_events(where_events : Event::BaseQuery)

full_join_events

full_join_invitations(where_invitations : Guest::BaseQuery)

full_join_invitations

id(value)

inner_join_events(where_events : Event::BaseQuery)

inner_join_events

inner_join_invitations(where_invitations : Guest::BaseQuery)

inner_join_invitations

join_events(where_events : Event::BaseQuery)

join_events

join_invitations(where_invitations : Guest::BaseQuery)

join_invitations

left_join_events(where_events : Event::BaseQuery)

left_join_events

left_join_invitations(where_invitations : Guest::BaseQuery)

left_join_invitations

name(value)

name

preload_events(preload_query : Event::BaseQuery, *, through : Avram::Queryable | Nil = nil) : self

preload_events(*, through : Avram::Queryable | Nil = nil) : self

preload_events(*, through : Avram::Queryable | Nil = nil, &) : self

preload_invitations(preload_query : Guest::BaseQuery) : self

preload_invitations

right_join_events(where_events : Event::BaseQuery)

right_join_events

right_join_invitations(where_invitations : Guest::BaseQuery)

right_join_invitations

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_events(assoc_query : Event::BaseQuery, auto_inner_join : Bool = true)

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

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

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

Macros

generate_criteria_method(name, type)