SQL Datasources: Reinstate SQL data source behavior around database selection when default configured databases already exist

docs/sources/datasources/mssql/query-editor/index.md

@@ -87,12 +87,12 @@ Code mode supports autocompletion of tables, columns, SQL keywords, standard SQL
 
 In **Builder mode**, you can build queries using a visual interface.
 
-### Select a dataset and table
+### Dataset and table selection
 
-In the **Dataset** dropdown, select the MS SQL database to query.
+In the **Dataset** dropdown, select the MSSQL database to query. Grafana populates the dropdown with all databases that the user can access.
+Once you select a database, Grafana populates the dropdown with all available tables.
 
-Grafana populates the dropdown with the databases that the configured user can access.
-When you select a dataset, Grafana populates the **Table** dropdown with available tables.
+**Note:** If a default database has been configured through the Data Source Configuration page (or through a provisioning configuration file), the user will only be able to use that single preconfigured database for querying.
 
 ### Select columns and aggregation functions (SELECT)
 

docs/sources/datasources/mysql/_index.md

@@ -186,6 +186,8 @@ If your table or database name contains a reserved word or a [not permitted char
 In the dataset dropdown, choose the MySQL database to query. The dropdown is be populated with the databases that the user has access to.
 When the dataset is selected, the table dropdown is populated with the tables that are available.
 
+**Note:** If a default database has been configured through the Data Source Configuration page (or through a provisioning configuration file), the user will only be able to use that single preconfigured database for querying.
+
 ### Columns and Aggregation functions (SELECT)
 
 Using the dropdown, select a column to include in the data. You can also specify an optional aggregation function.

docs/sources/datasources/postgres/_index.md

@@ -88,18 +88,18 @@ Make sure the user does not get any unwanted privileges from the public role.
 
 ## Query builder
 
-{{< figure src="/static/img/docs/v92/postgresql_query_builder.png" class="docs-image--no-shadow" caption="PostgreSQL query builder" >}}
+{{< figure src="/static/img/docs/screenshot-postgres-query-editor.png" class="docs-image--no-shadow" caption="PostgreSQL query builder" >}}
 
 The PostgreSQL query builder is available when editing a panel using a PostgreSQL data source. The built query can be run by pressing the `Run query` button in the top right corner of the editor.
 
 ### Format
 
 The response from PostgreSQL can be formatted as either a table or as a time series. To use the time series format one of the columns must be named `time`.
 
-### Dataset and Table selection
+### Dataset and table selection
 
-In the dataset dropdown, choose the PostgreSQL database to query. The dropdown is be populated with the databases that the user has access to.
-When the dataset is selected, the table dropdown is populated with the tables that are available.
+The dataset dropdown will be populated with the configured database to which the user has access.
+The table dropdown is populated with the tables that are available within that database.
 
 ### Columns and Aggregation functions (SELECT)
 

docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md

@@ -65,6 +65,7 @@ Some stable features are enabled by default. You can disable a stable feature by
 | `faroDatasourceSelector`             | Enable the data source selector within the Frontend Apps section of the Frontend Observability                                                                                               |
 | `enableDatagridEditing`              | Enables the edit functionality in the datagrid panel                                                                                                                                         |
 | `dataSourcePageHeader`               | Apply new pageHeader UI in data source edit page                                                                                                                                             |
+| `sqlDatasourceDatabaseSelection`     | Enables previous SQL data source dataset dropdown behavior                                                                                                                                   |
 
 ## Alpha feature toggles
 

packages/grafana-data/src/types/featureToggles.gen.ts

@@ -98,4 +98,5 @@ export interface FeatureToggles {
   enableDatagridEditing?: boolean;
   dataSourcePageHeader?: boolean;
   extraThemes?: boolean;
+  sqlDatasourceDatabaseSelection?: boolean;
 }

pkg/api/frontendsettings.go

@@ -372,6 +372,16 @@ func (hs *HTTPServer) getFSDataSources(c *contextmodel.ReqContext, availablePlug
 			}
 		}
 
+		// Update `jsonData.database` for outdated provisioned SQL datasources created WITHOUT the `jsonData` object in their configuration.
+		// In these cases, the `Database` value is defined (if at all) on the root level of the provisioning config object.
+		// This is done for easier warning/error checking on the front end.
+		if (ds.Type == datasources.DS_MSSQL) || (ds.Type == datasources.DS_MYSQL) || (ds.Type == datasources.DS_POSTGRES) {
+			// Only update if the value isn't already assigned.
+			if dsDTO.JSONData["database"] == nil || dsDTO.JSONData["database"] == "" {
+				dsDTO.JSONData["database"] = ds.Database
+			}
+		}
+
 		if (ds.Type == datasources.DS_INFLUXDB) || (ds.Type == datasources.DS_ES) {
 			dsDTO.Database = ds.Database
 		}

pkg/services/featuremgmt/registry.go

@@ -541,5 +541,12 @@ var (
 			State:        FeatureStateAlpha,
 			Owner:        grafanaUserEssentialsSquad,
 		},
+		{
+			Name:         "sqlDatasourceDatabaseSelection",
+			Description:  "Enables previous SQL data source dataset dropdown behavior",
+			FrontendOnly: true,
+			State:        FeatureStateBeta,
+			Owner:        grafanaBiSquad,
+		},
 	}
 )

pkg/services/featuremgmt/toggles_gen.csv

@@ -79,3 +79,4 @@ faroDatasourceSelector,beta,@grafana/app-o11y,false,false,false,true
 enableDatagridEditing,beta,@grafana/grafana-bi-squad,false,false,false,true
 dataSourcePageHeader,beta,@grafana/enterprise-datasources,false,false,false,true
 extraThemes,alpha,@grafana/user-essentials,false,false,false,true
+sqlDatasourceDatabaseSelection,beta,@grafana/grafana-bi-squad,false,false,false,true

pkg/services/featuremgmt/toggles_gen.go

@@ -326,4 +326,8 @@ const (
 	// FlagExtraThemes
 	// Enables extra themes
 	FlagExtraThemes = "extraThemes"
+
+	// FlagSqlDatasourceDatabaseSelection
+	// Enables previous SQL data source dataset dropdown behavior
+	FlagSqlDatasourceDatabaseSelection = "sqlDatasourceDatabaseSelection"
 )

public/app/features/plugins/sql/components/DatasetSelector.tsx

@@ -6,47 +6,78 @@ import { Select } from '@grafana/ui';
 
 import { DB, ResourceSelectorProps, toOption } from '../types';
 
-interface DatasetSelectorProps extends ResourceSelectorProps {
+import { isSqlDatasourceDatabaseSelectionFeatureFlagEnabled } from './QueryEditorFeatureFlag.utils';
+
+export interface DatasetSelectorProps extends ResourceSelectorProps {
   db: DB;
-  value: string | null;
-  applyDefault?: boolean;
-  disabled?: boolean;
+  dataset: string | undefined;
+  preconfiguredDataset: string;
+  isPostgresInstance: boolean | undefined;
   onChange: (v: SelectableValue) => void;
 }
 
-export const DatasetSelector = ({ db, value, onChange, disabled, className, applyDefault }: DatasetSelectorProps) => {
+export const DatasetSelector = ({
+  dataset,
+  db,
+  isPostgresInstance,
+  onChange,
+  preconfiguredDataset,
+}: DatasetSelectorProps) => {
+  /* 
+    The behavior of this component - for MSSQL and MySQL datasources - is based on whether the user chose to create a datasource
+    with or without a default database (preconfiguredDataset). If the user configured a default database, this selector
+    should only allow that single preconfigured database option to be selected. If the user chose to NOT assign/configure a default database,
+    then the user should be able to use this component to choose between multiple databases available to the datasource.
+  */
+  // `hasPreconfigCondition` is true if either 1) the sql datasource has a preconfigured default database,
+  // OR if 2) the datasource is Postgres. In either case the only option available to the user is the preconfigured database.
+  const hasPreconfigCondition = !!preconfiguredDataset || isPostgresInstance;
+
   const state = useAsync(async () => {
+    if (isSqlDatasourceDatabaseSelectionFeatureFlagEnabled()) {
+      // If a default database is already configured for a MSSQL or MySQL data source, OR the data source is Postgres, no need to fetch other databases.
+      if (hasPreconfigCondition) {
+        // Set the current database to the preconfigured database.
+        onChange(toOption(preconfiguredDataset));
+        return [toOption(preconfiguredDataset)];
+      }
+    }
+
+    // If there is no preconfigured database, but there is a selected dataset, set the current database to the selected dataset.
+    if (dataset) {
+      onChange(toOption(dataset));
+    }
+
+    // Otherwise, fetch all databases available to the datasource.
     const datasets = await db.datasets();
     return datasets.map(toOption);
   }, []);
 
   useEffect(() => {
-    if (!applyDefault) {
-      return;
-    }
-    // Set default dataset when values are fetched
-    if (!value) {
-      if (state.value && state.value[0]) {
-        onChange(state.value[0]);
-      }
-    } else {
-      if (state.value && state.value.find((v) => v.value === value) === undefined) {
-        // if value is set and newly fetched values does not contain selected value
-        if (state.value.length > 0) {
+    if (!isSqlDatasourceDatabaseSelectionFeatureFlagEnabled()) {
+      // Set default dataset when values are fetched
+      if (!dataset) {
+        if (state.value && state.value[0]) {
           onChange(state.value[0]);
         }
+      } else {
+        if (state.value && state.value.find((v) => v.value === dataset) === undefined) {
+          // if value is set and newly fetched values does not contain selected value
+          if (state.value.length > 0) {
+            onChange(state.value[0]);
+          }
+        }
       }
     }
-  }, [state.value, value, applyDefault, onChange]);
+  }, [state.value, onChange, dataset]);
 
   return (
     <Select
-      className={className}
       aria-label="Dataset selector"
-      value={value}
+      value={dataset}
       options={state.value}
       onChange={onChange}
-      disabled={disabled}
+      disabled={state.loading}
       isLoading={state.loading}
       menuShouldPortal={true}
     />

public/app/features/plugins/sql/components/QueryEditor.tsx

@@ -13,13 +13,23 @@ import { QueryHeader, QueryHeaderProps } from './QueryHeader';
 import { RawEditor } from './query-editor-raw/RawEditor';
 import { VisualEditor } from './visual-query-builder/VisualEditor';
 
-interface Props extends QueryEditorProps<SqlDatasource, SQLQuery, SQLOptions> {
-  queryHeaderProps?: Pick<QueryHeaderProps, 'isDatasetSelectorHidden'>;
+interface SqlQueryEditorProps extends QueryEditorProps<SqlDatasource, SQLQuery, SQLOptions> {
+  queryHeaderProps?: Pick<QueryHeaderProps, 'isPostgresInstance'>;
 }
 
-export function SqlQueryEditor({ datasource, query, onChange, onRunQuery, range, queryHeaderProps }: Props) {
+export function SqlQueryEditor({
+  datasource,
+  query,
+  onChange,
+  onRunQuery,
+  range,
+  queryHeaderProps,
+}: SqlQueryEditorProps) {
   const [isQueryRunnable, setIsQueryRunnable] = useState(true);
   const db = datasource.getDB();
+
+  const { preconfiguredDatabase } = datasource;
+  const isPostgresInstance = !!queryHeaderProps?.isPostgresInstance;
   const { loading, error } = useAsync(async () => {
     return () => {
       if (datasource.getDB(datasource.id).init !== undefined) {
@@ -80,13 +90,14 @@ export function SqlQueryEditor({ datasource, query, onChange, onRunQuery, range,
     <>
       <QueryHeader
         db={db}
+        preconfiguredDataset={preconfiguredDatabase}
         onChange={onQueryHeaderChange}
         onRunQuery={onRunQuery}
         onQueryRowChange={setQueryRowFilter}
         queryRowFilter={queryRowFilter}
         query={queryWithDefaults}
         isQueryRunnable={isQueryRunnable}
-        {...queryHeaderProps}
+        isPostgresInstance={isPostgresInstance}
       />
 
       <Space v={0.5} />

public/app/features/plugins/sql/components/QueryEditorFeatureFlag.utils.ts

@@ -0,0 +1,5 @@
+import { config } from '@grafana/runtime';
+
+export const isSqlDatasourceDatabaseSelectionFeatureFlagEnabled = () => {
+  return !!config.featureToggles.sqlDatasourceDatabaseSelection;
+};

public/app/features/plugins/sql/components/QueryHeader.tsx

@@ -10,17 +10,19 @@ import { SQLQuery, QueryFormat, QueryRowFilter, QUERY_FORMAT_OPTIONS, DB } from
 
 import { ConfirmModal } from './ConfirmModal';
 import { DatasetSelector } from './DatasetSelector';
+import { isSqlDatasourceDatabaseSelectionFeatureFlagEnabled } from './QueryEditorFeatureFlag.utils';
 import { TableSelector } from './TableSelector';
 
 export interface QueryHeaderProps {
   db: DB;
-  query: QueryWithDefaults;
+  isPostgresInstance?: boolean;
+  isQueryRunnable: boolean;
   onChange: (query: SQLQuery) => void;
-  onRunQuery: () => void;
   onQueryRowChange: (queryRowFilter: QueryRowFilter) => void;
+  onRunQuery: () => void;
+  preconfiguredDataset: string;
+  query: QueryWithDefaults;
   queryRowFilter: QueryRowFilter;
-  isQueryRunnable: boolean;
-  isDatasetSelectorHidden?: boolean;
 }
 
 const editorModes = [
@@ -30,13 +32,14 @@ const editorModes = [
 
 export function QueryHeader({
   db,
-  query,
-  queryRowFilter,
+  isPostgresInstance,
+  isQueryRunnable,
   onChange,
-  onRunQuery,
   onQueryRowChange,
-  isQueryRunnable,
-  isDatasetSelectorHidden,
+  onRunQuery,
+  preconfiguredDataset,
+  query,
+  queryRowFilter,
 }: QueryHeaderProps) {
   const { editorMode } = query;
   const [_, copyToClipboard] = useCopyToClipboard();
@@ -86,9 +89,20 @@ export function QueryHeader({
       sql: undefined,
       rawSql: '',
     };
+
     onChange(next);
   };
 
+  const datasetDropdownIsAvailable = () => {
+    // If the feature flag is DISABLED, && the datasource is Postgres (`isPostgresInstance`),
+    // we want to hide the dropdown - as per previous behavior.
+    if (!isSqlDatasourceDatabaseSelectionFeatureFlagEnabled() && isPostgresInstance) {
+      return false;
+    }
+
+    return true;
+  };
+
   return (
     <>
       <EditorHeader>
@@ -205,24 +219,23 @@ export function QueryHeader({
         <>
           <Space v={0.5} />
           <EditorRow>
-            {isDatasetSelectorHidden ? null : (
+            {datasetDropdownIsAvailable() && (
               <EditorField label="Dataset" width={25}>
                 <DatasetSelector
                   db={db}
-                  value={query.dataset === undefined ? null : query.dataset}
+                  dataset={query.dataset}
+                  isPostgresInstance={isPostgresInstance}
+                  preconfiguredDataset={preconfiguredDataset}
                   onChange={onDatasetChange}
                 />
               </EditorField>
             )}
-
             <EditorField label="Table" width={25}>
               <TableSelector
                 db={db}
-                query={query}
-                value={query.table === undefined ? null : query.table}
+                dataset={query.dataset || preconfiguredDataset}
+                table={query.table}
                 onChange={onTableChange}
-                forceFetch={isDatasetSelectorHidden}
-                applyDefault
               />
             </EditorField>
           </EditorRow>