Validates parameters used to connect to a database
643 matches
100 actions
Superset
100 actions
- delete_annotation_layerDELETEv1.0.0
- delete_annotation_layer_pkDELETEv1.0.0
- delete_annotation_layer_pk_annotationDELETEv1.0.0
- delete_annotation_layer_pk_annotation_annotation_idDELETEv1.0.0
- delete_chartDELETEv1.0.0
- delete_chart_pkDELETEv1.0.0
- delete_css_templateDELETEv1.0.0
- delete_css_template_pkDELETEv1.0.0
- delete_dashboardDELETEv1.0.0
- delete_dashboard_pkDELETEv1.0.0
- delete_database_pkDELETEv1.0.0
- delete_datasetDELETEv1.0.0
- delete_dataset_pkDELETEv1.0.0
- delete_dataset_pk_column_column_idDELETEv1.0.0
- delete_dataset_pk_metric_metric_idDELETEv1.0.0
- delete_reportDELETEv1.0.0
- delete_report_pkDELETEv1.0.0
- delete_saved_queryDELETEv1.0.0
- delete_saved_query_pkDELETEv1.0.0
- get_annotation_layerGETv1.0.0
- get_annotation_layer_infoGETv1.0.0
- get_annotation_layer_pkGETv1.0.0
- get_annotation_layer_pk_annotationGETv1.0.0
- get_annotation_layer_pk_annotation_annotation_idGETv1.0.0
- get_annotation_layer_related_column_nameGETv1.0.0
- get_async_eventGETv1.0.0
- get_chartGETv1.0.0
- get_chart_data_cache_keyGETv1.0.0
- get_chart_favorite_statusGETv1.0.0
- get_chart_infoGETv1.0.0
- get_chart_pkGETv1.0.0
- get_chart_pk_cache_screenshotGETv1.0.0
- get_chart_pk_dataGETv1.0.0
- get_chart_pk_screenshot_digestGETv1.0.0
- get_chart_pk_thumbnail_digestGETv1.0.0
- get_chart_related_column_nameGETv1.0.0
- get_css_templateGETv1.0.0
- get_css_template_infoGETv1.0.0
- get_css_template_pkGETv1.0.0
- get_css_template_related_column_nameGETv1.0.0
- get_dashboardGETv1.0.0
- get_dashboard_favorite_statusGETv1.0.0
- get_dashboard_id_or_slugGETv1.0.0
- get_dashboard_id_or_slug_chartsGETv1.0.0
- get_dashboard_id_or_slug_datasetsGETv1.0.0
- get_dashboard_infoGETv1.0.0
- get_dashboard_pk_thumbnail_digestGETv1.0.0
- get_dashboard_related_column_nameGETv1.0.0
- get_databaseGETv1.0.0
- get_database_availableGETv1.0.0
- get_database_infoGETv1.0.0
- get_database_pkGETv1.0.0
- get_database_pk_function_namesGETv1.0.0
- get_database_pk_related_objectsGETv1.0.0
- get_database_pk_select_star_table_nameGETv1.0.0
- get_datasetGETv1.0.0
- get_dataset_distinct_column_nameGETv1.0.0
- get_dataset_infoGETv1.0.0
- get_dataset_pkGETv1.0.0
- get_dataset_pk_related_objectsGETv1.0.0
- get_dataset_related_column_nameGETv1.0.0
- get_logGETv1.0.0
- get_log_pkGETv1.0.0
- get_menuGETv1.0.0
- get_queryGETv1.0.0
- get_query_distinct_column_nameGETv1.0.0
- get_query_pkGETv1.0.0
- get_query_related_column_nameGETv1.0.0
- get_reportGETv1.0.0
- get_report_infoGETv1.0.0
- get_report_pkGETv1.0.0
- get_report_pk_logGETv1.0.0
- get_report_pk_log_log_idGETv1.0.0
- get_report_related_column_nameGETv1.0.0
- get_saved_queryGETv1.0.0
- get_saved_query_distinct_column_nameGETv1.0.0
- get_saved_query_infoGETv1.0.0
- get_saved_query_pkGETv1.0.0
- get_saved_query_related_column_nameGETv1.0.0
- post_annotation_layerPOSTv1.0.0
- post_annotation_layer_pk_annotationPOSTv1.0.0
- post_cachekey_invalidatePOSTv1.0.0
- post_chartPOSTv1.0.0
- post_chart_dataPOSTv1.0.0
- post_css_templatePOSTv1.0.0
- post_dashboardPOSTv1.0.0
- post_databasePOSTv1.0.0
- post_database_test_connectionPOSTv1.0.0
- post_database_validate_parametersPOSTv1.0.0
- post_datasetPOSTv1.0.0
- post_logPOSTv1.0.0
- post_reportPOSTv1.0.0
- post_saved_queryPOSTv1.0.0
- post_security_loginPOSTv1.0.0
- post_security_refreshPOSTv1.0.0
- put_annotation_layer_pkPUTv1.0.0
- put_annotation_layer_pk_annotation_annotation_idPUTv1.0.0
- put_chart_pkPUTv1.0.0
- put_css_template_pkPUTv1.0.0
- put_dashboard_pkPUTv1.0.0
Other/Superset
post_database_validate_parameters
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
{
"type": "object",
"required": [
"configuration_method",
"engine"
],
"properties": {
"configuration_method": {
"description": "Configuration_method is used on the frontend to inform the backend whether to explode parameters or to provide only a sqlalchemy_uri.",
"type": "object"
},
"database_name": {
"type": "string",
"description": "A database name to identify this connection."
},
"encrypted_extra": {
"type": "string",
"description": "<p>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.</p>"
},
"engine": {
"type": "string",
"description": "SQLAlchemy engine to use"
},
"extra": {
"type": "string",
"description": "<p>JSON string containing extra configuration elements.<br>1. The <code>engine_params</code> object gets unpacked into the <a href=\"https://docs.sqlalchemy.org/en/latest/core/engines.html#sqlalchemy.create_engine\">sqlalchemy.create_engine</a> call, while the <code>metadata_params</code> gets unpacked into the <a href=\"https://docs.sqlalchemy.org/en/rel_1_0/core/metadata.html#sqlalchemy.schema.MetaData\">sqlalchemy.MetaData</a> call.<br>2. The <code>metadata_cache_timeout</code> is a cache timeout setting in seconds for metadata fetch of this database. Specify it as <strong>\"metadata_cache_timeout\": {\"schema_cache_timeout\": 600, \"table_cache_timeout\": 600}</strong>. If unset, cache will not be enabled for the functionality. A timeout of 0 indicates that the cache never expires.<br>3. The <code>schemas_allowed_for_csv_upload</code> is a comma separated list of schemas that CSVs are allowed to upload to. Specify it as <strong>\"schemas_allowed_for_csv_upload\": [\"public\", \"csv_upload\"]</strong>. If database flavor does not support schema or any schema is allowed to be accessed, just leave the list empty<br>4. the <code>version</code> 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 <code>allows_virtual_table_explore</code> field is a boolean specifying whether or not the Explore button in SQL Lab results is shown.</p>"
},
"impersonate_user": {
"type": "boolean",
"description": "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."
},
"parameters": {
"type": "object",
"description": "DB-specific parameters for configuration"
},
"server_cert": {
"type": "string",
"description": "<p>Optional CA_BUNDLE contents to validate HTTPS requests. Only available on certain database engines.</p>"
}
}
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
{
"type": "object",
"properties": {
"message": {
"type": "string"
}
}
}