Connect to SQL from Postgres Parameters Page (#13744)

* Addition: properties page with link to dashboard * Include new page * Initial Parameter page start * Include new changes from merged PRs * Including new constants * Git errors * Add parameter commands and help * Reset command * Added chart * git fix * Fixed string issues * connectSqlDialog is an abstract class. Separated out Miaa and Postgress connection * Initial start to adding connect to sql for postgres instance * Simplified classes extending ConnectToSqlDialog, added get providerName, and function to create error message * Miaa models provides dialog title * Updated failed message parameters * completionPromise.reject * Fixed connect to MSSql * Messy dialog showing from button * removed this._completionPromise.reject * Cleaning up code * Set connectSqlDialog to be an abstract class. Separated out Miaa and Postgres. (#13532) * connectSqlDialog is an abstract class. Separated out Miaa and Postgress connection * Simplified classes extending ConnectToSqlDialog, added get providerName, and function to create error message * Miaa models provides dialog title * Updated failed message parameters * completionPromise.reject * Fixed connect to MSSql * removed this._completionPromise.reject * Connect button clean up * Format * Format doc * Fixed compile errors * Cleaning up page * Clean up * clean up refresh * Format doc * Removed ellipse * Cleaning up problems * Updating localized constants * Missing username update * Get connection profile added to Resource model, abstract method created for calling connection dialog * Added createConnectionProfile * took out import * Pulled in new changes, fixed usercancellederror * Getting engine settings * Git errors * Corrected names of icons and constants, Fixed Miaa dialog title * Changed gear svg, made postgres extension a loc constant, fixed formatting * Fixed controller model name * Put connection profile and id in resource model, changed back controller model in base class
2026-02-08 01:28:26 -05:00 · 2021-01-07 19:42:48 -08:00
parent 6c2e713a92
commit e7fb44b3a2
14 changed files with 832 additions and 105 deletions
--- a/extensions/arc/src/models/postgresModel.ts
+++ b/extensions/arc/src/models/postgresModel.ts
@@ -3,27 +3,45 @@
 *  Licensed under the Source EULA. See License.txt in the project root for license information.
 *--------------------------------------------------------------------------------------------*/

-import { ResourceInfo } from 'arc';
+import { PGResourceInfo } from 'arc';
+import * as azdata from 'azdata';
 import * as azdataExt from 'azdata-ext';
 import * as vscode from 'vscode';
 import * as loc from '../localizedConstants';
+import { ConnectToPGSqlDialog } from '../ui/dialogs/connectPGDialog';
+import { AzureArcTreeDataProvider } from '../ui/tree/azureArcTreeDataProvider';
 import { ControllerModel, Registration } from './controllerModel';
+import { parseIpAndPort } from '../common/utils';
+import { UserCancelledError } from '../common/api';
 import { ResourceModel } from './resourceModel';
 import { Deferred } from '../common/promise';
-import { parseIpAndPort } from '../common/utils';
+
+export type EngineSettingsModel = {
+	parameterName: string | undefined,
+	value: string | undefined,
+	description: string | undefined,
+	min: string | undefined,
+	max: string | undefined,
+	options: string | undefined,
+	type: string | undefined
+};

 export class PostgresModel extends ResourceModel {
 	private _config?: azdataExt.PostgresServerShowResult;
+	public _engineSettings: EngineSettingsModel[] = [];
 	private readonly _azdataApi: azdataExt.IExtension;

 	private readonly _onConfigUpdated = new vscode.EventEmitter<azdataExt.PostgresServerShowResult>();
+	public readonly _onEngineSettingsUpdated = new vscode.EventEmitter<EngineSettingsModel[]>();
 	public onConfigUpdated = this._onConfigUpdated.event;
+	public onEngineSettingsUpdated = this._onEngineSettingsUpdated.event;
 	public configLastUpdated?: Date;
+	public engineSettingsLastUpdated?: Date;

 	private _refreshPromise?: Deferred<void>;

-	constructor(controllerModel: ControllerModel, info: ResourceInfo, registration: Registration) {
-		super(controllerModel, info, registration);
+	constructor(_controllerModel: ControllerModel, private _pgInfo: PGResourceInfo, registration: Registration, private _treeDataProvider: AzureArcTreeDataProvider) {
+		super(_controllerModel, _pgInfo, registration);
 		this._azdataApi = <azdataExt.IExtension>vscode.extensions.getExtension(azdataExt.extension.name)?.exports;
 	}

@@ -103,4 +121,84 @@ export class PostgresModel extends ResourceModel {
 			this._refreshPromise = undefined;
 		}
 	}
+
+	public async getEngineSettings(): Promise<void> {
+		if (!this._connectionProfile) {
+			await this.getConnectionProfile();
+		}
+
+		// We haven't connected yet so do so now and then store the ID for the active connection
+		if (!this._activeConnectionId) {
+			const result = await azdata.connection.connect(this._connectionProfile!, false, false);
+			if (!result.connected) {
+				throw new Error(result.errorMessage);
+			}
+			this._activeConnectionId = result.connectionId;
+		}
+
+		const provider = azdata.dataprotocol.getProvider<azdata.QueryProvider>(this._connectionProfile!.providerName, azdata.DataProviderType.QueryProvider);
+		const ownerUri = await azdata.connection.getUriForConnection(this._activeConnectionId);
+
+		const engineSettings = await provider.runQueryAndReturn(ownerUri, 'select name, setting, short_desc,min_val, max_val, enumvals, vartype from pg_settings');
+		if (!engineSettings) {
+			throw new Error('Could not fetch engine settings');
+		}
+		engineSettings.rows.forEach(row => {
+			let rowValues = row.map(c => c.displayValue);
+			let result: EngineSettingsModel = {
+				parameterName: rowValues.shift(),
+				value: rowValues.shift(),
+				description: rowValues.shift(),
+				min: rowValues.shift(),
+				max: rowValues.shift(),
+				options: rowValues.shift(),
+				type: rowValues.shift()
+			};
+
+			this._engineSettings.push(result);
+		});
+
+		this.engineSettingsLastUpdated = new Date();
+	}
+
+	protected createConnectionProfile(): azdata.IConnectionProfile {
+		const ipAndPort = parseIpAndPort(this.config?.status.externalEndpoint || '');
+		return {
+			serverName: `${ipAndPort.ip},${ipAndPort.port}`,
+			databaseName: '',
+			authenticationType: 'SqlLogin',
+			providerName: loc.postgresProviderName,
+			connectionName: '',
+			userName: this._pgInfo.userName || '',
+			password: '',
+			savePassword: true,
+			groupFullName: undefined,
+			saveProfile: true,
+			id: '',
+			groupId: undefined,
+			options: {
+				host: `${ipAndPort.ip}`,
+				port: `${ipAndPort.port}`,
+			}
+		};
+	}
+
+	protected async promptForConnection(connectionProfile: azdata.IConnectionProfile): Promise<void> {
+		const connectToSqlDialog = new ConnectToPGSqlDialog(this.controllerModel, this);
+		connectToSqlDialog.showDialog(loc.connectToPGSql(this.info.name), connectionProfile);
+		let profileFromDialog = await connectToSqlDialog.waitForClose();
+
+		if (profileFromDialog) {
+			this.updateConnectionProfile(profileFromDialog);
+		} else {
+			throw new UserCancelledError();
+		}
+	}
+
+	protected async updateConnectionProfile(connectionProfile: azdata.IConnectionProfile): Promise<void> {
+		this._connectionProfile = connectionProfile;
+		this.info.connectionId = connectionProfile.id;
+		this._pgInfo.userName = connectionProfile.userName;
+		await this._treeDataProvider.saveControllers();
+	}
 }