Extensibilité d’Azure Data Studio

Azure Data Studio dispose de plusieurs mécanismes d’extensibilité qui permettent de personnaliser l’expérience utilisateur et de rendre ces personnalisations accessibles à l’ensemble de la communauté d’utilisateurs. La plateforme Azure Data Studio principale repose sur Visual Studio Code, ainsi la plupart des API d’extensibilité de Visual Studio Code sont disponibles. En outre, nous avons fourni des points d’extensibilité supplémentaires pour des activités spécifiques à la gestion des données.

Voici quelques-uns des principaux points d’extensibilité :

• API d’extensibilité de Visual Studio Code
• Outils de création d’extensions Azure Data Studio
• Gestion des contributions du panneau des onglets du tableau de bord
• Insights avec les expériences Actions
• API d’extensibilité d’Azure Data Studio
• API Fournisseur de données personnalisées

API d’extensibilité de Visual Studio Code

Étant donné que la plateforme principale Azure Data Studio repose sur Visual Studio Code, vous trouverez des détails sur les API d’extensibilité de Visual Studio Code dans les documentations Création d’extensions et API d’extension sur le site web Visual Studio Code.

Gestion des contributions du panneau des onglets du tableau de bord

Pour plus d’informations, consultez Points de contribution et Variables de contexte.

API d’extensibilité d’Azure Data Studio

Pour plus d’informations, consultez API d’extensibilité.

Points de contribution

Cette section décrit les différents points de contribution définis dans le manifeste de l’extension package.json.

IntelliSense est pris en charge dans Azure Data Studio.

Points de contribution du tableau de bord

Contribuez à un onglet, un conteneur et/ou un widget insight dans le tableau de bord.

dashboard.tabs

Dashboard.tabs crée les sections d’onglets sur la page de tableau de bord. Il attend un objet ou un tableau d’objets,

"dashboard.tabs": [
{
	"id": "test-tab1",
	"title": "Test 1",
	"description": "The test 1 displays a list of widgets.",
	"when": "connectionProvider == 'MSSQL' && !mssql:iscloud",
	"alwaysShow": true,
	"container": {
		...
	}
}
]

dashboard.containers

au lieu de spécifier le conteneur du tableau de bord inclus (dans le dashboard.tab). Vous pouvez inscrire des conteneurs à l’aide de dashboard.containers. Il accepte un objet ou un tableau d’objets.

"dashboard.containers": [
{
	"id": "innerTab1",
	"container": {
		...
	}
},
{
	"id": "innerTab2",
	"container": {
	   ...
	}
}
]

Pour faire référence au conteneur inscrit, spécifiez l’ID du conteneur

"dashboard.tabs": [
{
	...
	"container": {
		"innerTab1": {             
		}
	}
}
]

dashboard.insights

Vous pouvez enregistrer des insights à l’aide de dashboard.insights. Cela est similaire au Didacticiel : Créer un widget insight personnalisé

"dashboard.insights": {
"id": "my-widget"
"type": {
	"count": {
		"dataDirection": "vertical",
		"dataType": "number",
		"legendPosition": "none",
           "labelFirstColumn": false,
		"columnsAsLabels": false
       }
   },
   "queryFile": "{your file folder}/activeSession.sql"
}

Types de conteneurs de tableau de bord

Quatre types de conteneur sont actuellement pris en charge :

1. widgets-container

   

   Liste des widgets qui seront affichés dans le conteneur. Il s’agit d’une mise en page fluide. Il accepte la liste des widgets.

   "container": {
   	"widgets-container": [
   	{
   		"widget": {
   			"query-data-store-db-insight": {
   			}
   		}
   	},
   	{
   		"widget": {
   			"explorer-widget": {
   			}
   		}
   	}
     ]
   }
   

2. webview-container

   

   La vue d’affichage web s’affichera dans l’intégralité du conteneur. Elle s’attend à ce que l’ID d’affichage web soit le même que l’ID de l’onglet

   "container": {
   	"webview-container": null
   }
   

3. grid-container

   

   Liste des widgets ou des affichages web qui seront affichés dans la disposition de la grille

    "container": {
    	"grid-container": [
       {
       	"name": "widget 1",
       	"widget": {
       		"explorer-widget": {
       		}
       	},
       	"row":0,
       	"col":0
       },
       {
       	"name": "widget 2",
       	"widget": {
       		"tasks-widget": {
       			"backup", 
       			"restore",
       			"configureDashboard",
       			"newQuery"
       		}
       	},
       	"row":0,
       	"col":1
       },
       {
       	"name": "Webview 1",
       	"webview": {
       		"id": "google"
       	},
       	"row":1,
       	"col":0,
       	"colspan":2
       },
       {
       	"name": "widget 3",
       	"widget": {
       		"explorer-widget": {}
       	},
       	"row":0,
       	"col":3,
       	"rowspan":2
       },
   ]
   

4. nav-section

   

   La section de navigation s’affiche dans le conteneur

   "container": {
   	"nav-section": [
   		{
   			"id": "innerTab1",
   			"title": "inner-tab1",
   			"icon": {
   				"light": "./icons/tab1Icon.svg",
   				"dark": "./icons/tab1Icon_dark.svg"
   			},
   			"container": {
   				...
   			}
   		},
   		{
   			"id": "innerTab2",
   			"title": "inner-tab2",
   			"icon": {
   				"light": "./icons/tab2Icon.svg",
   				"dark": "./icons/tab2Icon_dark.svg"
   			},
   			"container": {
   				...
   			}
   		}
   	]
   }
   

Variables de contexte

Pour obtenir des informations générales sur le contexte dans Visual Studio Code et Azure Data Studio, consultez Extensibilité.

Dans Azure Data Studio, nous avons un contexte spécifique pour les connexions de base de données disponibles pour les extensions.

tableau de bord

Dans le tableau de bord, nous fournissons les variables de contexte suivantes :