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() #== 50users.pluck('email') #== <masoniteorm.collections.Collection> of emailsfor user in users:user.email #== '[email protected]'
| | |
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 | random |
reduce | reject | reverse |
serialize | shift | sort |
sum | take | to_json |
transform | unique | where |
zip | | |
The random method returns a random item from the collection
user = User.all().random() #== returns a random User instance
An integer count can be given to random method to specify how many items you would like to randomly retrieve from the collection. A collection will always be returned when the items count is specified
users = User.all().random(3) #== returns a Collection of 3 usersusers.count() #== 3users.all() #== returns a list of 3 users
If the collection length is smaller than specified count a ValueError will be raised.
