Rozšiřitelnost nástroje Azure Data Studio

Důležitý

Azure Data Studio se vyřazuje 28. února 2026. Doporučujeme, abyste používali Visual Studio Code. Další informace o migraci do editoru Visual Studio Code najdete v tématu Co se děje se sadou Azure Data Studio?

Azure Data Studio má několik mechanismů rozšiřitelnosti, které umožňují přizpůsobit uživatelské prostředí a zpřístupnit tato přizpůsobení celé komunitě uživatelů. Základní platforma Azure Data Studio je založená na editoru Visual Studio Code, takže je k dispozici většina rozhraní API rozšiřitelnosti editoru Visual Studio Code. Kromě toho jsme pro aktivity specifické pro správu dat poskytli další body rozšiřitelnosti.

Mezi klíčové body rozšiřitelnosti patří:

• Rozhraní API rozšiřitelnosti editoru Visual Studio Code
• Nástroje pro vytváření rozšíření Azure Data Studio
• Správa příspěvků na panelu karet řídicího panelu
• Poznatky s akční zkušeností
• Rozhraní API rozšiřitelnosti nástroje Azure Data Studio
• Vlastní rozhraní API pro Zprostředkovatel dat

Rozhraní API rozšiřitelnosti editoru Visual Studio Code

Vzhledem k tomu, že základní platforma Azure Data Studio je založená na editoru Visual Studio Code, najdete podrobnosti o rozhraních API pro rozšiřitelnost editoru Visual Studio Code v dokumentaci k rozhraní API pro vytváření a rozšíření rozšíření na webu editoru Visual Studio Code.

Poznámka:

Verze Azure Data Studio odpovídají aktuální verzi VS Code. Zahrnutý modul VS Code ale nemusí být aktuální verzí VS Code. Například v listopadu 2020 byl modul VS Code v Nástroji Azure Data Studio 1.48 a aktuální verze VS Code je 1.51. Chybová zpráva "Nelze nainstalovat rozšíření '<název>', jelikož není kompatibilní s verzí>VS Code <" při instalaci rozšíření je způsobena rozšířením, které má novější verzi modulu VS Code definovanou v manifestu balíčku (package.json). Verzi modulu VS Code můžete ověřit v nástroji Azure Data Studio pomocí nabídky Nápověda v části O produktu.

Správa příspěvků na panelu karet řídicího panelu

Podrobnosti najdete v tématu Body příspěvku a kontextové proměnné.

Rozhraní API rozšiřitelnosti nástroje Azure Data Studio

Podrobnosti najdete v tématu Rozhraní API rozšiřitelnosti.

Body příspěvků

Tato část se věnuje různým bodům příspěvků definovaným v manifestu rozšíření package.json.

IntelliSense se podporuje v azuredatastudio.

Body příspěvků na řídicím panelu

Přispívání na řídicí panel pomocí karty, kontejneru nebo widgetu přehledu

Nástěnka.záložky

Dashboard.tabs vytvoří oddíly karet na stránce řídicího panelu. Očekává objekt nebo pole objektů.

"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.kontejnery

Místo specifikace kontejneru pro řídicí panel přímo v rámci karty řídicího panelu můžete kontejnery zaregistrovat pomocí dashboard.containers. Přijímá objekt nebo pole objektů.

"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": {}
                },

Pokud chcete odkazovat na zaregistrovaný kontejner, zadejte ID kontejneru.

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

nástěnka.přehledy

Přehledy můžete zaregistrovat pomocí dashboard.insights. Podobá se Tutoriálu: Jak vytvořit vlastní přehledový widget. Přijímá objekt nebo pole objektů.

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

Typy kontejnerů řídicího panelu

Aktuálně existují čtyři podporované typy kontejnerů:

kontejner s widgety

Seznam widgetů, které se zobrazí v kontejneru, je rozložení toku, které přijímá tento seznam.

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

webview-container

snímek obrazovky

Webové zobrazení se zobrazí v celém kontejneru. Očekává, že ID webového zobrazení bude stejné jako ID karty.

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

mřížkový kontejner

Seznam widgetů nebo webových zobrazení, které se zobrazují v rozložení mřížky. Rozložení mřížky je rozložení mřížky 2x2, které přijímá tento seznam.

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

navigační oddíl

Navigační oddíl se zobrazí v kontejneru. Očekává pole objektů.

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

Kontextové proměnné

Obecné informace o kontextu v nástroji Visual Studio Code a novějším nástroji Azure Data Studio najdete v tématu Rozšiřitelnost.

V Nástroji Azure Data Studio máme konkrétní kontext týkající se připojení k databázi, která jsou k dispozici pro rozšíření.

Řídicí panel

Na řídicím panelu poskytujeme následující kontextové proměnné:

Kontextová proměnná	Popis
connectionProvider	Řetězec identifikátoru pro zprostředkovatele aktuálního připojení. Příklad: connectionProvider == 'MSSQL'.
serverName	Řetězec názvu serveru aktuálního připojení. Příklad: serverName == 'localhost'.
databaseName	Řetězec názvu databáze aktuálního připojení. Příklad: databaseName == 'master'.
connection	Úplný objekt profilu připojení pro aktuální připojení (IConnectionProfile)
dashboardContext	Řetězec kontextu stránky, na které je řídicí panel aktuálně zapnutý. Buď "databáze" nebo "server". Příklad: dashboardContext == 'database'

Související obsah

• Rozšiřitelnostní API
• Stažení Azure Data Studio