Persisting to the Database
Keep on Learning!
If you liked what you've learned so far, dive in! Subscribe to get access to this tutorial plus video, code and script downloads.
With a Subscription, click any sentence in the script to jump to that part of the video!
Login SubscribeNow that we have an entity class and corresponding table, we're ready to save some stuff! So... how do we insert rows into the table? Wrong question! We're only going to focus on creating objects and saving them. Doctrine will handle the insert queries for us.
To help do this in the simplest way possible, let's make a fake "new Vinyl Mix" page.
In the src/Controller/ directory, create a new MixController class and make this extend the normal AbstractController. Perfect! Inside, add a public function called new() that will return a Response from HttpFoundation. To make this a page, above, use the #[Route] attribute, hit "tab" to autocomplete that and let's call the URL /mix/new. Finally, to see if this is working, dd('new mix').
| // ... lines 1 - 4 | |
| use Symfony\Bundle\FrameworkBundle\Controller\AbstractController; | |
| use Symfony\Component\HttpFoundation\Response; | |
| use Symfony\Component\Routing\Annotation\Route; | |
| class MixController extends AbstractController | |
| { | |
| ('/mix/new') | |
| public function new(): Response | |
| { | |
| dd('new mix'); | |
| } | |
| } |
In the real world, this page might render a form. Then, when we submit that form, we would take its data, create a VinylMix() object and save it. We'll work on stuff like that in a future tutorial. For now, let's just see if this page works. Head over to /mix/new and... got it!
Ok, let's go create a VinylMix() object! Do that with $mix = new VinylMix()... and then we can start setting data on it! Let's create a mix of one of my absolute favorite artists as a kid. I'll quickly set some other properties... we need to set, at the very least, all of the properties that have required columns in the database. For trackCount, how about some randomness for fun. And, for votes, the same thing... including negative votes... though the Internet would never be so cruel as to downvote any of my mixes that much. Finally, dd($mix).
| // ... lines 1 - 12 | |
| public function new(): Response | |
| { | |
| $mix = new VinylMix(); | |
| $mix->setTitle('Do you Remember... Phil Collins?!'); | |
| $mix->setDescription('A pure mix of drummers turned singers!'); | |
| $mix->setGenre('pop'); | |
| $mix->setTrackCount(rand(5, 20)); | |
| $mix->setVotes(rand(-50, 50)); | |
| dd($mix); | |
| } | |
| // ... lines 24 - 25 |
So far, this has nothing to do with Doctrine. We're just creating an object and setting data onto it. This data is hard-coded, but you can imagine replacing this with whatever the user just submitted via a form. Regardless of where we get the data, when we refresh... we have an object with data on it. Cool!
Services vs Entities
By the way, our entity class, VinylMix, is the first class we've created that is not a service. There are generally two types of classes. First, there are service objects, like TalkToMeCommand or the MixRepository we created in the last tutorial. These objects do work... but they don't hold any data besides maybe some basic config. And we always fetch services from the container, usually via autowiring. We never instantiate them directly.
The second type of classes are data classes like VinylMix. The primary job of these classes is to hold data. They don't usually do any work except maybe some basic data manipulation. And unlike services, we don't fetch these objects from the container. Instead, we create them manually wherever and whenever we need them, like we just did!
Hello Entity Manager!
Anyway, now that we have an object, how can we save it? Well, saving something to the database is work. And so, no surprise, that work is done by a service! Add an argument to the method, type-hinted with EntityManagerInterface. Let's call it $entityManager.
EntityManagerInterface is, by far, the most important service for Doctrine. We're going to use it to save, and indirectly when we query. To save, call $entityManager->persist() and pass it the object that we want to save (in this case, $mix). Then we also need to call $entityManager->flush() with no arguments.
| // ... lines 1 - 5 | |
| use Doctrine\ORM\EntityManagerInterface; | |
| // ... lines 7 - 10 | |
| class MixController extends AbstractController | |
| { | |
| // ... line 13 | |
| public function new(EntityManagerInterface $entityManager): Response | |
| { | |
| // ... lines 16 - 22 | |
| $entityManager->persist($mix); | |
| $entityManager->flush(); | |
| // ... lines 25 - 30 | |
| } | |
| } |
But... wait. Why do we have to call two methods?
Here's the deal. When we call persist(), that doesn't actually save the object or talk to the database at all. It just tells Doctrine:
Hey! I want you to be "aware" of this object, so that later when we call
flush(), you'll know to save it.
Most of the time, you'll see these two lines together - persist() and then flush(). The reason it's split into two methods is to help with batch data loading... where you could persist a hundred $mix objects and then flush them to the database all at once, which is more efficient. But most of the time, you'll call persist() and then flush().
Okay, to make this a valid page, let's return new Response() from HttpFoundation and I'll use sprintf to return a message: mix %d is %d tracks of pure 80\'s heaven... and for those two wildcards, pass $mix->getId() and $mix->getTrackCount().
| // ... lines 1 - 13 | |
| public function new(EntityManagerInterface $entityManager): Response | |
| { | |
| // ... lines 16 - 25 | |
| return new Response(sprintf( | |
| 'Mix %d is %d tracks of pure 80\'s heaven', | |
| $mix->getId(), | |
| $mix->getTrackCount() | |
| )); | |
| } | |
| // ... lines 32 - 33 |
Let's try it! Move over, refresh and... yes! We see "Mix 1". That's so cool! We never actually set the ID (which makes sense). But when we saved, Doctrine grabbed the new ID and put that onto the id property.
If we refresh a few more times, we get mixes 2, 3, 4, 5, and 6. That's super fun. All we had to do is persist and flush the object. Doctrine handles all of the querying stuff for us.
Another way we can prove this is working is by running:
symfony console doctrine:query:sql 'SELECT * FROM vinyl_mix'
This time, we do see the results. Awesome!
Okay, now that we have stuff in the database, how do we query for it? Let's tackle that next.
23 Comments
Hi,
I running on Wsl2 Ubuntu 24.04, Windows Desktop Docker, PHP 8.3. PDO drivers installed,
all original files from this course. All was working fine with database until I got to this point in the Chapter to test added code below:
refreshed page and get error - "An exception occurred in the driver: could not find driver"
Solution was very simple:
and restart a server:
I did not change anything in code and now all works. strange, maybe it was just my setup in wsl or something in windows.
Hey @OjarsBluzma
Happy that you solved the issue, unfortunately sometimes it happens.
Cheers!
Hello guys,
After creating the MixController class and refreshing the page in the browser I got a class not find error:
"Attempted to load class "ClassUtils" from namespace "Doctrine\Common\Util". Did you forget a "use" statement for another namespace?"
I think the problem seems to occur from these lines of code (shown below). Before them, I successfully created the VinylMix object (see it on the page when dumped), but the error happened when I tried to persist it and flush it to the database.
I tried with the same source code posted in the script section for both MixController and VinylMix classes and checked whether I imported exactly the Doctrine\ORM\EntityManagerInterface but got the same result. Thank you for your time!
Hey @valentin_valkanov
The Symfony ux-turbo package is missing a dependency. I'm not sure if that bug is already fixed, you can try upgrading it
composer up symfony/ux-turbo, or you can install the missing dep manuallycomposer require doctrine/common- or, if you're not using turbo you can remove itCheers!
Hello Symfonycasts team,
in this tutorial, when mentioning the creation of forms you say : "We'll work on stuff like that in a future tutorial. For now, let's just see if this page works. Head over to /mix/new and... got it!". Is this tutorial available? If yes could you tell me how it is labelled ?
I would like to have the tutorial where forms are created and used ?
Hey @Benoit-L
Could you tell me what you want to learn about forms? We have a tutorial specific to working with Symfony Forms, it's built on Symfony 4 but all the concepts are still relevant
https://symfonycasts.com/screencast/symfony-forms
In this video, we mention some of the new features of forms for Symfony 6 https://symfonycasts.com/screencast/symfony6-upgrade/form-improvements
Cheers!
I want to be able to edit the data in a form, to create an new entity through a form, eventually update an entity, etc. I see that is is bit different from what it used to be.
For example $form = $this->createForm(ProjectType::class, $project);
then return $this->render('.../.../...twig',[ 'project'=>$project, 'form'=>$form->createView() ]
Thank you for your reply.
Best regards.
Benoit
Got ya, you don't need anything fancy. I recommend our Symfony Forms tutorials, those are a great fit for you
Cheers!
Hi, I get the following error, but I have the pgsql driver in my php ini activated:
Whats wrong? I use the same source code as in your tutorial, on a windows 10 machine, with the docker postgresql db running..
Looking forward to your help, with kind regards, stefan
Hey @Stefan-P
At what point do you get that error?
Did you follow the setup steps described in the README from the project's source code?
Cheers!
Hi. I get the same error too, and I have checked that the pgsql driver in my php.ini is activated. I have completed previous chapter without error. I could create VinylMix entity and added some properties.
I get the error when I added $entityManager->persist($mix);;.
From command line, I can run all database and query commands without error. For example:
symfony console doctrine:query:sql 'SELECT * FROM vinyl_mix'
But It returns (obviously): [OK] The query yielded an empty result set.
Hey @Briantes!
Sorry for the slow reply. Even more sorry that I really don't know what's causing this :/. From some quick checking, it looks like the postgres server might be crashing / losing connection. That would be consistent with it working sometimes, but not other times. But WHY it's crashing, I have no idea. A quick fix is to switch to sqlite for the tutorial. In
.env:Uncomment this line (and make sure any other
DATABASE_URLlines ARE commented:Then, turn show down docker:
docker compose down. That should be it: it'll start using this local file database, and you should be able to keep going.Cheers!
I have the same error, I even uncomment database url you suggested but I get the same error. When the code tries to persist it throws the error:
Hey Manpreet,
It seems your current PHP version does not have a DB driver installed. Please, make sure you install a DB extension. You can see the list of installed extensions by running
php -m. Make sure you have PDO driver installed, if not - try google how to install it on your specific system.Cheers!
Hey Victor! Thanks for you reply, I am using ubuntu 20.04.1
I think I have the drivers for the postgresql. This is the related result from php -m
PDO
pdo_pgsql
pgsql
Is there any other extensions that I need ?
Hey Manpreet,
Hm, seems good to me, it should work with Postgresql I suppose, just don't forget to set up the correct DATABASE_URL in the .env / env.local files, you need to point it to Postgresql DB. Also, just in case, make sure your Postgresql DB server up and running.
Btw, if you're using Docker - it might be a bit more complex setup.
Cheeers!
I ran this command : php bin/console debug:config doctrine --env=dev
doctrine:
The strange part here is driver: pdo_mysql for dev environment its reading pdo_mysql. However my env and env.local both has DATABASE_URL="postgresql://app:!ChangeMe!@127.0.0.1:5432/app?serverVersion=15&charset=utf8"
Anyone knows where/how can I change it? Is it even a problem or normal behaviour?
In dev.log This exception was thrown:
[2023-11-28T13:21:58.837438+00:00] doctrine.INFO: Connecting with parameters array{"driver":"pdo_pgsql","host":"127.0.0.1","port":32768,"user":"app","password":"<redacted>","driverOptions":[],"defaultTableOptions":[],"sslmode":"disable","charset":"utf8"} {"params":{"driver":"pdo_pgsql","host":"127.0.0.1","port":32768,"user":"app","password":"<redacted>","driverOptions":[],"defaultTableOptions":[],"sslmode":"disable","charset":"utf8"}} [] [2023-11-28T13:21:58.840638+00:00] console.CRITICAL: Error thrown while running command "doctrine:database:create". Message: "An exception occurred in the driver: could not find driver" {"exception":"[object] (Doctrine\DBAL\Exception\DriverException(code: 0): An exception occurred in the driver: could not find driver at /home/mkaur/Sites/mixed_vinyl/vendor/doctrine/dbal/src/Driver/API/PostgreSQL/ExceptionConverter.php:87)\n[previous exception] [object] (Doctrine\DBAL\Driver\PDO\Exception(code: 0): could not find driver at /home/mkaur/Sites/mixed_vinyl/vendor/doctrine/dbal/src/Driver/PDO/Exception.php:28)\n[previous exception] [object] (PDOException(code: 0): could not find driver at /home/mkaur/Sites/mixed_vinyl/vendor/doctrine/dbal/src/Driver/PDO/PgSQL/Driver.php:34)","command":"doctrine:database:create","message":"An exception occurred in the driver: could not find driver"} []
Hey @Manpreet-K!
Are you using the Docker integration that I talk about in the README.md file? If so, that Docker container runs Pgsql. And, when using the
symfonybinary for your web server (which we also recommend in the README), it detects that you're running the Docker container and overrides yourDATABASE_URLto point to the Docker container. However, while that container handles actually runniing the pgsql server, you still need to have the pgsql driver for PHP installed locally.So, to answer your question about "how can I make this use mysql" (which is a perfectly great option), the answer is: turn off Docker. Or at least remove the
databasecontainer from thedocker-compose.yamlfile. Then, theDATABASE_URLenvironment variable will not be overridden and you can use whatever you'd like :). You may need to restart your web server through thesymfonybinary after removing the container / turning off docker, but I can't remember for certain!Let me know this helps... or if my guess is way off ;).
Cheers!
Thanks @weaverryan fir your reposonse. I actually use postgres not mysql.
Turns out that I just needed to restart symfony web server. I did everything else : restarting docker, cache clear, updating env.local except restarting symfony server, Now My browser request to persist in db and it works. Dont know what role symfony local server has to play in fixing this. Very wiered. But Thanks a lot, I took this solution from the list of steps you suggested.
Glad you got it! The symfony web server is the layer that detects the running docker database container and adds/overrides the DATABASE_URL environment variable to point to that container. I’m not sure why you needed to restart it (though that might be needed if you start the server first then docker - I can’t remember), but hopefully this clears a bit how the layers work together :).
Cheers!
Hi there,
I have got the following error when I call the page https://127.0.0.1:8000/mix/new
Too few arguments to function Monolog\DateTimeImmutable::__construct(), 0 passed in C:\wamp64\www\code-symfony-doctrine\start\src\Entity\VinylMix.php on line 38 and at least 1 expected
Here is my code below
in VinylMix class
....
#[ORM\Column]
private \DateTimeImmutable $createdAt;
#[ORM\Column]
private int $votes = 0;
public function __construct () {
}
and in MixController :
class MixController extends AbstractController
{
#[Route('/mix/new')]
public function new(EntityManagerInterface $entityManager) : Response {
}
}
I have tried to clear the cache, but it did not help.
I have removed the reference to the field createdAt (that I don't see in the finish directory) and now I have another error message : Attribute "Doctrine\ORM\Mapping\Column" must not be repeated
Hey Benoit,
The problem is that you're instantiating the wrong
DateTimeImmutableclass. You imported the one fromMonolog\DateTimeImmutablebut it should be the one from PHP, just prepend a\so it can look in the general namespace, e.g.new \DateTimeImmutable()Cheers!
Thank you.
"Houston: no signs of life"
Start the conversation!