Get Specific Columns Using “With()” Function in Laravel Eloquent

PhpLaravelOrmEloquentLaravel Query-Builder

Php Problem Overview


I have two tables, User and Post. One User can have many posts and one post belongs to only one user.

In my User model I have a hasMany relation...

public function post(){
    return $this->hasmany('post');
}

And in my post model I have a belongsTo relation...

public function user(){
    return $this->belongsTo('user');
}

Now I want to join these two tables using Eloquent with() but want specific columns from the second table. I know I can use the Query Builder but I don't want to.

When in the Post model I write...

public function getAllPosts() {
    return Post::with('user')->get();
}

It runs the following queries...

select * from `posts`
select * from `users` where `users`.`id` in (<1>, <2>)

But what I want is...

select * from `posts`
select id,username from `users` where `users`.`id` in (<1>, <2>)

When I use...

Post::with('user')->get(array('columns'....));

It only returns the column from the first table. I want specific columns using with() from the second table. How can I do that?

Php Solutions


Solution 1 - Php

Well I found the solution. It can be done one by passing a closure function in with() as second index of array like

Post::query()
    ->with(['user' => function ($query) {
        $query->select('id', 'username');
    }])
    ->get()

It will only select id and username from other table. I hope this will help others.


Remember that the primary key (id in this case) needs to be the first param in the $query->select() to actually retrieve the necessary results.*

Solution 2 - Php

You can do it like this since Laravel 5.5:

Post::with('user:id,username')->get();

Care for the id field and foreign keys as stated in the docs:

> When using this feature, you should always include the id column and > any relevant foreign key columns in the list of columns you wish to > retrieve.

For example, if the user belongs to a team and has a team_id as a foreign key column, then $post->user->team is empty if you don't specifiy team_id

Post::with('user:id,username,team_id')->get();

Also, if the user belongs to the post (i.e. there is a column post_id in the users table), then you need to specify it like this:

Post::with('user:id,username,post_id')->get();

Otherwise $post->user will be empty.

Solution 3 - Php

For loading models with specific column, though not eager loading, you could:

In your Post model

public function user()
{
    return $this->belongsTo('User')->select(['id', 'username']);
}

Original credit goes to https://stackoverflow.com/questions/16994253/laravel-eager-loading-load-only-specific-columns

Solution 4 - Php

When going the other way (hasMany):

User::with(array('post'=>function($query){
    $query->select('id','user_id');
}))->get();

Don't forget to include the foreign key (assuming it is user_id in this example) to resolve the relationship, otherwise you'll get zero results for your relation.

Solution 5 - Php

In Laravel 5.7 you can call specific field like this

$users = App\Book::with('author:id,name')->get();

It is important to add foreign_key field in the selection.

Solution 6 - Php

If you want to get specific columns using with() in laravel eloquent then you can use code as below which is originally answered by @Adam in his answer here in response of this same question, the answer's main code is as below :

Post::with('user:id,username')->get();

So i have used it in my code but it was giving me error of 1052: Column 'id' in field list is ambiguous, so if you guys are also facing same problem

Then for solving it you have to specify table name before the id column in with() method as below code:

Post::with('user:user.id,username')->get();

Solution 7 - Php

I came across this issue but with a second layer of related objects. @Awais Qarni's answer holds up with the inclusion of the appropriate foreign key in the nested select statement. Just as an id is required in the first nested select statement to reference the related model, the foreign key is required to reference the second degree of related models; in this example the Company model.

Post::with(['user' => function ($query) {
        $query->select('id','company_id', 'username');
    }, 'user.company' => function ($query) {
        $query->select('id', 'name');
    }])->get();

Additionally, if you want to select specific columns from the Post model you would need to include the user_id column in the select statement in order to reference it.

Post::with(['user' => function ($query) {
        $query->select('id', 'username');
    }])
    ->select('title', 'content', 'user_id')
    ->get();

Solution 8 - Php

In your Post model:

public function userWithName()
{
    return $this->belongsTo('User')->select(array('id', 'first_name', 'last_name'));
}

Now you can use $post->userWithName

Solution 9 - Php

There is another alternative you can eager load specific columns

public function show(Post $post)
{
    $posts = $post->has('user')->with('user:id,name,email,picture')->findOrFail($post->id);
    return view('your_blade_file_path',compact('posts);
}

In your Post model you should have user relationship also

public function user()
{
    return $this->belongsTo( User::class, 'user_id')->withDefault();
}
Note: It is mentioned in Laravel docs.

https://laravel.com/docs/8.x/eloquent-relationships#eager-loading-specific-columns

Solution 10 - Php

I would like to have the same answer without returning the estado_id

$this->cidade
->with('estado:id,nome')
->select(['id', 'nome', 'estado_id']);

when I don't enter the estado_id in the select

{
      "id": 1100015,
      "nome": "Alta Floresta D'Oeste",
      "estado": null
}

when I enter the estado_id in the select

{
      "id": 1100015,
      "nome": "Alta Floresta D'Oeste",
      "estado_id": 11,
      "estado": {
        "id": 11,
        "nome": "Rondônia"
      }
}

expected

{
      "id": 1100015,
      "nome": "Alta Floresta D'Oeste",
      "estado": {
        "id": 11,
        "nome": "Rondônia"
      }
}

Solution 11 - Php

Note that if you only need one column from the table then using 'lists' is quite nice. In my case i am retrieving a user's favourite articles but i only want the article id's:

$favourites = $user->favourites->lists('id');

Returns an array of ids, eg:

Array
(
    [0] => 3
    [1] => 7
    [2] => 8
)

Solution 12 - Php

If you use PHP 7.4 or later you can also do it using arrow function so it looks cleaner:

Post::with(['user' => fn ($query) => $query->select('id','username')])->get();

Solution 13 - Php

You can also specify columns on related model at the time of accessing it.

Post::first()->user()->get(['columns....']);

Solution 14 - Php

You can try this code . It is tested in laravel 6 version.

Controller code

 public function getSection(Request $request)
{

  Section::with(['sectionType' => function($q) {
      $q->select('id', 'name');
  }])->where('position',1)->orderBy('serial_no', 'asc')->get(['id','name','','description']);
  return response()->json($getSection);
}

Model code

public function sectionType(){
    return $this->belongsTo(Section_Type::class, 'type_id');
}

Solution 15 - Php

I faced the same issue while using belongsToMany relationship with my user model (Laravel 8.x.x).

After a long search and trial and test method. I found out this answer

You have to make sure you are selecting the id's and any foreign keys that would be needed for the relationship from either side of that relationship. This allows Eloquent to match up parents to their children.

Original credit goes to https://stackoverflow.com/a/64233242/1551102

So I included

Groups::select('groupid')
...

And it worked like a charm. Although now I want to know how to hide the groupid field after fetching. I know I can simply loop through the array and remove it. But is there any other method? potentially a simpler and better one.

Solution 16 - Php

Now you can use the pluckmethod on a Collection instance:

This will return only the uuid attribute of the Post model

App\Models\User::find(2)->posts->pluck('uuid')
=> Illuminate\Support\Collection {#983
     all: [
       "1",
       "2",
       "3",
     ],
   }

Solution 17 - Php

Try with conditions.

$id = 1;
Post::with(array('user'=>function($query) use ($id){
    $query->where('id','=',$id);
    $query->select('id','username');
}))->get();

Solution 18 - Php

So, similar to other solutions here is mine:

// For example you have this relation defined with "user()" method
public function user()
{
    return $this->belongsTo('User');
}
// Just make another one defined with "user_frontend()" method
public function user_frontend()
{
    return $this->belongsTo('User')->select(array('id', 'username'));
}

// Then use it later like this
$thing = new Thing();
$thing->with('user_frontend');

// This way, you get only id and username, 
// and if you want all fields you can do this

$thing = new Thing();
$thing->with('user');

Solution 19 - Php

Be careful that if you don't add the key column(s) it won't return anything. If you want to show only the username without the id you could instead define the $visible/$hidden properties within the Model, like so:

app/Models/User.php
protected $visible = ['username'];

Then it will retrieve only username column with:

Post::with('user')->get();

Hiding the key columns:

Alternatively you could hide the key column(s) and then retrieve only the columns you wish.

app/Models/User.php
protected $hidden = ['id'];

Specify which columns you want including the key or else it won't return anything, but this will actually only return the username, because id is $hidden.

Post::with('user:id,username')->get();

Solution 20 - Php

EmployeeGatePassStatus::with('user:id,name')->get();

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionAwais QarniView Question on Stackoverflow
Solution 1 - PhpAwais QarniView Answer on Stackoverflow
Solution 2 - PhpAdamView Answer on Stackoverflow
Solution 3 - Phpuser1669496View Answer on Stackoverflow
Solution 4 - PhpThijsView Answer on Stackoverflow
Solution 5 - Phphendra1View Answer on Stackoverflow
Solution 6 - PhpHaritsinh GohilView Answer on Stackoverflow
Solution 7 - PhpjwarshawView Answer on Stackoverflow
Solution 8 - PhpDuy HoangView Answer on Stackoverflow
Solution 9 - PhpNeeraj TangariyaView Answer on Stackoverflow
Solution 10 - PhpElvis ReisView Answer on Stackoverflow
Solution 11 - Phpomar jView Answer on Stackoverflow
Solution 12 - PhpKornelView Answer on Stackoverflow
Solution 13 - PhpShreyansh PanchalView Answer on Stackoverflow
Solution 14 - PhpMobarak HossenView Answer on Stackoverflow
Solution 15 - PhpLonareView Answer on Stackoverflow
Solution 16 - PhpGiovanni FarView Answer on Stackoverflow
Solution 17 - PhpShirjeel Ahmed KhanView Answer on Stackoverflow
Solution 18 - PhpTomoMihaView Answer on Stackoverflow
Solution 19 - PhpcaiohamamuraView Answer on Stackoverflow
Solution 20 - PhpkushView Answer on Stackoverflow