How to get enumerated values from a Postgres Database using python plugin

[josedavidricodias]

Hello,
i have a custom python script that executes inside the Docker image of schemacrawler. The python script generates a custom markdown of the tables adapted to my use case.
My command is

 /opt/schemacrawler/bin/schemacrawler.sh
 --server=postgresql
 --host=postgres
 --port=5432
 --log-level=INFO
 --schemas=my_schema
 --database=${POSTGRES_DATABASE:-temp}
 --user=${POSTGRES_USER:-temp}
 --password=${POSTGRES_PASSWORD:-temp}
 --info-level=maximum
 --command=script
 --script=/scripts/my_custom_script.py 
 --scripting-language=python
 --output-file=/output/new_db.md

while my_custom_script.py would be

from __future__ import print_function

import textwrap
from schemacrawler.schemacrawler import \
  IdentifiersBuilder  # pylint: disable=import-error

# Print document title
if title:
  print("# " + title)
else:
  print("# Database Schema")
print("")

# Build identifier options (for quoting)
identifiers = IdentifiersBuilder.builder().toOptions()

# Iterate over each schema in the catalog
for schema in catalog.getSchemas():

  tables = catalog.getTables(schema)
  if not tables:
    continue

  # Schema heading
  print("## " + schema.fullName)
  print("")

  for table in tables:
    # Table heading
    kind = "view" if table.tableType.isView() else "table"
    print("### " + table.name + " (" + kind + ")")
    if table.remarks:
      print("")
      print(table.remarks)
    print("")

    # === Columns ===
    print("#### Columns")
    print("| Name | Type | PK | FK | Nullable | Comments |")
    print("| - | - | - | - | - | - |")
    for column in table.columns:
      name = column.name
      dtype = column.columnDataType.toString()
      is_pk = "X" if column.isPartOfPrimaryKey() else ""
      is_fk = "X" if column.isPartOfForeignKey() else ""
      ...

    # Spacer before next table
    print("")

so far, the tool works incredibly well and fits my needs,

however, i would love that right after all tables have been printed, to print the enums used in the tables of the schema and their possible values.
So far, I have tried without success

1. Implementing the solution in Is it possible to get 'enum' column possible values? #110.
2. Tinkering around with the methods of the catalog and schema objects.

Some metadata regarding schemacrawler:

generated by: SchemaCrawler 16.26.1
generated on: 2025-06-10T14:07:31.574329745
database: PostgreSQL 13.13
driver: PostgreSQL JDBC Driver 42.7.6
operating system: Linux 6.8.0-50-generic
JVM system: Eclipse Adoptium OpenJDK 64-Bit Server VM 21.0.7+6-LTS

[sualeh]

@josedavidricodias Sorry for the late response. Take a look at the Jaba unit test to get an idea of you can use it in Python: code

The idea is that column.columnDataType has .isEnumerated() and .getEnumValues() that will give you what you need. In Python, I expect that the column.columnDataType.enumValues syntax will work, but I have not tried it out.

[josedavidricodias]

Thanks @sualeh for your response. With your help I was able to solve my use-case.

For future reference in case someone stumbles on this, i decided to store all found enums in a dict and then print those at the end. In code, it would be something like

from __future__ import print_function

import textwrap
from schemacrawler.schemacrawler import \
  IdentifiersBuilder  # pylint: disable=import-error
import copy

# Print document title
if title:
  print("# " + title)
else:
  print("# Database Schema")
print("")

# Build identifier options (for quoting)
identifiers = IdentifiersBuilder.builder().toOptions()

# Iterate over each schema in the catalog
for schema in catalog.getSchemas():

  tables = catalog.getTables(schema)
  if not tables:
    continue

  all_enums = dict()  # Holder for all the appearing enums

  # Schema heading
  print("## " + schema.fullName)
  print("")

  for table in tables:
    # Table heading
    kind = "view" if table.tableType.isView() else "table"
    print("### " + table.name + " (" + kind + ")")
    if table.remarks:
      print("")
      print(table.remarks)
    print("")

    # === Columns ===
    print("#### Columns")
    print("| Name | Type | PK | FK | Nullable | Comments |")
    print("| - | - | - | - | - | - |")
    for column in table.columns:
      # Save enums for later display
      if column.getColumnDataType().isEnumerated():
        if column.name not in all_enums.keys():
          all_enums[copy.deepcopy(column.name)] = copy.deepcopy(column.getColumnDataType().getEnumValues())

      name = column.name
      dtype = column.columnDataType.toString()
      is_pk = "X" if column.isPartOfPrimaryKey() else ""
      is_fk = "X" if column.isPartOfForeignKey() else ""
      ...

    # Spacer before next table
    print("")

  # Display all enums
  for enum in all_enums.keys():
    print("### " + enum + " (enum)")
    print("| Value |")
    print("| - |")
    for value in all_enums[enum]:
      print("| " + value + " |")
    print("")