sqlcompyre.report package

Subpackages

• sqlcompyre.report.formatters package
  • Submodules
    • sqlcompyre.report.formatters.terminal module
      • TerminalFormatter
    • sqlcompyre.report.formatters.text module
      • TextFormatter
  • Module contents
    • Formatter
      • Formatter.file_extension
      • Formatter.format()
    • TerminalFormatter
      • TerminalFormatter.file_extension
      • TerminalFormatter.format()
    • TextFormatter
    • get_formatter()
• sqlcompyre.report.schema package
  • Submodules
    • sqlcompyre.report.schema.schema module
      • Metadata
      • Section
  • Module contents
    • Metadata
      • Metadata.description
      • Metadata.object_1
      • Metadata.object_2
      • Metadata.object_type
    • Section
      • Section.content
      • Section.name
• sqlcompyre.report.writers package
  • Submodules
    • sqlcompyre.report.writers.file module
      • FileWriter
    • sqlcompyre.report.writers.markdown module
      • MarkdownWriter
    • sqlcompyre.report.writers.stdout module
      • StdoutWriter
  • Module contents
    • FileWriter
      • FileWriter.write()
    • MarkdownWriter
      • MarkdownWriter.write()
    • StdoutWriter
      • StdoutWriter.write()
    • Writer
      • Writer.write()
    • get_writer()

Submodules

• sqlcompyre.report.report module
  • Report
    • Report.format()

Module contents

class sqlcompyre.report.Report(object_type: Literal['tables', 'schemas'], object_1: str, object_2: str, description: str | None, sections: dict[str, Any])

Bases: object

Summary of the comparison of two SQL database objects.

Methods

format(formatter[, hide_matching_columns])

Format this report with the provided formatter.

format(formatter: Formatter, hide_matching_columns: bool = False) → str

Format this report with the provided formatter.

Args:

formatter: The formatter to use for converting this report into a string. hide_matching_columns: Whether to hide columns where the values are the same.

Returns:

The report, formatted with the provided formatter.