pt
/
superset
mirror of https://github.com/apache/superset.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

chore: add user agent to Databricks requests (#20660)

This commit is contained in:
Beto Dealmeida 2022-07-20 08:17:52 -07:00 committed by GitHub
parent 81bd4968d0
commit 2a4c7cfb2a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 20 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/docs/databases/databricks.mdx
View File

@ -33,13 +33,10 @@ You also need to add the following configuration to "Other" -> "Engine Parameter
```json
{
"connect_args": {"http_path": "sql/protocolv1/o/****"},
"http_headers": [["User-Agent", "Apache Superset"]]
"connect_args": {"http_path": "sql/protocolv1/o/****"}
}
```
The `User-Agent` header is optional, but helps Databricks identify traffic from Superset. If you need to use a different header please reach out to Databricks and let them know.
## Older driver
Originally Superset used `databricks-dbapi` to connect to Databricks. You might want to try it if you're having problems with the official Databricks connector:

2
superset/constants.py
View File

@ -20,6 +20,8 @@
# string to use when None values *need* to be converted to/from strings
from enum import Enum
USER_AGENT = "Apache Superset"
NULL_STRING = "<NULL>"
EMPTY_STRING = "<empty string>"

18
superset/db_engine_specs/databricks.py
View File

@ -16,11 +16,15 @@
# under the License.
from datetime import datetime
from typing import Any, Dict, Optional
from typing import Any, Dict, Optional, TYPE_CHECKING
from superset.constants import USER_AGENT
from superset.db_engine_specs.base import BaseEngineSpec
from superset.db_engine_specs.hive import HiveEngineSpec
if TYPE_CHECKING:
from superset.models.core import Database
time_grain_expressions = {
None: "{col}",
"PT1S": "date_trunc('second', {col})",
@ -71,3 +75,15 @@ class DatabricksNativeEngineSpec(DatabricksODBCEngineSpec):
engine = "databricks"
engine_name = "Databricks Native Connector"
driver = "connector"
@staticmethod
def get_extra_params(database: "Database") -> Dict[str, Any]:
"""
Add a user agent to be used in the requests.
"""
extra = {
"http_headers": [("User-Agent", USER_AGENT)],
"_user_agent_entry": USER_AGENT,
}
extra.update(BaseEngineSpec.get_extra_params(database))
return extra