When column config says quote, use quotes in SQL to add comments

CHANGELOG.md

@@ -5,6 +5,7 @@
 - Added 3 more adapter methods that the new dbt-adapter-test suite can use for testing. ([#2492](https://github.com/fishtown-analytics/dbt/issues/2492), [#2721](https://github.com/fishtown-analytics/dbt/pull/2721))
 - It is now an error to attempt installing `dbt` with a Python version less than 3.6. (resolves [#2347](https://github.com/fishtown-analytics/dbt/issues/2347))
 - Check for Postgres relation names longer than 63 and throw exception. ([#2197](https://github.com/fishtown-analytics/dbt/issues/2197))
+- If column config says quote, use quoting in SQL for adding a comment. ([#2539](https://github.com/fishtown-analytics/dbt/issues/2539))
 
 
 ### Fixes

core/dbt/contracts/graph/parsed.py

@@ -57,6 +57,7 @@ class ColumnInfo(
  description: str = ''
  meta: Dict[str, Any] = field(default_factory=dict)
  data_type: Optional[str] = None
+ quote: Optional[bool] = None
  tags: List[str] = field(default_factory=list)
  _extra: Dict[str, Any] = field(default_factory=dict)
 

core/dbt/parser/schemas.py

@@ -95,12 +95,18 @@ def add(
  ):
  tags: List[str] = []
  tags.extend(getattr(column, 'tags', ()))
+ quote: Optional[bool]
+ if isinstance(column, UnparsedColumn):
+ quote = column.quote
+ else:
+ quote = None
  self.column_info[column.name] = ColumnInfo(
  name=column.name,
  description=description,
  data_type=data_type,
  meta=meta,
  tags=tags,
+ quote=quote,
  _extra=column.extra
  )
 

plugins/postgres/dbt/include/postgres/macros/adapters.sql

@@ -155,6 +155,6 @@
  {% for column_name in column_dict %}
  {% set comment = column_dict[column_name]['description'] %}
  {% set escaped_comment = postgres_escape_comment(comment) %}
- comment on column {{ relation }}.{{ column_name }} is {{ escaped_comment }};
+ comment on column {{ relation }}.{{ adapter.quote(column_name) if column_dict[column_name]['quote'] == True else column_name }} is {{ escaped_comment }};
  {% endfor %}
 {% endmacro %}

test/integration/035_docs_blocks/test_docs_blocks.py

@@ -38,6 +38,7 @@ def test_postgres_valid_doc_ref(self):
  'description': 'The user ID number',
  'data_type': None,
  'meta': {},
+ 'quote': None,
  'tags': [],
  },
  model_data['columns']['id']
@@ -48,6 +49,7 @@ def test_postgres_valid_doc_ref(self):
  'description': "The user's first name",
  'data_type': None,
  'meta': {},
+ 'quote': None,
  'tags': [],
  },
  model_data['columns']['first_name']
@@ -59,6 +61,7 @@ def test_postgres_valid_doc_ref(self):
  'description': "The user's last name",
  'data_type': None,
  'meta': {},
+ 'quote': None,
  'tags': [],
  },
  model_data['columns']['last_name']
@@ -86,6 +89,7 @@ def test_postgres_alternative_docs_path(self):
  'description': 'The user ID number with alternative text',
  'data_type': None,
  'meta': {},
+ 'quote': None,
  'tags': [],
  },
  model_data['columns']['id']
@@ -96,6 +100,7 @@ def test_postgres_alternative_docs_path(self):
  'description': "The user's first name",
  'data_type': None,
  'meta': {},
+ 'quote': None,
  'tags': [],
  },
  model_data['columns']['first_name']
@@ -107,6 +112,7 @@ def test_postgres_alternative_docs_path(self):
  'description': "The user's last name in this other file",
  'data_type': None,
  'meta': {},
+ 'quote': None,
  'tags': [],
  },
  model_data['columns']['last_name']

test/integration/060_persist_docs_tests/models/quote_model.sql

@@ -0,0 +1 @@
+select 1 as "2id"

test/integration/060_persist_docs_tests/models/schema.yml

@@ -43,6 +43,12 @@ models:
  --
  /* comment */
  Some $lbl$ labeled $lbl$ and $$ unlabeled $$ dollar-quoting
+ - name: quote_model
+ description: "model to test column quotes and comments" 
+ columns:
+ - name: 2id
+ description: "My description"
+ quote: true
 
 seeds:
  - name: seed

test/integration/060_persist_docs_tests/test_persist_docs.py

@@ -81,7 +81,7 @@ def run_has_comments_pglike(self):
  with open('target/catalog.json') as fp:
  catalog_data = json.load(fp)
  assert 'nodes' in catalog_data
- assert len(catalog_data['nodes']) == 3
+ assert len(catalog_data['nodes']) == 4
  table_node = catalog_data['nodes']['model.test.table_model']
  view_node = self._assert_has_table_comments(table_node)
 
@@ -125,7 +125,7 @@ def test_redshift_late_binding_view(self):
  with open('target/catalog.json') as fp:
  catalog_data = json.load(fp)
  assert 'nodes' in catalog_data
- assert len(catalog_data['nodes']) == 3
+ assert len(catalog_data['nodes']) == 4
  table_node = catalog_data['nodes']['model.test.table_model']
  view_node = self._assert_has_table_comments(table_node)