Add JSON format option for orm:mapping:describe command output #12071
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This comment was marked as resolved.
This comment was marked as resolved.
stlgaits
force-pushed
the
mapping-command-json-output
branch
from
dc3fb09 to
021c815
Compare
Contributor
Author
|
I've just updated the command help / description + added autocomplete for --format option (with text as default ) |
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
stlgaits
force-pushed
the
mapping-command-json-output
branch
from
021c815 to
f68b1d3
Compare
greg0ire
reviewed
Jul 12, 2025
greg0ire
reviewed
Jul 12, 2025
greg0ire
reviewed
Jul 12, 2025
stlgaits
force-pushed
the
mapping-command-json-output
branch
2 times, most recently
from
45b9e8f to
915f5ed
Compare
greg0ire
reviewed
Jul 21, 2025
SenseException
requested changes
Jul 21, 2025
stlgaits
force-pushed
the
mapping-command-json-output
branch
from
ec98aea to
88c395c
Compare
greg0ire
approved these changes
Jul 22, 2025
SenseException
approved these changes
Jul 22, 2025
Member
|
Thanks @stlgaits ! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Following suggestion from doctrine/DoctrineBundle#1883, this PR adds the
--format=jsonoption to theorm:mapping:describecommand to enable JSON output (hence allowing jq filtering of said-output).For example, when running
symfony console doctrine:mapping:describe App\\Entity\\Book --format=json, we get the following output :{ "name": "App\\Entity\\Book", "rootEntityName": "App\\Entity\\Book", "customGeneratorDefinition": null, "customRepositoryClassName": "App\\Repository\\BookRepository", "isMappedSuperclass": false, "isEmbeddedClass": false, "parentClasses": [], "subClasses": [], "embeddedClasses": [], "identifier": [ "id" ], "inheritanceType": 1, "discriminatorColumn": null, "discriminatorValue": null, "discriminatorMap": [], "generatorType": 4, "table": { "name": "book" }, "isIdentifierComposite": false, "containsForeignIdentifier": false, "containsEnumIdentifier": false, "sequenceGeneratorDefinition": null, "changeTrackingPolicy": 1, "isVersioned": false, "versionField": null, "isReadOnly": false, "entityListeners": [], "associationMappings": { "author": { "cascade": [], "fetch": 2, "inherited": null, "declared": null, "cache": null, "id": null, "isOnDeleteCascade": true, "originalClass": null, "originalField": null, "orphanRemoval": false, "unique": null, "fieldName": "author", "sourceEntity": "App\\Entity\\Book", "targetEntity": "App\\Entity\\Author", "inversedBy": "books", "indexBy": null, "orderBy": [], "joinTable": { "quoted": null, "joinColumns": [ { "deferrable": null, "unique": null, "quoted": null, "fieldName": null, "onDelete": "CASCADE", "columnDefinition": null, "nullable": null, "options": null, "name": "book_id", "referencedColumnName": "id" } ], "inverseJoinColumns": [ { "deferrable": null, "unique": null, "quoted": null, "fieldName": null, "onDelete": "CASCADE", "columnDefinition": null, "nullable": null, "options": null, "name": "author_id", "referencedColumnName": "id" } ], "options": [], "schema": null, "name": "book_author" }, "joinTableColumns": [ "book_id", "author_id" ], "relationToSourceKeyColumns": { "book_id": "id" }, "relationToTargetKeyColumns": { "author_id": "id" } } }, "fieldMappings": { "id": { "length": null, "id": true, "nullable": false, "notInsertable": null, "notUpdatable": null, "columnDefinition": null, "generated": null, "enumType": null, "precision": null, "scale": null, "unique": false, "index": false, "inherited": null, "originalClass": null, "originalField": null, "quoted": null, "declared": null, "declaredField": null, "options": null, "version": null, "default": null, "type": "integer", "fieldName": "id", "columnName": "id" }, "title": { "length": 255, "id": null, "nullable": false, "notInsertable": null, "notUpdatable": null, "columnDefinition": null, "generated": null, "enumType": null, "precision": null, "scale": null, "unique": false, "index": false, "inherited": null, "originalClass": null, "originalField": null, "quoted": null, "declared": null, "declaredField": null, "options": null, "version": null, "default": null, "type": "string", "fieldName": "title", "columnName": "title" }, "price": { "length": null, "id": null, "nullable": false, "notInsertable": null, "notUpdatable": null, "columnDefinition": null, "generated": null, "enumType": null, "precision": null, "scale": null, "unique": false, "index": false, "inherited": null, "originalClass": null, "originalField": null, "quoted": null, "declared": null, "declaredField": null, "options": null, "version": null, "default": null, "type": "integer", "fieldName": "price", "columnName": "price" }, "topics": { "length": null, "id": null, "nullable": true, "notInsertable": null, "notUpdatable": null, "columnDefinition": null, "generated": null, "enumType": null, "precision": null, "scale": null, "unique": false, "index": false, "inherited": null, "originalClass": null, "originalField": null, "quoted": null, "declared": null, "declaredField": null, "options": null, "version": null, "default": null, "type": "json", "fieldName": "topics", "columnName": "topics" } } }which we can then filter using jq - for example :
will output a simple fieldMapping + typehint list
Bonus small fix of embeddedClasses output which falsely returned subClasses