cloud-sql-python-connector 1.18.5__py3-none-any.whl → 1.20.0__py3-none-any.whl

{cloud_sql_python_connector-1.18.5.dist-info → cloud_sql_python_connector-1.20.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cloud-sql-python-connector
-Version: 1.18.5
+Version: 1.20.0
 Summary: Google Cloud SQL Python Connector library
 Author-email: Google LLC <googleapis-packages@google.com>
 License-Expression: Apache-2.0
@@ -387,14 +387,27 @@ conn = connector.connect(
 )
 ```
 
-### Using DNS domain names to identify instances
+### Using Advanced Disaster Recovery and DNS domain names to identify instances
 
-The connector can be configured to use DNS to look up an instance. This would
-allow you to configure your application to connect to a database instance, and
-centrally configure which instance in your DNS zone.
+The connector can be configured to use DNS to look up an instance. 
+Use a DNS name managed by Cloud SQL [Advanced Disaster Recovery](https://docs.cloud.google.com/sql/docs/mysql/use-advanced-disaster-recovery), 
+or a domain name that you manage.
+
+#### Using Advanced Recovery Write Endpoint DNS Name
+
+[Advanced Disaster Recovery](https://docs.cloud.google.com/sql/docs/mysql/use-advanced-disaster-recovery)
+creates geographically distributed replicas of your Cloud SQL database instance. When you perform 
+switchover or failover on the database instance, the connector will gracefully disconnect from the
+old primary instance and reconnect to the new primary instance. 
+
+Follow the instructions in [Connect using Write Endpoint](https://docs.cloud.google.com/sql/docs/mysql/connect-to-instance-using-write-endpoint)
+to get the write endpoint DNS name for your primary instance. Then, use this write endpoint DNS
+name to configure the connector.
 
 #### Configure your DNS Records
 
+The connector may be configured to use DNS that you define as well.
+
 Add a DNS TXT record for the Cloud SQL instance to a **private** DNS server
 or a private Google Cloud DNS Zone used by your application.
 

{cloud_sql_python_connector-1.18.5.dist-info → cloud_sql_python_connector-1.20.0.dist-info}/RECORD

@@ -1,12 +1,12 @@
-cloud_sql_python_connector-1.18.5.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+cloud_sql_python_connector-1.20.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
 google/cloud/sql/connector/__init__.py,sha256=w6w35V-m2QlpcL-ShKd2BvNF-xXOwJ2FoidE7npPE7c,1148
 google/cloud/sql/connector/asyncpg.py,sha256=v4ohOnSYjHTOvJPhTE761xP1KKo4FUJQW_WAnNW_2g4,1918
 google/cloud/sql/connector/client.py,sha256=uVOMnRe1AxiSh6BnK4-SuSYrRID_jnm7SgMMN6s5jp4,13076
 google/cloud/sql/connector/connection_info.py,sha256=BSuW-ovtEUYTIvDzQkaE3GofCs3Xoi0TtztFaAq4Kvo,4868
 google/cloud/sql/connector/connection_name.py,sha256=bI4M3Qa2mtBHyD08oF41FF5W9FBOXWu4dGGg50Na_A4,2606
-google/cloud/sql/connector/connector.py,sha256=MJFRKBhwpWtwUo7EvwFggu2X5s2d5CgQdm8ZFZtnYV4,24720
+google/cloud/sql/connector/connector.py,sha256=MqL4iX9xK0Vys59L0VQpxf4VY39UUyYeL7I3rnFYSdY,26792
 google/cloud/sql/connector/enums.py,sha256=dVBS9eEWNrHtzze0AJlmtbdUogG3EocNWOQcI_8qPd0,2937
-google/cloud/sql/connector/exceptions.py,sha256=QdQBzZ3t1RE5V744wW4sGaucWD2cEedB-dWNCkh8SAA,1974
+google/cloud/sql/connector/exceptions.py,sha256=BtuE5bkMLxNPYZo2SrFlRBHp3ueWKZ0otnPbfnvr2TM,2125
 google/cloud/sql/connector/instance.py,sha256=jDEQf-OXFzqKO9a4bnzRQ0qUyO3_xKuiEIRWc_7wpyE,8694
 google/cloud/sql/connector/lazy.py,sha256=oB6F-O2fk8ZguY4J7Vrts91bqbVb6P5wj72Lf6UJIQA,4948
 google/cloud/sql/connector/monitored_cache.py,sha256=LFYjX8hsdN_Dt0cMwLSWgAhWWQpZ35qA0CLlpc6xhsE,5587
@@ -16,10 +16,10 @@ google/cloud/sql/connector/pymysql.py,sha256=PrTQ1lB5EWAcN4BPX_5hb-WerncS4X76bBk
 google/cloud/sql/connector/pytds.py,sha256=KZxmJQQG9XfmsmUoEGX7RpMirWdoreJ2-_FuHO6Td-s,2280
 google/cloud/sql/connector/rate_limiter.py,sha256=zqZ9pVXHan4LWoGT8Bq6U3HpZcrdzKhlXVYwsX3ftA0,2928
 google/cloud/sql/connector/refresh_utils.py,sha256=jaYLHrKlJtqeZBM8gOrZtI-6mbh6-1PTi8o0aFGH5Yo,5151
-google/cloud/sql/connector/resolver.py,sha256=DUU7swlBjMJjlDqa_M4XtIctPiJBnz-OusFUk5GLc1Y,3290
+google/cloud/sql/connector/resolver.py,sha256=pKcdPCr0iwFwKf2cv0F3HtCyOWNas1JsrnRMOudnEr8,3714
 google/cloud/sql/connector/utils.py,sha256=AA_oBBxRuULb7-hHHK8HQJU5fttzBpzdIZwMNZ5kNCM,3473
-google/cloud/sql/connector/version.py,sha256=vwp3p66TKsR4A9ppzaDyHkjlKvBcN9c_VyZhZCyr-J8,598
-cloud_sql_python_connector-1.18.5.dist-info/METADATA,sha256=Ti5LNCHd2qgqvXGIuMItV8KGjme1tEoXW5JFhtBEre0,30346
-cloud_sql_python_connector-1.18.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-cloud_sql_python_connector-1.18.5.dist-info/top_level.txt,sha256=_1QvSJIhFAGfxb79D6DhB7SUw2X6T4rwnz_LLrbcD3c,7
-cloud_sql_python_connector-1.18.5.dist-info/RECORD,,
+google/cloud/sql/connector/version.py,sha256=2L1KkIvUJEP5w-XgkCMs-yRM0AiHFvPXOIdjsF6d1hs,598
+cloud_sql_python_connector-1.20.0.dist-info/METADATA,sha256=tjuCIYWzWY8fVvVw_VPfQA8p6N_eZTCmRYxa542zuj8,31181
+cloud_sql_python_connector-1.20.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+cloud_sql_python_connector-1.20.0.dist-info/top_level.txt,sha256=_1QvSJIhFAGfxb79D6DhB7SUw2X6T4rwnz_LLrbcD3c,7
+cloud_sql_python_connector-1.20.0.dist-info/RECORD,,

google/cloud/sql/connector/connector.py

@@ -34,6 +34,7 @@ from google.cloud.sql.connector.client import CloudSQLClient
 from google.cloud.sql.connector.enums import DriverMapping
 from google.cloud.sql.connector.enums import IPTypes
 from google.cloud.sql.connector.enums import RefreshStrategy
+from google.cloud.sql.connector.exceptions import ClosedConnectorError
 from google.cloud.sql.connector.exceptions import ConnectorLoopError
 from google.cloud.sql.connector.instance import RefreshAheadCache
 from google.cloud.sql.connector.lazy import LazyRefreshCache
@@ -155,6 +156,7 @@ class Connector:
         # connection name string and enable_iam_auth boolean flag
         self._cache: dict[tuple[str, bool], MonitoredCache] = {}
         self._client: Optional[CloudSQLClient] = None
+        self._closed: bool = False
 
         # initialize credentials
         scopes = ["https://www.googleapis.com/auth/sqlservice.admin"]
@@ -244,6 +246,12 @@ class Connector:
         # connect runs sync database connections on background thread.
         # Async database connections should call 'connect_async' directly to
         # avoid hanging indefinitely.
+
+        # Check if the connector is closed before attempting to connect.
+        if self._closed:
+            raise ClosedConnectorError(
+                "Connection attempt failed because the connector has already been closed."
+            )
         connect_future = asyncio.run_coroutine_threadsafe(
             self.connect_async(instance_connection_string, driver, **kwargs),
             self._loop,
@@ -281,7 +289,13 @@ class Connector:
                 and then subsequent attempt with IAM database authentication.
             KeyError: Unsupported database driver Must be one of pymysql, asyncpg,
                 pg8000, and pytds.
+            RuntimeError: Connector has been closed. Cannot connect using a closed
+                Connector.
         """
+        if self._closed:
+            raise ClosedConnectorError(
+                "Connection attempt failed because the connector has already been closed."
+            )
         # check if event loop is running in current thread
         if self._loop != asyncio.get_running_loop():
             raise ConnectorLoopError(
@@ -376,6 +390,33 @@ class Connector:
             # the cache and re-raise the error
             await self._remove_cached(str(conn_name), enable_iam_auth)
             raise
+
+        # If the connector is configured with a custom DNS name, attempt to use
+        # that DNS name to connect to the instance. Fall back to the metadata IP
+        # address if the DNS name does not resolve to an IP address.
+        if conn_info.conn_name.domain_name and isinstance(self._resolver, DnsResolver):
+            try:
+                ips = await self._resolver.resolve_a_record(conn_info.conn_name.domain_name)
+                if ips:
+                    ip_address = ips[0]
+                    logger.debug(
+                        f"['{instance_connection_string}']: Custom DNS name "
+                        f"'{conn_info.conn_name.domain_name}' resolved to '{ip_address}', "
+                        "using it to connect"
+                    )
+                else:
+                    logger.debug(
+                        f"['{instance_connection_string}']: Custom DNS name "
+                        f"'{conn_info.conn_name.domain_name}' resolved but returned no "
+                        f"entries, using '{ip_address}' from instance metadata"
+                    )
+            except Exception as e:
+                logger.debug(
+                    f"['{instance_connection_string}']: Custom DNS name "
+                    f"'{conn_info.conn_name.domain_name}' did not resolve to an IP "
+                    f"address: {e}, using '{ip_address}' from instance metadata"
+                )
+
         logger.debug(f"['{conn_info.conn_name}']: Connecting to {ip_address}:3307")
         # format `user` param for automatic IAM database authn
         if enable_iam_auth:
@@ -477,9 +518,10 @@ class Connector:
     async def close_async(self) -> None:
         """Helper function to cancel the cache's tasks
         and close aiohttp.ClientSession."""
-        await asyncio.gather(*[cache.close() for cache in self._cache.values()])
+        self._closed = True
         if self._client:
             await self._client.close()
+        await asyncio.gather(*[cache.close() for cache in self._cache.values()])
 
 
 async def create_async_connector(

google/cloud/sql/connector/exceptions.py

@@ -84,3 +84,10 @@ class CacheClosedError(Exception):
     Exception to be raised when a ConnectionInfoCache can not be accessed after
     it is closed.
     """
+
+
+class ClosedConnectorError(Exception):
+    """
+    Exception to be raised when a Connector is closed and connect method is
+    called on it.
+    """

google/cloud/sql/connector/resolver.py

@@ -12,6 +12,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from typing import List
+
 import dns.asyncresolver
 
 from google.cloud.sql.connector.connection_name import _is_valid_domain
@@ -53,6 +55,16 @@ class DnsResolver(dns.asyncresolver.Resolver):
                 )
         return conn_name
 
+    async def resolve_a_record(self, dns: str) -> List[str]:
+        try:
+            # Attempt to query the A records.
+            records = await super().resolve(dns, "A", raise_on_no_answer=True)
+            # return IP addresses as strings
+            return [record.to_text() for record in records]
+        except Exception:
+            # On any error, return empty list
+            return []
+
     async def query_dns(self, dns: str) -> ConnectionName:
         try:
             # Attempt to query the TXT records.

google/cloud/sql/connector/version.py

@@ -12,4 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = "1.18.5"
+__version__ = "1.20.0"