diff --git a/docs/sources/datasources/mssql/query-editor/index.md b/docs/sources/datasources/mssql/query-editor/index.md index a50c05944db..d2b3a15a063 100644 --- a/docs/sources/datasources/mssql/query-editor/index.md +++ b/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) diff --git a/docs/sources/datasources/mysql/_index.md b/docs/sources/datasources/mysql/_index.md index e6916e44b01..5c02e1c0983 100644 --- a/docs/sources/datasources/mysql/_index.md +++ b/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. diff --git a/docs/sources/datasources/postgres/_index.md b/docs/sources/datasources/postgres/_index.md index 3f004d1ec4e..925ca9e130a 100644 --- a/docs/sources/datasources/postgres/_index.md +++ b/docs/sources/datasources/postgres/_index.md @@ -88,7 +88,7 @@ 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. @@ -96,10 +96,10 @@ The PostgreSQL query builder is available when editing a panel using a PostgreSQ 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) diff --git a/docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md b/docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md index 60923087c26..dd24f98b9aa 100644 --- a/docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md +++ b/docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md @@ -64,6 +64,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 diff --git a/packages/grafana-data/src/types/featureToggles.gen.ts b/packages/grafana-data/src/types/featureToggles.gen.ts index e4b4d58eddb..64f007ad613 100644 --- a/packages/grafana-data/src/types/featureToggles.gen.ts +++ b/packages/grafana-data/src/types/featureToggles.gen.ts @@ -100,4 +100,5 @@ export interface FeatureToggles { extraThemes?: boolean; lokiPredefinedOperations?: boolean; pluginsFrontendSandbox?: boolean; + sqlDatasourceDatabaseSelection?: boolean; } diff --git a/pkg/api/frontendsettings.go b/pkg/api/frontendsettings.go index c70337522f0..0504937f8d9 100644 --- a/pkg/api/frontendsettings.go +++ b/pkg/api/frontendsettings.go @@ -375,6 +375,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 } diff --git a/pkg/services/featuremgmt/registry.go b/pkg/services/featuremgmt/registry.go index 1e48109c6da..f7353b18e92 100644 --- a/pkg/services/featuremgmt/registry.go +++ b/pkg/services/featuremgmt/registry.go @@ -555,5 +555,12 @@ var ( FrontendOnly: true, Owner: grafanaPluginsPlatformSquad, }, + { + Name: "sqlDatasourceDatabaseSelection", + Description: "Enables previous SQL data source dataset dropdown behavior", + FrontendOnly: true, + State: FeatureStateBeta, + Owner: grafanaBiSquad, + }, } ) diff --git a/pkg/services/featuremgmt/toggles_gen.csv b/pkg/services/featuremgmt/toggles_gen.csv index 883b1369817..ea99bbb62b5 100644 --- a/pkg/services/featuremgmt/toggles_gen.csv +++ b/pkg/services/featuremgmt/toggles_gen.csv @@ -81,3 +81,4 @@ dataSourcePageHeader,beta,@grafana/enterprise-datasources,false,false,false,true extraThemes,alpha,@grafana/grafana-frontend-platform,false,false,false,true lokiPredefinedOperations,alpha,@grafana/observability-logs,false,false,false,true pluginsFrontendSandbox,alpha,@grafana/plugins-platform-backend,false,false,false,true +sqlDatasourceDatabaseSelection,beta,@grafana/grafana-bi-squad,false,false,false,true diff --git a/pkg/services/featuremgmt/toggles_gen.go b/pkg/services/featuremgmt/toggles_gen.go index d29209eda2a..555a4c376f1 100644 --- a/pkg/services/featuremgmt/toggles_gen.go +++ b/pkg/services/featuremgmt/toggles_gen.go @@ -334,4 +334,8 @@ const ( // FlagPluginsFrontendSandbox // Enables the plugins frontend sandbox FlagPluginsFrontendSandbox = "pluginsFrontendSandbox" + + // FlagSqlDatasourceDatabaseSelection + // Enables previous SQL data source dataset dropdown behavior + FlagSqlDatasourceDatabaseSelection = "sqlDatasourceDatabaseSelection" ) diff --git a/public/app/features/plugins/sql/components/DatasetSelector.tsx b/public/app/features/plugins/sql/components/DatasetSelector.tsx index ac968f04f9a..2df95568ccf 100644 --- a/public/app/features/plugins/sql/components/DatasetSelector.tsx +++ b/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 ( { id: number; responseParser: ResponseParser; name: string; interval: string; db: DB; + preconfiguredDatabase: string; constructor( instanceSettings: DataSourceInstanceSettings, @@ -48,6 +55,11 @@ export abstract class SqlDatasource extends DataSourceWithBackend): Observable { + // This logic reenables the previous SQL behavior regarding what databases are available for the user to query. + if (isSqlDatasourceDatabaseSelectionFeatureFlagEnabled()) { + const databaseIssue = this.checkForDatabaseIssue(request); + + if (!!databaseIssue) { + const error = new Error(databaseIssue); + return throwError(() => error); + } + } + + return super.query(request); + } + + private checkForDatabaseIssue(request: DataQueryRequest) { + // If the datasource is Postgres and there is no default database configured - either never configured or removed - return a database issue. + if (this.type === 'postgres' && !this.preconfiguredDatabase) { + return `You do not currently have a default database configured for this data source. Postgres requires a default + database with which to connect. Please configure one through the Data Sources Configuration page, or if you + are using a provisioning file, update that configuration file with a default database.`; + } + + // No need to check for database change/update issues if the datasource is being used in Explore. + if (request.app !== CoreApp.Explore) { + /* + If a preconfigured datasource database has been added/updated - and the user has built ANY number of queries using a + database OTHER than the preconfigured one, return a database issue - since those databases are no longer available. + The user will need to update their queries to use the preconfigured database. + */ + if (!!this.preconfiguredDatabase) { + for (const target of request.targets) { + // Test for database configuration change only if query was made in `builder` mode. + if (target.editorMode === EditorMode.Builder && target.dataset !== this.preconfiguredDatabase) { + return `The configuration for this panel's data source has been modified. The previous database used in this panel's + saved query is no longer available. Please update the query to use the new database option. + Previous query parameters will be preserved until the query is updated.`; + } + } + } + } + + return; + } + async metricFindQuery(query: string, optionalOptions?: MetricFindQueryOptions): Promise { let refId = 'tempvar'; if (optionalOptions && optionalOptions.variable && optionalOptions.variable.name) { diff --git a/public/app/features/query/components/QueryGroup.tsx b/public/app/features/query/components/QueryGroup.tsx index c7a7c7a4ad1..7f34958c82c 100644 --- a/public/app/features/query/components/QueryGroup.tsx +++ b/public/app/features/query/components/QueryGroup.tsx @@ -147,6 +147,7 @@ export class QueryGroup extends PureComponent { const queries = await updateQueries(nextDS, newSettings.uid, this.state.queries, currentDS); const dataSource = await this.dataSourceSrv.get(newSettings.name); + this.onChange({ queries, dataSource: { diff --git a/public/app/plugins/datasource/mssql/datasource.ts b/public/app/plugins/datasource/mssql/datasource.ts index 9c1bca08857..13e6781f0bf 100644 --- a/public/app/plugins/datasource/mssql/datasource.ts +++ b/public/app/plugins/datasource/mssql/datasource.ts @@ -83,7 +83,7 @@ export class MssqlDatasource extends SqlDatasource { validateQuery: (query) => Promise.resolve({ isError: false, isValid: true, query, error: '', rawSql: query.rawSql }), dsID: () => this.id, - dispose: (dsID?: string) => {}, + dispose: (_dsID?: string) => {}, toRawSql, lookup: async (path?: string) => { if (!path) { diff --git a/public/app/plugins/datasource/mysql/MySqlDatasource.ts b/public/app/plugins/datasource/mysql/MySqlDatasource.ts index 73e491112b1..74bc814fb36 100644 --- a/public/app/plugins/datasource/mysql/MySqlDatasource.ts +++ b/public/app/plugins/datasource/mysql/MySqlDatasource.ts @@ -29,11 +29,13 @@ export class MySqlDatasource extends SqlDatasource { const args = { getMeta: (identifier?: TableIdentifier) => this.fetchMeta(identifier), }; + this.sqlLanguageDefinition = { id: 'mysql', completionProvider: getSqlCompletionProvider(args), formatter: formatSQL, }; + return this.sqlLanguageDefinition; } @@ -88,11 +90,12 @@ export class MySqlDatasource extends SqlDatasource { if (this.db !== undefined) { return this.db; } + return { datasets: () => this.fetchDatasets(), tables: (dataset?: string) => this.fetchTables(dataset), fields: (query: SQLQuery) => this.fetchFields(query), - validateQuery: (query: SQLQuery, range?: TimeRange) => + validateQuery: (query: SQLQuery, _range?: TimeRange) => Promise.resolve({ query, error: '', isError: false, isValid: true }), dsID: () => this.id, toRawSql, diff --git a/public/app/plugins/datasource/postgres/QueryEditor.tsx b/public/app/plugins/datasource/postgres/PostgresQueryEditor.tsx similarity index 69% rename from public/app/plugins/datasource/postgres/QueryEditor.tsx rename to public/app/plugins/datasource/postgres/PostgresQueryEditor.tsx index 95207fb76ae..18358305450 100644 --- a/public/app/plugins/datasource/postgres/QueryEditor.tsx +++ b/public/app/plugins/datasource/postgres/PostgresQueryEditor.tsx @@ -6,8 +6,8 @@ import { SQLOptions, SQLQuery } from 'app/features/plugins/sql/types'; import { PostgresDatasource } from './datasource'; -const queryHeaderProps = { isDatasetSelectorHidden: true }; +const queryHeaderProps = { isPostgresInstance: true }; -export function QueryEditor(props: QueryEditorProps) { +export function PostgresQueryEditor(props: QueryEditorProps) { return ; } diff --git a/public/app/plugins/datasource/postgres/datasource.ts b/public/app/plugins/datasource/postgres/datasource.ts index 602dd9504c6..597a4fede83 100644 --- a/public/app/plugins/datasource/postgres/datasource.ts +++ b/public/app/plugins/datasource/postgres/datasource.ts @@ -81,6 +81,7 @@ export class PostgresDatasource extends SqlDatasource { if (this.db !== undefined) { return this.db; } + return { init: () => Promise.resolve(true), datasets: () => Promise.resolve([]), diff --git a/public/app/plugins/datasource/postgres/module.ts b/public/app/plugins/datasource/postgres/module.ts index 067dd49d07c..6aa5667cfd0 100644 --- a/public/app/plugins/datasource/postgres/module.ts +++ b/public/app/plugins/datasource/postgres/module.ts @@ -2,7 +2,7 @@ import { DataSourcePlugin } from '@grafana/data'; import { SQLQuery } from 'app/features/plugins/sql/types'; import { CheatSheet } from './CheatSheet'; -import { QueryEditor } from './QueryEditor'; +import { PostgresQueryEditor } from './PostgresQueryEditor'; import { PostgresConfigEditor } from './configuration/ConfigurationEditor'; import { PostgresDatasource } from './datasource'; import { PostgresOptions, SecureJsonData } from './types'; @@ -10,6 +10,6 @@ import { PostgresOptions, SecureJsonData } from './types'; export const plugin = new DataSourcePlugin( PostgresDatasource ) - .setQueryEditor(QueryEditor) + .setQueryEditor(PostgresQueryEditor) .setQueryEditorHelp(CheatSheet) .setConfigEditor(PostgresConfigEditor);