Added affiliation
Source Link
Paul White
  • 65.1k
  • 25
  • 364
  • 566

If you need to do it within Oracle database then comment command is your answer. But there are couple of disadvantages of documenting schema that way:

  • certain privileges are required (not alwasyalways possible)
  • in some cases you can't interfere with (3rd party/legacy) database
  • you can't use long descriptions (limit to 4000 characters)
  • you can't use or formatted text (directly)
  • you can't add images
  • no easy way to browse documentation

I'd recommend storing documentation in dedicated repository - check Dataedo database documentation tool. It reads schema (and existing comments) and lets you describe every item with rich text and images (for your ERD diagrams). You can then export to nice PDF document or interactive HTML. When schema changes you can sync your documentation with couple clicks.

I'm the product manager of Dataedo.

If you need to do it within Oracle database then comment command is your answer. But there are couple of disadvantages of documenting schema that way:

  • certain privileges are required (not alwasy possible)
  • in some cases you can't interfere with (3rd party/legacy) database
  • you can't use long descriptions (limit to 4000 characters)
  • you can't use or formatted text (directly)
  • you can't add images
  • no easy way to browse documentation

I'd recommend storing documentation in dedicated repository - check Dataedo database documentation tool. It reads schema (and existing comments) and lets you describe every item with rich text and images (for your ERD diagrams). You can then export to nice PDF document or interactive HTML. When schema changes you can sync your documentation with couple clicks.

If you need to do it within Oracle database then comment command is your answer. But there are couple of disadvantages of documenting schema that way:

  • certain privileges are required (not always possible)
  • in some cases you can't interfere with (3rd party/legacy) database
  • you can't use long descriptions (limit to 4000 characters)
  • you can't use or formatted text (directly)
  • you can't add images
  • no easy way to browse documentation

I'd recommend storing documentation in dedicated repository - check Dataedo database documentation tool. It reads schema (and existing comments) and lets you describe every item with rich text and images (for your ERD diagrams). You can then export to nice PDF document or interactive HTML. When schema changes you can sync your documentation with couple clicks.

I'm the product manager of Dataedo.

Source Link
Bad Pitt
  • 264
  • 1
  • 6

If you need to do it within Oracle database then comment command is your answer. But there are couple of disadvantages of documenting schema that way:

  • certain privileges are required (not alwasy possible)
  • in some cases you can't interfere with (3rd party/legacy) database
  • you can't use long descriptions (limit to 4000 characters)
  • you can't use or formatted text (directly)
  • you can't add images
  • no easy way to browse documentation

I'd recommend storing documentation in dedicated repository - check Dataedo database documentation tool. It reads schema (and existing comments) and lets you describe every item with rich text and images (for your ERD diagrams). You can then export to nice PDF document or interactive HTML. When schema changes you can sync your documentation with couple clicks.