For the complete documentation index, see llms.txt. This page is also available as Markdown.

Collections

Anytime your results return multiple values then an instance of Collection is returned. This allows you to iterate over your values and has a lot of shorthand methods.

When using collections as a query result you can iterate over it as if the collection with a normal list:

users = User.get() #== <masoniteorm.collections.Collection>
users.count() #== 50
users.pluck('email') #== <masoniteorm.collections.Collection> of emails

for user in users:
  user.email #== 'joe@masoniteproject.com'

Available Methods

all

avg

chunk

collapse

contains

count

diff

each

every

filter

first

flatten

for_page

forget

get

group_by

implode

is_empty

last

map_into

map

max

merge

pluck

pop

prepend

pull

push

put

reduce

reject

reverse

serialize

shift

sort

sum

take

to_json

transform

unique

where

zip

Last updated