have a `comment` argument wherever an object is created
#354 opened on Oct 12, 2022
Repository metrics
- Stars
- (142 stars)
- PR merge metrics
- (PR metrics pending)
Description
From a user perspective I think it would be more convenient to have a comment argument wherever an object is created. To only change a comment, they need to be idempotent. At a quick glance, the argument would suit 11 modules:
- postgresql_db: #646
- postgresql_ext: #652
- postgresql_idx
-
postgresql_lang(deprecated) - postgresql_publication: #654
- postgresql_schema: #650
- postgresql_sequence
- postgresql_subscription: #655
- postgresql_table
- postgresql_tablespace: #651
- postgresql_user: #649 (already had the feature, uses the shared function now)
- add the
commentargument value tocheck_input(...), check across all the modules - check reset functionality in all the modules except publication for consistency
- add check_mode + mogrify to set_comment, fix tests across all the modules where it makes sense
I'd say the benefit of a comment argument or postgresql_comment module over postgresql_query is that we can validate the kind of object which is commented, to avoid SQL injections. As this is part of the query syntax, not a variable, we cannot rely on psycopg2/3 variable escaping.
Originally posted by @betanummeric in https://github.com/ansible-collections/community.postgresql/discussions/352#discussioncomment-3834647