class DefaultTaxon::BaseQuery

Included Modules

Direct Known Subclasses

Defined in:

Constructors

Class Method Summary

Macro Summary

Instance Method Summary

Constructor Detail

def self.all : self #

Class Method Detail

def self.any? : Bool #
Description copied from module Enumerable(DefaultTaxon)

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.


def self.find(id) : T #

def self.first : T #
Description copied from module Enumerable(DefaultTaxon)

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

def self.first? : T | Nil #
Description copied from module Enumerable(DefaultTaxon)

Returns the first element in the collection. When the collection is empty, returns nil.

([1, 2, 3]).first?   # => 1
([] of Int32).first? # => nil

def self.last : T #

def self.last? : T | Nil #

def self.new_with_existing_query(query : Avram::QueryBuilder) #

def self.none? : Bool #
Description copied from module Enumerable(DefaultTaxon)

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?.


def self.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.


Macro Detail

macro generate_criteria_method(name, type) #

Instance Method Detail

def clone #

Returns a copy of self with all instance variables cloned.


def find(id) : T #

def id(*args, **named_args) #

If not using default 'id' primary key Then point 'id' to the primary key


def is_private(value) #

def is_private #

def taxon_ptr_id(value) #

def taxon_ptr_id #

def update(taxon_ptr_id : UUID | Avram::Nothing = IGNORE, is_private : Bool | Avram::Nothing = IGNORE) : Int64 #
Description copied from module Avram::Queryable(DefaultTaxon)

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)