How to View and Edit Table and Column Comments with Oracle SQL Developer

In this article I will show you how you can view and edit table and column comments in your Oracle database with free database console - Oracle SQL Developer.

Describing schema elements can save you later from a lot of guesswork and errors - table and column names are not always self-explanatory.

Columns

Let's have a look at column comments first.

View Column Comments

To view comments simply select table and comments will be visible in last column in columns grid on the first tab - Columns (wow, there's a lot of 'columns' in that sentence).

Edit Column Comments (Option 1: Comments Editor - Recommended)

To edit column comments select a table, right click and choose Column > Comment... option:

or extend table columns, select column and choose Comment... option:

This will open column comments editor:

If you chose the first option then you need to specify column from the drop down menu first. Please note that each time you change column from the list your updates are lost so make your mind first and then start typing.

Type in comments in Comment field and save with Apply button.

Edit Column Comments (Option 2: Table Editor)

Another option to edit comments is with table editor. This option is not as safe as you can change table structure by accident.

To enter table editor select table, right click and choose Edit... option:

You will be able to update comments in the last column of Columns grid.

Type in comments and save with OK button. Please note this will apply all the changes you made to columns (or other table elements), including names, data types, etc.

Tables

Let's have a look at table level comments now.

View Table Comments

To view table comment select table and go to Details tab. Scroll down to the last attribute called Comments.

Edit Table Comments (Option 1: Comments Editor - Recommended)

To edit table comments select table, right click and choose Table > Comment...:

This will open table comments editor:

Type in comments in Comment field and save with Apply button.

Edit Table Comments (Option 2: Table Editor)

Just as in case of column comments, you can edit comments with table editor. Again, please be careful as you can change table structure by accident.

To enter table editor select table, right click and choose Edit... option:

Table level comments are available in Comment tab.

When finished save with OK button. Please note this will apply all the changes you made to the table design.

That's it. Now that you have put descriptions into the database it's time to think how to get them out in a usable format. Learn about exporting database documentation with Dataedo (recommended) or SQL Developer.