| # Licensed to the Apache Software Foundation (ASF) under one |
| # or more contributor license agreements. See the NOTICE file |
| # distributed with this work for additional information |
| # regarding copyright ownership. The ASF licenses this file |
| # to you under the Apache License, Version 2.0 (the |
| # "License"); you may not use this file except in compliance |
| # with the License. You may obtain a copy of the License at |
| # |
| # http://www.apache.org/licenses/LICENSE-2.0 |
| # |
| # Unless required by applicable law or agreed to in writing, |
| # software distributed under the License is distributed on an |
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| # KIND, either express or implied. See the License for the |
| # specific language governing permissions and limitations |
| # under the License. |
| import inspect |
| |
| from flask import Markup |
| from flask_babel import lazy_gettext as _ |
| from sqlalchemy import MetaData |
| |
| from superset import app, security_manager |
| from superset.databases.filters import DatabaseFilter |
| from superset.exceptions import SupersetException |
| from superset.models.core import Database |
| from superset.security.analytics_db_safety import check_sqlalchemy_uri |
| from superset.utils import core as utils |
| |
| |
| class DatabaseMixin: |
| list_title = _("Databases") |
| show_title = _("Show Database") |
| add_title = _("Add Database") |
| edit_title = _("Edit Database") |
| |
| list_columns = [ |
| "database_name", |
| "backend", |
| "expose_in_sqllab", |
| "allow_run_async", |
| "creator", |
| "modified", |
| ] |
| order_columns = [ |
| "database_name", |
| "allow_run_async", |
| "allow_dml", |
| "modified", |
| "allow_csv_upload", |
| "expose_in_sqllab", |
| ] |
| add_columns = [ |
| "database_name", |
| "sqlalchemy_uri", |
| "cache_timeout", |
| "expose_in_sqllab", |
| "allow_run_async", |
| "allow_csv_upload", |
| "allow_ctas", |
| "allow_cvas", |
| "allow_dml", |
| "force_ctas_schema", |
| "impersonate_user", |
| "allow_multi_schema_metadata_fetch", |
| "extra", |
| "encrypted_extra", |
| "server_cert", |
| ] |
| search_exclude_columns = ( |
| "password", |
| "tables", |
| "created_by", |
| "changed_by", |
| "queries", |
| "saved_queries", |
| "encrypted_extra", |
| "server_cert", |
| ) |
| edit_columns = add_columns |
| show_columns = [ |
| "tables", |
| "cache_timeout", |
| "extra", |
| "database_name", |
| "sqlalchemy_uri", |
| "perm", |
| "created_by", |
| "created_on", |
| "changed_by", |
| "changed_on", |
| ] |
| base_order = ("changed_on", "desc") |
| description_columns = { |
| "sqlalchemy_uri": utils.markdown( |
| "Refer to the " |
| "[SqlAlchemy docs]" |
| "(https://docs.sqlalchemy.org/en/rel_1_2/core/engines.html#" |
| "database-urls) " |
| "for more information on how to structure your URI.", |
| True, |
| ), |
| "expose_in_sqllab": _("Expose this DB in SQL Lab"), |
| "allow_run_async": _( |
| "Operate the database in asynchronous mode, meaning " |
| "that the queries are executed on remote workers as opposed " |
| "to on the web server itself. " |
| "This assumes that you have a Celery worker setup as well " |
| "as a results backend. Refer to the installation docs " |
| "for more information." |
| ), |
| "allow_ctas": _("Allow CREATE TABLE AS option in SQL Lab"), |
| "allow_cvas": _("Allow CREATE VIEW AS option in SQL Lab"), |
| "allow_dml": _( |
| "Allow users to run non-SELECT statements " |
| "(UPDATE, DELETE, CREATE, ...) " |
| "in SQL Lab" |
| ), |
| "force_ctas_schema": _( |
| "When allowing CREATE TABLE AS option in SQL Lab, " |
| "this option forces the table to be created in this schema" |
| ), |
| "extra": utils.markdown( |
| "JSON string containing extra configuration elements.<br/>" |
| "1. The ``engine_params`` object gets unpacked into the " |
| "[sqlalchemy.create_engine]" |
| "(https://docs.sqlalchemy.org/en/latest/core/engines.html#" |
| "sqlalchemy.create_engine) call, while the ``metadata_params`` " |
| "gets unpacked into the [sqlalchemy.MetaData]" |
| "(https://docs.sqlalchemy.org/en/rel_1_0/core/metadata.html" |
| "#sqlalchemy.schema.MetaData) call.<br/>" |
| "2. The ``metadata_cache_timeout`` is a cache timeout setting " |
| "in seconds for metadata fetch of this database. Specify it as " |
| '**"metadata_cache_timeout": {"schema_cache_timeout": 600, ' |
| '"table_cache_timeout": 600}**. ' |
| "If unset, cache will not be enabled for the functionality. " |
| "A timeout of 0 indicates that the cache never expires.<br/>" |
| "3. The ``schemas_allowed_for_csv_upload`` is a comma separated list " |
| "of schemas that CSVs are allowed to upload to. " |
| 'Specify it as **"schemas_allowed_for_csv_upload": ' |
| '["public", "csv_upload"]**. ' |
| "If database flavor does not support schema or any schema is allowed " |
| "to be accessed, just leave the list empty<br/>" |
| "4. the ``version`` field is a string specifying the this db's version. " |
| "This should be used with Presto DBs so that the syntax is correct<br/>" |
| "5. The ``allows_virtual_table_explore`` field is a boolean specifying " |
| "whether or not the Explore button in SQL Lab results is shown.", |
| True, |
| ), |
| "encrypted_extra": utils.markdown( |
| "JSON string containing additional connection configuration.<br/>" |
| "This is used to provide connection information for systems like " |
| "Hive, Presto, and BigQuery, which do not conform to the username:password " |
| "syntax normally used by SQLAlchemy.", |
| True, |
| ), |
| "server_cert": utils.markdown( |
| "Optional CA_BUNDLE contents to validate HTTPS requests. Only available " |
| "on certain database engines.", |
| True, |
| ), |
| "impersonate_user": _( |
| "If Presto, all the queries in SQL Lab are going to be executed as the " |
| "currently logged on user who must have permission to run them.<br/>" |
| "If Hive and hive.server2.enable.doAs is enabled, will run the queries as " |
| "service account, but impersonate the currently logged on user " |
| "via hive.server2.proxy.user property." |
| ), |
| "allow_multi_schema_metadata_fetch": _( |
| "Allow SQL Lab to fetch a list of all tables and all views across " |
| "all database schemas. For large data warehouse with thousands of " |
| "tables, this can be expensive and put strain on the system." |
| ), |
| "cache_timeout": _( |
| "Duration (in seconds) of the caching timeout for charts of this database. " |
| "A timeout of 0 indicates that the cache never expires. " |
| "Note this defaults to the global timeout if undefined." |
| ), |
| "allow_csv_upload": _( |
| "If selected, please set the schemas allowed for csv upload in Extra." |
| ), |
| } |
| base_filters = [["id", DatabaseFilter, lambda: []]] |
| label_columns = { |
| "expose_in_sqllab": _("Expose in SQL Lab"), |
| "allow_ctas": _("Allow CREATE TABLE AS"), |
| "allow_cvas": _("Allow CREATE VIEW AS"), |
| "allow_dml": _("Allow DML"), |
| "force_ctas_schema": _("CTAS Schema"), |
| "database_name": _("Database"), |
| "creator": _("Creator"), |
| "changed_on_": _("Last Changed"), |
| "sqlalchemy_uri": _("SQLAlchemy URI"), |
| "cache_timeout": _("Chart Cache Timeout"), |
| "extra": _("Extra"), |
| "encrypted_extra": _("Secure Extra"), |
| "server_cert": _("Root certificate"), |
| "allow_run_async": _("Async Execution"), |
| "impersonate_user": _("Impersonate the logged on user"), |
| "allow_csv_upload": _("Allow Csv Upload"), |
| "modified": _("Modified"), |
| "allow_multi_schema_metadata_fetch": _("Allow Multi Schema Metadata Fetch"), |
| "backend": _("Backend"), |
| } |
| |
| def _pre_add_update(self, database: Database) -> None: |
| if app.config["PREVENT_UNSAFE_DB_CONNECTIONS"]: |
| check_sqlalchemy_uri(database.sqlalchemy_uri) |
| self.check_extra(database) |
| self.check_encrypted_extra(database) |
| if database.server_cert: |
| utils.parse_ssl_cert(database.server_cert) |
| database.set_sqlalchemy_uri(database.sqlalchemy_uri) |
| security_manager.add_permission_view_menu("database_access", database.perm) |
| # adding a new database we always want to force refresh schema list |
| for schema in database.get_all_schema_names(): |
| security_manager.add_permission_view_menu( |
| "schema_access", security_manager.get_schema_perm(database, schema) |
| ) |
| |
| def pre_add(self, database: Database) -> None: |
| self._pre_add_update(database) |
| |
| def pre_update(self, database: Database) -> None: |
| self._pre_add_update(database) |
| |
| def pre_delete(self, database: Database) -> None: # pylint: disable=no-self-use |
| if database.tables: |
| raise SupersetException( |
| Markup( |
| "Cannot delete a database that has tables attached. " |
| "Here's the list of associated tables: " |
| + ", ".join("{}".format(table) for table in database.tables) |
| ) |
| ) |
| |
| def check_extra(self, database: Database) -> None: # pylint: disable=no-self-use |
| # this will check whether json.loads(extra) can succeed |
| try: |
| extra = database.get_extra() |
| except Exception as ex: |
| raise Exception( |
| _("Extra field cannot be decoded by JSON. %(msg)s", msg=str(ex)) |
| ) |
| |
| # this will check whether 'metadata_params' is configured correctly |
| metadata_signature = inspect.signature(MetaData) |
| for key in extra.get("metadata_params", {}): |
| if key not in metadata_signature.parameters: |
| raise Exception( |
| _( |
| "The metadata_params in Extra field " |
| "is not configured correctly. The key " |
| "%{key}s is invalid.", |
| key=key, |
| ) |
| ) |
| |
| def check_encrypted_extra( # pylint: disable=no-self-use |
| self, database: Database |
| ) -> None: |
| # this will check whether json.loads(secure_extra) can succeed |
| try: |
| database.get_encrypted_extra() |
| except Exception as ex: |
| raise Exception( |
| _("Extra field cannot be decoded by JSON. %(msg)s", msg=str(ex)) |
| ) |
