opened 11:53PM - 24 May 23 UTC
feature
# :grey_question: About
We currently run an ever bigger and complex Neo4J dat…abase as we use it to put[ our whole information system cartography in it](https://dev.to/optnc/our-speech-about-it-holism-at-nodes22-1bpl).
When comes the time to document our relational (eg. PostrgeSQL) database, we use to (through [`Liquibase`](https://docs.liquibase.com/change-types/set-table-remarks.html)) :
- :heavy_check_mark: Put [remarks/comments ](https://www.postgresql.org/docs/current/sql-comment.html)on all database objects (table, columns,...)
- :heavy_check_mark: generate a graph with [schemacrawler](https://www.schemacrawler.com/) that uses previous metadatas
The benfits are that we could totally automate our documentation process from code, within CI from end to end.
:point_right: We would like to achieve the same automated documentation workflow on Neo4J... but currently it looks like we are stuck in the following situation :
- ❌ Put remarks on all database objects (entities & relationships
- :heavy_check_mark: Generate database diagram with [`apoc.meta.graph`](https://neo4j.com/labs/apoc/4.3/overview/apoc.meta/apoc.meta.graph/)
# :pray: Feature request
Make it possible to put remarks (from within `cypher` so we can embed it within [`liquibase/liquibase-neo4j`](https://github.com/liquibase/liquibase-neo4j) ) on any Neo4J object:
- [ ] entities
- [ ] relatrionsships
- [ ] constraints
- [ ] indexes
- [ ] UDF
- [x] Any object... including graphes themselves (already implement I guess :thought_balloon: )
# :bookmark: Resources
- [🌌 Digital identities journey w. Neo4J ](https://dev.to/optnc/digital-identities-journey-w-neo4j-5gep)
- [🕵️ Active Directory Groups audit w. Neo4J](https://dev.to/optnc/active-directory-groups-audit-w-neo4j-483o)
- [🗣️ Our speech about "IT holism" at #nodes22 💡](https://dev.to/optnc/our-speech-about-it-holism-at-nodes22-1bpl)
- [COMMENT on psql](https://www.postgresql.org/docs/current/sql-comment.html)
- [Liquibase `setColumnRemarks`](https://docs.liquibase.com/change-types/set-column-remarks.html)
- [Liquibase `setTableRemarks`](https://docs.liquibase.com/change-types/set-table-remarks.html)
# :weight_lifting: Current alternative
We currelty achieve a manuel documentation process :sweat: .