Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

I would like to ask you a question about the @describe tag. #27

Open
devilofdev opened this issue Jan 13, 2025 · 0 comments
Open

I would like to ask you a question about the @describe tag. #27

devilofdev opened this issue Jan 13, 2025 · 0 comments

Comments

@devilofdev
Copy link

devilofdev commented Jan 13, 2025

hello. I need to add a payment system to my platform
to attach a payment system to the platform.
I'm not a DBA, so I'm working with resources and documentation from my previous company's project, and I found samchon's github repository and it's helping me a lot.
While writing the ERD, I was curious about the comments tags in prisma-markdown that you documented. You explained that the @describe tag is only reflected in the markdown, but when I look at the prisma schema of samchon's shoppingmall-backend, the @describe tag is only commented on 5 tables in Sales, and I'm wondering what the intention of the @Describe tag is for these 5 tables.

umm.. and for the mv table with a lot of '@hidden' tags, there is no separate explanation on ERD.md
May I ask what kind of intent is the table!

안녕하세요. 저는 플랫폼에 결제시스템을 붙이기 위해서 결제와 관련된 테이블 설계를 진행하고 있습니다.

DBA가 아니기 때문에 이전 회사에서 진행했던 프로젝트의 리소스 와 문서를 참고하면서 작업을 하다가
samchon님의 github repository를 찾고 크게 도움을 받고 있습니다.

ERD를 작성하면서 문서화까지 가능한 prisma-markdown의 comments tags를 보면서 궁금증이 생겼습니다.
@describe 태그의 경우 markdown에만 반영이 된다고 설명해주셨습니다. 근데 samchon 님의 shoppingmall-backend의 prisma schema를 보면 @describe 태그는 Sales의 5개의 테이블에만 코멘트가 되어있는데, 이 5개의 테이블이 어떠한 의도로 @describe 태그가 걸렸는지 궁금합니다.

아.. 그리고 @hidden 태그가 많이 걸려있는 mv 테이블의 경우 ERD.md에 별도의 설명이 없어서
어떤 의도의 테이블인지도 여쭙습니다!

@devilofdev devilofdev changed the title I would like to ask you a question about the @describe tag. I would like to ask you a question about the @describe tag. @question Jan 13, 2025
@devilofdev devilofdev changed the title I would like to ask you a question about the @describe tag. @question I would like to ask you a question about the @describe tag. Jan 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant