Megosztás a következőn keresztül:


Az Azure Data Studio bővíthetősége

Fontos

Az Azure Data Studio 2026. február 28-ánmegszűnik. Javasoljuk, hogy használja Visual Studio Code. További információért a Visual Studio Code-ba való áttérésről, látogasson el ide: Mi történik az Azure Data Studióval?

Az Azure Data Studio számos bővíthetőségi mechanizmussal rendelkezik, amelyekkel testre szabhatja a felhasználói élményt, és elérhetővé teheti ezeket a testreszabásokat a teljes felhasználói közösség számára. Az Azure Data Studio alapplatformja a Visual Studio Code-ra épül, így a Visual Studio Code bővíthetőségi API-k többsége elérhető. Emellett további bővíthetőségi pontokat is biztosítottunk az adatkezeléssel kapcsolatos tevékenységekhez.

Néhány fontos bővíthetőségi pont:

  • Visual Studio Code bővíthetőségi API-k
  • Azure Data Studio-bővítménykészítő eszközök
  • Irányítópult lapjának hozzájárulásainak kezelése
  • Elemzések műveletekkel
  • Azure Data Studio bővíthetőségi API-k
  • Egyéni adatszolgáltatói API-k

Visual Studio Code bővíthetőségi API-k

Mivel az alapvető Azure Data Studio platform a Visual Studio Code-ra épül, a Visual Studio Code bővíthetőségi API-ival kapcsolatos részletek a Visual Studio Code webhelyén található Bővítménykészítő és Bővítmény API dokumentációjában találhatók.

Feljegyzés

Az Azure Data Studio kiadásai a VS Code legújabb verziójához igazodnak. Előfordulhat azonban, hogy a mellékelt VS Code-motor nem az aktuális VS Code-kiadás. 2020 novemberében például az Azure Data Studio VS Code motorja 1.48-at, a VS Code jelenlegi verziója pedig 1.51 volt. A bővítmény telepítésekor a "Nem lehet telepíteni a bővítményt "<név>" hibaüzenetet, mivel nem kompatibilis a VS Code <>verzióval" hibaüzenetet egy olyan bővítmény okozza, amely a csomagjegyzékben (package.json) definiált későbbi VS Code-motorverzióval rendelkezik. A VS Code-motor verzióját az Azure Data Studióban a Súgó menüBen ellenőrizheti a Névjegy csoportban.

Irányítópult lapjának hozzájárulásainak kezelése

További részletekért lásd a közreműködői pontokat és a környezeti változókat.

Azure Data Studio bővíthetőségi API-k

További részletekért lásd : Bővíthetőségi API-k.

Hozzájárulási pontok

Ez a szakasz a package.json bővítményjegyzékben meghatározott különböző hozzájárulási pontokat ismerteti.

Az IntelliSense az Azuredatastudio-ban támogatott.

Irányítópult-hozzájárulási pontok

Adjon hozzá egy lap-, tároló- és/vagy elemzési vezérlőt az irányítópulthoz.

képernyőkép az irányítópultról.

dashboard.tabs

Az Dashboard.tabs az irányítópult lapon belül hozza létre a lapszakaszokat. Objektumot vagy objektumtömböt vár.

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

irányítópult.konténerek

Az irányítópult-tároló beágyazott megadása helyett (az irányítópult lapon belül) regisztrálhat tárolókat az dashboard.containers használatával. Objektumot vagy objektumtömböt fogad el.

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

A regisztrált tárolóra való hivatkozáshoz adja meg a tároló azonosítóját.

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

irányítópult.elemzések

Az elemzéseket a dashboard.insights használatával regisztrálhatja. Ez hasonló a oktatóanyaghoz: Testreszabott elemző widget létrehozása. Objektumot vagy objektumtömböt fogad el.

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

Irányítópult-tárolótípusok

Jelenleg négy támogatott tárolótípus létezik:

widgetek tárolója

Widgets-tároló képernyőképe.

A tárolóban megjelenő vezérlők listája egy folyamatelrendezés, amely elfogadja ezt a listát.

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

webview-container

A Webview-tároló képernyőképe

A webnézet a teljes tárolóban jelenik meg. Elvárja, hogy a webnézet azonosítója megegyezik a tabulátorazonosítóval.

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

rácstároló

A rácsos tároló képernyőképe

A rácselrendezésben megjelenő widgetek vagy webnézetek listája. A rácselrendezés egy 2x2 rácsos elrendezés, amely elfogadja ezt a listát.

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

Képernyőkép a Navigációs szakasz képernyőről

A navigációs szakasz megjelenik a tárolóban. Az [rendszer] egy objektumtömböt vár.

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

Környezeti változók

A Visual Studio Code és az Azure Data Studio környezetével kapcsolatos általános információkért tekintse meg Bővíthetőségcímű témakört.

Az Azure Data Studióban konkrét kontextusban érhetők el a bővítményekhez elérhető adatbázis-kapcsolatok.

Irányítópult

Az irányítópulton a következő környezeti változókat biztosítjuk:

KonteXtus változó Leírás
connectionProvider Az aktuális kapcsolat szolgáltatójának azonosítójának sztringje. Pl. connectionProvider == 'MSSQL'.
serverName Az aktuális kapcsolat kiszolgálónevének sztringje. Pl. serverName == 'localhost'.
databaseName Az aktuális kapcsolat adatbázisnevének sztringje. Pl. databaseName == 'master'.
connection Az aktuális kapcsolat teljes kapcsolatprofil-objektuma (IConnectionProfile)
dashboardContext Az irányítópult aktuális környezetének sztringje. Vagy "adatbázis" vagy "kiszolgáló". Pl. dashboardContext == 'database'