Skip to content

Instantly share code, notes, and snippets.

@msurguy
Last active February 8, 2022 03:13
Show Gist options
  • Save msurguy/5654552 to your computer and use it in GitHub Desktop.
Save msurguy/5654552 to your computer and use it in GitHub Desktop.
Laravel 4 Eloquent Cheat Sheet.

Conventions:

Defining Eloquent model (will assume that DB table named is set as plural of class name and primary key named "id"):

class Shop extends Eloquent {}

Using custom table name

protected $table = 'my_shops';

Using custom primary key (instead of "id"):

protected $primaryKey = 'my_key';

Disabling use of "created_at" and "updated_at" columns:

public $timestamps = false;

Retrieving records:

Retrieving all records(rows) of a given model:

$shops = Shop::all();

Find and get a record by primary key:

$shop = Shop::find(1);

Retrieving single record that matches a certain column : $shop = Shop::where('name', 'Starbucks')->first();

Retrieving specific columns of the result (by default get() returns all columns): $shops = Shop::where('name', 'Starbucks')->get('name','address','url');

Retrieving single column of result : $shopAddresses = Shop::where('name', 'Starbucks')->pluck('address');

Retrieving records matching a criteria:

$profitableShops = Shop::where('orders_cache','>','100')->get(); where() takes 3 parameters, name of the column, operator and value to be compared against. The operator can be one of the following: '=', '<', '>', '<=', '>=', '<>', '!=', 'like', 'not like', 'between', 'ilike'

Retrieve only a specified number of records matching a criteria:

$californianShops = Shop::where('state', 'CA')->take(10)->get();

Skip a specified number of records:

$someShops = Shops::where('name', 'Starbucks')->skip(10)->get();

Combining "skip" and "take" (useful for making custom paginators):

$shops = Shops::where('name', 'Starbucks')->skip(25)->take(25)->get();

Using forPage() to accomplish the above statement:

$shops = Shops::where('name', 'Starbucks')->forPage(2,25)->get();

Aggregates

Counting the number of rows of the query results:

$countStarbucks = Shop::where('name','Starbucks')->count();

Getting a maximum value of the query result:

$maxCoffeePrice = Product::where('name','Coffee')->max('price');

Getting a minimum value of the query result:

$minCoffeePrice = Product::where('name','Coffee')->min('price');

Getting an average value of the query result:

$averageCoffeePrice = Product::where('name','Coffee')->avg('price');

Getting a sum of the query result:

$totalWeight = Product::where('name','Coffee')->sum('weight');

Incrementing and decrementing values of a column:

Shop::where('orders_cache','>','100')->increment('orders_cache');

Shop::where('orders_cache','>','100')->decrement('orders_cache');

Todo :

  • or, between, whereNull, whereIn
  • inserts
  • updates
  • deletes
  • soft deletes
  • unions
  • raw expressions
  • grouping
  • joins
  • Fillable
  • Guarded
@Manc
Copy link

Manc commented Dec 12, 2013

@tacticalcom, try:
Foo::whereIn('bar', array(1,3,10));

@reviloera
Copy link

Thank you Saved me a great deal of time

@eheuristic
Copy link

This is great post.
most of functionality covered in this post of Laravel
Thanks!

@ASFnetwork
Copy link

how to count a distinct will be?

@wilbertverayin
Copy link

how about getting all columns of a table?

@shoaibnawaz
Copy link

SELECT foo, bar from mytable;
MyModel::all() returns all the rows with all columns but I need only few columns. I do not want to specify $hidden in model.
I think ->get(array('foo', 'bar')) will work on Illuminate\Database\Eloquent\Builder and for that I need to use MyModel::where()
According to documentation, where() and get() both are part of builder.
So how to get selected columns for all records without calling where()?

@Wendtly
Copy link

Wendtly commented Sep 11, 2014

Model::get(['field1','field2']);

@tucq88
Copy link

tucq88 commented Nov 7, 2014

Please add some example about complex queries or multi conditions queries. I couldn't find any good example over internet :(

@apache123
Copy link

please add information about relationship in eloquent the docs is not clear

@fitiskin
Copy link

You wrote that by default get() returns all columns:

$shops = Shop::where('name', 'Starbucks')->get('name','address','url');

But nothing about how to do for get only one row (maybe it is not best solution):

$shop = Shop::where('name', 'Starbucks')->select(array('name','address','url'))->first();

@HashmatWaziri
Copy link

how do you pass distinct values from database to select boxes?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment