Add a column to an existing entity in Symfony - php

I've been playing around with Symfony on my web server and I've been creating entity with doctrine for my database. I wanted to add a column to one of these entity... I wanted to do something like:
php app/console doctrine:modify:entity
Now I know that this command doesn't exists, but is there a way (without doing a whole migration) to simply add a column.
P.S. I know I could open the php file and textually add the column there and then update the schema, but I'm distributing this to some clients and I like a more "command-line-like" approach.

Actually, using Doctrine does not make sense at all to do something like you suggested.
Doctrine is a ORM (Object-Relational Mapping) tool. It means that you want to abstract the database from your PHP code, you delegate database stuff to Doctrine. Doctrine does a wonderful job on that area.
As you want to keep your customers/peers updated with the latest version of the model, you should use the Doctrine Migrations ( http://symfony.com/doc/current/bundles/DoctrineMigrationsBundle/index.html ). That's the way to manage database updates. Moreover, it gives you complete control on what to do when upgrading/downgrading the database. You could, e.g., set default values before you add the FK.
The steps for adding a new property on the class should be:
For Symfony 2:
modify the class by:
Acme\MyBundle\Entity\Customer and add the property you want;
Acme\MyBundle\Entity\Customer
or modify the doctrine file:
Acme/MyBundle/Resources/config/doctrine/customer.yml
run the console command (it will add the proper set/get in the class)
php app/console doctrine:generate:entities AcmeMyBundle:Customer
run the console command
php app/console doctrine:migrations:diff
run the console command (it will place a new file on app/DoctrineMigrations)
php app/console doctrine:migrations:migrate
When you're deploying the new version of the code, all you got to do is update the source code and run the command above.
For Symfony 3:
modify the class by:
Acme\MyBundle\Entity\Customer and add the property you want;
Acme\MyBundle\Entity\Customer
or modify the doctrine file:
Acme/MyBundle/Resources/config/doctrine/customer.yml
run the console command (it will add the proper set/get in the class)
php bin/console doctrine:generate:entities AcmeMyBundle:Customer
run the console command (update database)
php bin/console doctrine:schema:update --force

Add new Column in Existing entity on Symfony. I have the same problem are there . after I long research best solutions are there.
solution work on Symfony 4
Example:
Blog entity already created inside one name column are there and I want to add description column. so simple enter
php bin/console make:entity Blog
After run this command you want to add new column

You definitely DO want to open the PHP/XML/YML file where your entity is defined and add the column there. Then, you use the commandline and say
console doctrine:schema:update
That way, your entity definitions are in sync with the database and your database gets updated.

There is a pitfall on step php app/console doctrine:migrations:diff described above when using doctrine migrations.
You made changes in entity, all seems valid, but the command on creating migrations php app/console doctrine:migrations:diff says "No changes detected in your mapping information."
And you can't find where's the old database structure placed, search in files found nothing.
For me, the key was to clear Redis cache.
php app/console redis:flushdb
It happens because of config.yml
snc_redis:
clients:
default:
type: predis
alias: default
dsn: redis://localhost
doctrine:
query_cache:
client: default
entity_manager: default
namespace: "%kernel.root_dir%"
metadata_cache:
client: default
entity_manager: default
document_manager: default
namespace: "%kernel.root_dir%"
result_cache:
client: default
namespace: "%kernel.root_dir%"
entity_manager: [default, read] # you may specify multiple entity_managers
After that, migrations:diff reread all of entities (instead of taking outdated ones metadata from cache) and created the right migration.
So, the full chain of steps for modifying entities is:
Modify your entity class (edit Entity file)
Clear Redis cache of metadata ( php app/console redis:flushdb )
Create (and may be edit) migration ( php app\console doctrine:migrations:diff )
Execute migration ( php app\console doctrine:migrations:migrate )
Of course, your doctrine metadata cache may be not Redis but something else, like files in app/cache or anything other. Don't forget to think about cache clearing.
May be it helps for someone.

I found a way in which I added the new column inside YourBundle/Resources/Config/doctrine/Yourentity.orm.yml.
Then added getter and setter methods inside Entity class.
Then did php app/console doctrine:schema:update --force from console. It worked for me.

FOR SYMFONY3 USERS...
here you have to follow two steps to make changes in your entity
Step1: Open Your Entity File..For EX: "Acme\MyBundle\Entity\Book"
Current Entity is having few fields like:id,name,title etc.
Now if you want to add new field of "image" and to make change constraint of "title" field then add field of "image" with getter and setter
/**
* #var string
*
* #ORM\Column(name="image", type="string", length=500)
*/
private $image;
And add getter and setter
/**
* Set image
*
* #param string $image
*
* #return Book
*/
public function setImage($image)
{
$this->image = $image;
return $this;
}
/**
* Get image
*
* #return string
*/
public function getimage()
{
return $this->image;
}
To update existing field constraint of title from length 255 to 500
/**
* #var string
*
* #ORM\Column(name="title", type="string", length=500)
*/
private $title;
Ok...You have made changes according to your need,And You are one step away.
Step 2: Fire this command in project directory
php bin/console doctrine:schema:update --force
Now,check your table in database ,It's Done!!

f you need to add a new field property to an existin entity you can use make:entity
$ php bin/console make:entity
Class name of the entity to create or update
"existingentity"
New property name (press to stop adding fields):
description
Field type (enter ? to see all types) [string]:
text
Can this field be null in the database (nullable) (yes/no) [no]:
no
New property name (press to stop adding fields):
(press enter again to finish)
information extracted from https://symfony.com/doc/current/doctrine.html

I think, you need to update your relation table manually to map the relations.
I found this:discussion
Again, We can generate entities from existing database, as a whole, but separately? :(

That's how it worked for me:
add new vars, setters and getters inside the existing class:
src-->AppBundle-->Entity-->YourClassName.php
update the ORM File:
src-->AppBundle-->Resources-->config-->doctrine-->YourClassName.orm.yml
run bash command:
php bin/console doctrine:schema:update --force

Related

How can I change a property type with maker-bundle on symfony

I created a table with a PRICE property but I made it to be an Integer and I would want to change it to a FLOAT type.
The problem is that I made a migration and now the problem is also on database so I cannot change simply the PHP code I think.
You can change property type in your entity class (also in getter & setter )
And make a :
" symfony console doctrine:schema:update -F " to update your database.

Unknown database type enum requested, Doctrine\DBAL\Platforms\MySQL57Platform may not support it. Symfony

I created a fresh symfony4 project. Made user Entity using php bin/console make:user, then tried to migrate using php bin/console make:migration. But then the error pops up
In AbstractPlatform.php line 434:
Unknown database type enum requested,
Doctrine\DBAL\Platforms\MySQL57Platform may not support it.
The strange thing is the User entity doesn't have any enum type rather it has a json column of roles, I suppose this is the reason.
/**
* #ORM\Column(type="json")
*/
private $roles = [];
I have seen some answers for the similar question for laravel, But don't know how to fix it in symfony4.
Couldn't reproduce your issue. But anyway you can set up enum type in doctrine.yaml like
doctrine:
dbal:
.....
mapping_types:
enum: string
To fix this, you can register that type mapping on your migration:
DB::connection()->getDoctrineSchemaManager()->getDatabasePlatform()->registerDoctrineTypeMapping('enum', 'string');
Also, you could register it on app\Providers\AppServiceProvider.php.
public function boot() {
// ...
DB::connection()
->getDoctrineSchemaManager()
->getDatabasePlatform()
->registerDoctrineTypeMapping('enum', 'string');
// ....
}
Source: https://github.com/doctrine/dbal/issues/3161#issuecomment-542814085

Symfony2 - cannot update doctrine schema. Base table or view already exists

I have two separated Symfony projects working with one database.
The first project is on Symfony 3.2 and the second is on Symfony 2.8.
Database is MySQL.
All is in production stage and all is working fine.
Now I have some Entity classes in the first project and don't have them in the second one. We haven't needed the entities in the second project before but now I need to work with them in the second project.
I copied the entities from the first project to the second. We use annotations.
After this I checked my database and executed the command on the second project:
app/console doctrine:schema:update --force
And got the error: Base table or view already exists: 1050 Table 'crm_user' already exists.
If I execute the command with --dump-sql option (app/console doctrine:schema:update --dump-sql) I see creation the table that already exists!
CREATE TABLE crm_user (id INT AUTO_INCREMENT NOT NULL, ...
So the doctrine schema update doesn't see that the DB table has been already created. How to fix it?
I tried to clear all cache (cache:clear), doctrine metadata cache (doctrine:cache:clear-metadata), query cache (doctrine:cache:clear-query) and no success. I got the same error after this.
If I try to validate doctrine schema there will not be the new table.
And of course I cannot drop tables data because all is in production stage.
May be someone faced problems like this. I appreciate any suggestions.
I highly recommend not messing like this with two different projects and a single DB. If you need so, then simply let one be the Doctrine "master" where you do the modifications, and only there run the schema:update.
Better than that, and way more elegant, would be to create a vendor that you can import with composer and it's your Doctrine entities vendor.
This will then manage all the DB / Repositories and you can re-use it for many different projects having the code only in one place.
That will solve this and fix what you are not doing right in my point of view:
Having duplicate entities pointing to the same DB structure, which will be always be a pain to maintain, and it does not deal well with the KISS principle and code duplication.
If you can't include orm definitions using a shared project via composer like Jason suggested, you could create a regex to filter which tables each app should be concerned with.
Example with zend expressive:
/**
* #var \Doctrine\ORM\EntityManager $em
*/
$em = $container->get('doctrine.entity_manager.orm_default'); // substitute with how you get your entity manager
$filter = 'crm_user|other_table|another_table';
$em->getConnection()
->getConfiguration()
->setFilterSchemaAssetsExpression('/'.$filter.'/');
dynamically...
/**
* #var \Doctrine\ORM\EntityManager $em
*/
$em = $container->get('doctrine.entity_manager.orm_default');
$metadata = $em->getMetadataFactory()->getAllMetadata();
if(!empty($metadata)){
$filter = '';
/**
* #var \Doctrine\ORM\Mapping\ClassMetadata $metadatum
*/
foreach($metadata as $metadatum){
$filter .= ($metadatum->getTableName().'|');
$assocMappings = $metadatum->getAssociationMappings();
if(!empty($assocMappings)){
// need to scoop up manyToMany association table names too
foreach($assocMappings as $fieldName => $associationData){
if(isset($associationData['joinTable'])){
$joinTableData = $associationData['joinTable'];
if(isset($joinTableData['name']) && strpos($filter, $joinTableData['name']) === false){
$filter .= ($joinTableData['name'].'|');
}
}
}
}
}
$filter = rtrim($filter, '|');
$em->getConnection()->getConfiguration()
->setFilterSchemaAssetsExpression('/'.$filter.'/');
}

How to prevent Doctrine from dropping computed/generated column

I use MariaDB for a Symfony project and have setup a computed column with:
ALTER TABLE history_event ADD quote_status_change SMALLINT AS (JSON_VALUE(payload, '$.change_set.status[1]'));
When I run Doctrine migrations with bin/console doctrine:schema:update, the computed column is dropped, probably because it doesn't appear anywhere in the HistoryEvent entity class.
How can I prevent Doctrine from dropping computed columns when I run migrations ?
I solved this in doctrine 2.10 using the OnSchemaColumnDefinition Event. My code looked something like this:
public function onSchemaColumnDefinition(SchemaColumnDefinitionEventArgs $eventArgs)
{
if ($eventArgs->getTable() === 'my_table') {
if (!in_array($eventArgs->getTableColumn()['field'], ['id', 'column_1', 'column_2'])) {
$eventArgs->preventDefault();
}
}
}
In my case I'm using Symfony 4.2 so I set the event listener class up as per.
I'm afraid you might be out of luck, there is an open feature request but it's not implemented yet: https://github.com/doctrine/doctrine2/issues/6434

Symfony2: Base table or view not found: 1146

Problem
Hi, I"m working with a friend on a Symfony2 project. He's working on a Windows based computer and I'm on my Mac.
We setup the project and made the database model / entities (code first) on his computer. Now I wanted to start working on it as well so we did a SQL dumb to my localhost. I edited the parameters.yml to match my settings. The project can connect to the server.
But when I try to open a page where the database is used i get this error:
An exception occurred while executing 'SELECT t0.id AS id1, t0.name AS name2, t0.bigimage AS bigimage3, t0.smallimage AS smallimage4, t0.info AS info5, t0.city_id AS city_id6 FROM District t0':
SQLSTATE[42S02]: Base table or view not found: 1146 Table 'socialgeogroep6.District' doesn't exist
500 Internal Server Error - DBALException
1 linked Exception: PDOException ยป
Just to be clear, the page is running normal on his computer; he gets the data as it should be.
Question
What can be the problem? I looked in my PHPmyAdmin over and over again and the database is there with all the fields and data...
(screen: http://gyazo.com/4a0e5f1ee6b1e29d2d277df5fc0d8aac)
I really can't imagine what the problem is.
I hope someone can help us!
It's likely a case issue. You have the district table on your database, but doctrine is asking for the District table.
You should configure doctrine to use lower case table name. Refer to the doctrine documentation http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/basic-mapping.html#persistent-classes to know how to do so.
I just had exactly the same kind of problem because i'm writing code on windows and i need to deploy on linux.
The solution is to add in config.yml the line:
doctrine:
orm:
naming_strategy: doctrine.orm.naming_strategy.underscore
This work for my in symfony 2.7. Just put in config.yml:
doctrine:
# ...
orm:
# ...
entity_managers:
default:
naming_strategy: doctrine.orm.naming_strategy.underscore
Table name case issue
socialgeogroep6.District
It should be socialgeogroep6.district as per the screenshot. Check the Entity annotation.
A word of caution: Before reading this solution. This is strictly a solution for those who are trying to set up the framework.
I think since you are just starting to try out, what you could do is, drop database and then start everything afresh.
- mysql -uroot -proot
- show databases;
- drop database <dbname>;
Then, recreate the tables.
- app/console doctrine:database:create
- app/console doctrine:schema:create
A word of caution it might be a very BAD idea to do this in production environment if you have already created your controllers and data is already populated.
If you are using Orm, you can set up it like this
District.orm.yml
Project\Bundle\DuterteBundle\Entity\Vp:
type: entity
table: district//note the lowercase
repositoryClass: Project\Bundle\DuterteBundle\Repository\VpRepository
May be missed to add singular table name object.
<?php
namespace App;
use Illuminate\Database\Eloquent\Model;
class Mapping extends Model
{
protected $table = 'mapping';
/**
* The attributes that are mass assignable.
*
* #var array
*/
protected $fillable = [
'user_id', 'mapping', 'name'
];
}

Categories