From fb1b5ae4ef2d1626037331f6e879f1cf0237a158 Mon Sep 17 00:00:00 2001
From: Mike Alfare <13974384+mikealfare@users.noreply.github.com>
Date: Wed, 18 Sep 2024 14:42:47 -0400
Subject: [PATCH] Add description to pg catalog flag (#913)

* add a description and docs url for the restrict_direct_pg_catalog_access behavior flag
---
 dbt/adapters/redshift/impl.py | 14 +++++++++++++-
 1 file changed, 13 insertions(+), 1 deletion(-)

diff --git a/dbt/adapters/redshift/impl.py b/dbt/adapters/redshift/impl.py
index da86ab7c..dd80a7f4 100644
--- a/dbt/adapters/redshift/impl.py
+++ b/dbt/adapters/redshift/impl.py
@@ -70,7 +70,19 @@ class RedshiftAdapter(SQLAdapter):
 
     @property
     def _behavior_flags(self) -> List[BehaviorFlag]:
-        return [{"name": "restrict_direct_pg_catalog_access", "default": False}]
+        return [
+            {
+                "name": "restrict_direct_pg_catalog_access",
+                "default": False,
+                "description": (
+                    "The dbt-redshift adapter is migrating from using pg_ tables "
+                    "to using Redshift Metadata API and information_schema tables "
+                    "in order to support additional Redshift functionalities.\n"
+                    "We do not expect this to impact your dbt experience."
+                ),
+                "docs_url": "https://docs.getdbt.com/reference/global-configs/behavior-changes#redshift-restrict_direct_pg_catalog_access",
+            }
+        ]
 
     @classmethod
     def date_function(cls):