BigQuery: show column description(comment) on Schema Browser (#7538)

* BigQuery: add column description to Schema Browser

* fix restyled prettier error

* Remove column-description

Author: yoshiokatsuneo

client/app/components/queries/SchemaBrowser.jsx

@@ -59,8 +59,9 @@ function SchemaItem({ item, expanded, onToggle, onSelect, ...props }) {
           mouseEnterDelay={0}
           mouseLeaveDelay={0}
           placement="topRight"
-          arrowPointAtCenter>
-          <PlainButton className="copy-to-editor" onClick={e => handleSelect(e, item.name)}>
+          arrowPointAtCenter
+        >
+          <PlainButton className="copy-to-editor" onClick={(e) => handleSelect(e, item.name)}>
             <i className="fa fa-angle-double-right" aria-hidden="true" />
           </PlainButton>
         </Tooltip>
@@ -70,16 +71,22 @@ function SchemaItem({ item, expanded, onToggle, onSelect, ...props }) {
           {item.loading ? (
             <div className="table-open">Loading...</div>
           ) : (
-            map(item.columns, column => {
+            map(item.columns, (column) => {
               const columnName = get(column, "name");
               const columnType = get(column, "type");
+              const columnDescription = get(column, "description");
               return (
                 <Tooltip
-                  title="Insert column name into query text"
+                  title={"Insert column name into query text" + (columnDescription ? "\n" + columnDescription : "")}
                   mouseEnterDelay={0}
                   mouseLeaveDelay={0}
-                  placement="rightTop">
-                  <PlainButton key={columnName} className="table-open-item" onClick={e => handleSelect(e, columnName)}>
+                  placement="rightTop"
+                >
+                  <PlainButton
+                    key={columnName}
+                    className="table-open-item"
+                    onClick={(e) => handleSelect(e, columnName)}
+                  >
                     <div>
                       {columnName} {columnType && <span className="column-type">{columnType}</span>}
                     </div>
@@ -168,7 +175,7 @@ export function SchemaList({ loading, schema, expandedFlags, onTableExpand, onIt
 }
 
 export function applyFilterOnSchema(schema, filterString) {
-  const filters = filter(filterString.toLowerCase().split(/\s+/), s => s.length > 0);
+  const filters = filter(filterString.toLowerCase().split(/\s+/), (s) => s.length > 0);
 
   // Empty string: return original schema
   if (filters.length === 0) {
@@ -181,21 +188,21 @@ export function applyFilterOnSchema(schema, filterString) {
     const columnFilter = filters[0];
     return filter(
       schema,
-      item =>
+      (item) =>
         includes(item.name.toLowerCase(), nameFilter) ||
-        some(item.columns, column => includes(get(column, "name").toLowerCase(), columnFilter))
+        some(item.columns, (column) => includes(get(column, "name").toLowerCase(), columnFilter))
     );
   }
 
   // Two (or more) words: first matches table, seconds matches column
   const nameFilter = filters[0];
   const columnFilter = filters[1];
   return filter(
-    map(schema, item => {
+    map(schema, (item) => {
       if (includes(item.name.toLowerCase(), nameFilter)) {
         item = {
           ...item,
-          columns: filter(item.columns, column => includes(get(column, "name").toLowerCase(), columnFilter)),
+          columns: filter(item.columns, (column) => includes(get(column, "name").toLowerCase(), columnFilter)),
         };
         return item.columns.length > 0 ? item : null;
       }
@@ -243,7 +250,7 @@ export default function SchemaBrowser({
           placeholder="Search schema..."
           aria-label="Search schema"
           disabled={schema.length === 0}
-          onChange={event => handleFilterChange(event.target.value)}
+          onChange={(event) => handleFilterChange(event.target.value)}
         />
 
         <Tooltip title="Refresh Schema">

redash/query_runner/big_query.py

@@ -304,7 +304,7 @@ def get_schema(self, get_stats=False):
         datasets = self._get_project_datasets(project_id)
 
         query_base = """
-        SELECT table_schema, table_name, field_path, data_type
+        SELECT table_schema, table_name, field_path, data_type, description
         FROM `{dataset_id}`.INFORMATION_SCHEMA.COLUMN_FIELD_PATHS
         WHERE table_schema NOT IN ('information_schema')
         """
@@ -329,7 +329,13 @@ def get_schema(self, get_stats=False):
             table_name = "{0}.{1}".format(row["table_schema"], row["table_name"])
             if table_name not in schema:
                 schema[table_name] = {"name": table_name, "columns": []}
-            schema[table_name]["columns"].append({"name": row["field_path"], "type": row["data_type"]})
+            schema[table_name]["columns"].append(
+                {
+                    "name": row["field_path"],
+                    "type": row["data_type"],
+                    "description": row["description"],
+                }
+            )
 
         return list(schema.values())