Function render_note

pydbml/renderer/sql/default/note.py:29–43

For Tables and Columns Note is converted into COMMENT ON clause. All other entities don't have notes generated in their SQL code, but as a fallback their notes are rendered as SQL comments when sql property is called directly.

(model: Note)

@DefaultSQLRenderer.renderer_for(Note)
def render_note(model: Note) -> str:
    """
    For Tables and Columns Note is converted into COMMENT ON clause. All other entities don't
    have notes generated in their SQL code, but as a fallback their notes are rendered as SQL
    comments when sql property is called directly.
    """

    if model.text:
        if isinstance(model.parent, (Table, Column)):
            return generate_comment_on(model, model.parent.__class__.__name__, model.parent.name)
        else:
            text = prepare_text_for_sql(model)
            return '\n'.join(f'-- {line}' for line in text.split('\n'))
    else:
        return ''