5.7 Describing Tables

Describe tables or views in LLM-friendly, human readable format.

Use Describe Tables to generate table descriptions. Once downloaded, you can use the generated file as an AI prompt that documents your tables and views.

To generate table descriptions:

1. On the Workspace home page, click SQL Workshop.
2. Click Utilities.
3. Click Describe Tables.
4. On Describe Tables:
   1. Schema - Select the appropriate schema.
   2. Object Type - Select the type of objects to include in the table descriptions. Options include: Both, Table, or Views.
   3. Filter by Name - Filter the list of tables or views using the string provided.
   4. Tables - Select the tables or views you want to move.

      Click the center arrows to select a table or view. To select multiples at once, press and hold the CTRL key.

      To change the order, click the Top, Up, Down, and Bottom arrows on the right.

   5. Format - Select Markdown or Plain Text.
   6. Enable or Disable the following:
      • Include Constraints
      • Include Indexes
      • Include Comments
5. Click Describe.

   The Table Descriptions appears.
6. To copy the Table Descriptions, click Copy.
7. To download the Table Descriptions, click Download.