Rename metadata arg as http_header

Change `metadata` arg to `http_header`

Existing unit tests

Author: NiallEgan

cmdexec/clients/python/src/databricks/sql/HISTORY

@@ -2,6 +2,7 @@ v2.0.0 - April 19, 2022
 - Initial stable release of V2
 - Added better support for complex types, so that in Databricks runtime 10.3+, Arrays, Maps and Structs will get 
   deserialized as lists, lists of tuples and dicts, respectively.
+- Changed the name of the metadata arg to http_headers
 
 v2.0.b2 - April 4, 2022
 - Change import of collections.Iterable to collections.abc.Iterable to make the library compatible with Python 3.10

cmdexec/clients/python/src/databricks/sql/client.py

@@ -25,7 +25,7 @@ def __init__(self,
                  server_hostname: str,
                  http_path: str,
                  access_token: str,
-                 metadata: Optional[List[Tuple[str, str]]] = None,
+                 http_headers: Optional[List[Tuple[str, str]]] = None,
                  session_configuration: Dict[str, Any] = None,
                  catalog: Optional[str] = None,
                  schema: Optional[str] = None,
@@ -37,7 +37,7 @@ def __init__(self,
         :param http_path: Http path either to a DBSQL endpoint (e.g. /sql/1.0/endpoints/1234567890abcdef)
               or to a DBR interactive cluster (e.g. /sql/protocolv1/o/1234567890123456/1234-123456-slid123)
         :param access_token: Http Bearer access token, e.g. Databricks Personal Access Token.
-        :param metadata: An optional list of (k, v) pairs that will be set as Http headers on every request
+        :param http_headers: An optional list of (k, v) pairs that will be set as Http headers on every request
         :param session_configuration: An optional dictionary of Spark session parameters. Defaults to None. 
                Execute the SQL command `SET -v` to get a full list of available commands.
         :param catalog: An optional initial catalog to use. Requires DBR version 9.0+
@@ -105,7 +105,7 @@ def __init__(self,
 
         base_headers = [("User-Agent", useragent_header)] + authorization_header
         self.thrift_backend = ThriftBackend(self.host, self.port, http_path,
-                                            (metadata or []) + base_headers, **kwargs)
+                                            (http_headers or []) + base_headers, **kwargs)
 
         self._session_handle = self.thrift_backend.open_session(session_configuration, catalog,
                                                                 schema)

cmdexec/clients/python/tests/tests.py

@@ -79,12 +79,12 @@ def test_auth_args(self, mock_client_class):
             connection.close()
 
     @patch("%s.client.ThriftBackend" % PACKAGE_NAME)
-    def test_metadata_passthrough(self, mock_client_class):
-        metadata = [("foo", "bar")]
-        databricks.sql.connect(**self.DUMMY_CONNECTION_ARGS, metadata=metadata)
+    def test_http_header_passthrough(self, mock_client_class):
+        http_headers = [("foo", "bar")]
+        databricks.sql.connect(**self.DUMMY_CONNECTION_ARGS, http_headers=http_headers)
 
-        http_headers = mock_client_class.call_args[0][3]
-        self.assertIn(("foo", "bar"), http_headers)
+        call_args = mock_client_class.call_args[0][3]
+        self.assertIn(("foo", "bar"), call_args)
 
     @patch("%s.client.ThriftBackend" % PACKAGE_NAME)
     def test_authtoken_passthrough(self, mock_client_class):