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 d’autres points d’extensibilité pour les 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 expérience d’action
• 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 d’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 de tableau de bord inline (à l’intérieur de l’onglet tableau de bord), vous pouvez inscrire des conteneurs à l’aide de dashboard.containers. Il accepte un objet ou un tableau d’objets.

"dashboard.containers": [
    {
        "id": "innerTab1",
        "widgets-container": [
            {
                "widget": {
                    "query-data-store-db-insight": {}
                }
            },
            {
                "widget": {
                    "explorer-widget": {}
                }
            }
        ]
    },
    {
        "id": "innerTab2",
        "webview-container": {}
    },
    {
        "id": "innerTab3",
        "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": {}
                },

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

"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": {
            "id": "innerTab1"
        }
    }
]

dashboard.insights

Vous pouvez enregistrer des insights à l’aide de dashboard.insights. Ceci est similaire à Tutoriel : Créer un widget d’insight personnalisé. Il accepte un objet ou un tableau d’objets.

"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 :

widgets-container

La liste de widgets qui sera affichée dans le conteneur est une disposition de flux qui accepte cette liste.

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

conteneur de WebView

Capture d’écran

La vue web s’affiche dans l’ensemble du conteneur. Il s’attend à ce que l’ID webview soit identique à l’ID d’onglet.

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

grid-container

Capture d’écran

Liste des widgets ou des vues web qui sont affichés dans la disposition de la grille. La mise en page en grille est un modèle 2x2 qui accepte cette liste.

"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
        }
    ]
}

nav-section

Capture d’écran

La section de navigation s’affiche dans le conteneur. Il attend un tableau d’objets.

"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 plus tard dans 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 :

Contenu connexe

• API d’extensibilité
• Télécharger Azure Data Studio