2012-08-13 16 views
34

Me gustaría añadir una descripción columna (también llamado "comentario") a una columna definida por una entidad Doctrine2 pero no puedo encontrar ninguna información sobre cómo para hacerlo usando el @Column annotation sin posiblemente romper la SchemaTool de Doctrine.¿Cómo añadir descripciones de las columnas (comentarios) en Doctrine2

Si utilizo el atributo columnDefinition del @Column annotation como

@Column(type="string" columnDefinition="COMMENT 'This is a column comment'") 

los estados annotations reference

SchemaTool no detectará los cambios en la columna correctamente si se utiliza más “ColumnDefinition”.

¿Hay alguna forma de definir una descripción de columna sin romper SchemaTool?

La única pista que obtuve fue this pull request que terminó en "Esto se resolvió de diferentes maneras.".

Gracias de antemano.

Respuesta

57

Puede agregar un comentario a un nombre de columna o una tabla completa con el argumento "opciones" a la anotación; por ejemplo:

/** 
* @ORM\Column(type="string", options={"comment":"The string to show in the dropdown "}) 
*/ 

para una columna, o para una tabla:

/** 
* @ORM\Entity 
* @ORM\Table(name="application", options={"comment":"Funding applications"}); 
*/ 

Nota sin embargo, esto no va a añadir comentarios a una tabla o columna existente, hay que eliminar la tabla de la base de datos y reconstruir eso. Si solo está agregando comentarios, puede cambiar el nombre de la tabla, crear la nueva tabla e importar datos del original.

Fuente: Doctrine documentation

+1

Perfecto, gracias! Como estamos en desarrollo en este momento, no hay problema para reconstruir la base de datos. ¿Dónde encontraste esto? Exploré todo el código, pensé ... – flu

+0

Tenga en cuenta que su comentario se agregará a la declaración SQL como está (sin escaparse), por lo tanto, si utiliza apóstrofes en el comentario, asegúrese de escapar de ellos. p.ej. 'options = {" comment "=" La cadena a mostrar en el menú desplegable con el valor predeterminado \ 'none selected \' "}' –

+0

¿Qué pasa con las relaciones? ¿Cómo agregar comentarios a una columna en una relación? – SpartakusMd

Cuestiones relacionadas