API pro Extensibility Framework pro SQL Server

platí pro: SQL Server 2019 (15.x) a novější verze

Rozšiřitelný framework můžete použít k psaní rozšíření programovacích jazyků pro SQL Server. API Extensibility Framework pro SQL Server je API, které může jazykové rozšíření využívat k interakci a výměně dat se SQL Server.

Jako autor jazykových rozšíření můžete tuto referenci použít spolu s open-source jazykovými rozšířeními, abyste pochopili, jak API použít pro psaní vlastního. Zdrojový kód jazykových rozšíření najdete na aka.ms/mssql-lang-extensions.

Informace o syntaxi a argumentech všech funkcí API najdete v tomto článku.

Návratová hodnota

Všechny funkce vracejí parametr.SQLRETURN Pokud je hodnota jiná než SQL_SUCCESS, je hodnota považována za chybu a spuštění skriptu se zastaví.

Standardní výstup

Jakýkoli výstup rozšíření do standardních výstupních nebo chybových proudů je sledován do logu relace a nakonec zpět do SQL Server. To je podobné všemu, co se zobrazuje na záložce zpráv SQL Server Management Studio (SSMS).

Init

Tato funkce se volá pouze jednou a používá se k inicializaci běhu pro vykonání.

Syntax

SQLRETURN Init(
    SQLCHAR *ExtensionParams,
    SQLULEN ExtensionParamsLength,
    SQLCHAR *ExtensionPath,
    SQLULEN ExtensionPathLength,
    SQLCHAR *PublicLibraryPath,
    SQLULEN PublicLibraryPathLength,
    SQLCHAR *PrivateLibraryPath,
    SQLULEN PrivateLibraryPathLength
);

Arguments

InitSession

Tato funkce se volá jednou za relaci a inicializuje se nastavení specifická pro relaci.

Syntax

SQLRETURN InitSession(
    SQLGUID         SessionId,
    SQLUSMALLINT    TaskId,
    SQLCHAR*        Script,
    SQLULEN         ScriptLength,
    SQLUSMALLINT    InputSchemaColumnsNumber,
    SQLUSMALLINT    ParametersNumber
    SQLCHAR*        InputDataName,
    SQLUSMALLINT    InputDataNameLength,
    SQLCHAR*        OutputDataName,
    SQLUSMALLINT    OutputDataNameLength
);

Arguments

InitColumn

Inicializujte informace pro daný sloupec pro konkrétní relaci.

Tato funkce se volá pro každý sloupec ve výsledné množině z @input_data_1v sp_execute_external_script.

Sloupcová struktura této výsledné množiny se nazývá vstupní schéma.

Syntax

SQLRETURN InitColumn(
    SQLGUID       SessionId,
    SQLUSMALLINT  TaskId,
    SQLUSMALLINT  ColumnNumber,
    SQLCHAR*      ColumnName,
    SQLSMALLINT   ColumnNameLength,
    SQLSMALLINT   DataType,
    SQLULEN       ColumnSize,
    SQLSMALLINT   DecimalDigits,
    SQLSMALLINT   Nullable,
    SQLSMALLINT   PartitionByNumber,
    SQLSMALLINT   OrderByNumber
);

Arguments

InitParam

Inicializujte informace týkající se daného vstupního parametru pro konkrétní relaci.

Tato funkce se volá pro každý parametr z @paramssp_execute_external_script.

Syntax

SQLRETURN InitParam(
    SQLGUID      SessionId,
    SQLUSMALLINT TaskId,
    SQLUSMALLINT ParamNumber,
    SQLCHAR*     ParamName,
    SQLSMALLINT  ParamNameLength,
    SQLSMALLINT  DataType,
    SQLULEN      ParamSize,
    SQLSMALLINT  DecimalDigits,
    SQLPOINTER   ParamValue,
    SQLINTEGER   StrLen_or_Ind,
    SQLSMALLINT  InputOutputType
);

Arguments

Execute

Vykonejte to @script v sp_execute_external_script.

Tato funkce může být volána vícekrát. Jednou pro každý steam chunk a pro každou partition v @input_data_1_partition_by_columnsin sp_execute_external_script.

Syntax

SQLRETURN Execute(
    SQLGUID         SessionId,
    SQLUSMALLINT    TaskId,
    SQLULEN         RowsNumber,
    SQLPOINTER*     Data,
    SQLINTEGER**    StrLen_or_Ind,
    SQLUSMALLINT*   OutputSchemaColumnsNumber
);

Arguments

GetResultColumn

Získejte informace o daném výstupním sloupci pro konkrétní relaci.

Tato funkce se volá pro každý sloupec ve výsledné množině z @scriptv sp_execute_external_script.

Sloupcová struktura této množiny výsledků se nazývá výstupní schéma.

Syntax

SQLRETURN GetResultColumn(
    SQLGUID         SessionId,
    SQLUSMALLINT    TaskId,
    SQLUSMALLINT    ColumnNumber,
    SQLSMALLINT*    DataType,
    SQLINTEGER*     ColumnSize,
    SQLSMALLINT*    DecimalDigits,
    SQLSMALLINT*    Nullable
);

Arguments

GetResults

Získejte množinu výsledků vykonáním @script v sp_execute_external_script.

Tato funkce může být volána vícekrát. Jednou pro každý steam chunk a pro každou partition v @input_data_1_partition_by_columnsin sp_execute_external_script.

Syntax

SQLRETURN GetResults(
    SQLGUID         SessionId,
    SQLUSMALLINT    TaskId,
    SQLULEN*        RowsNumber,
    SQLPOINTER**    Data,
    SQLINTEGER***   StrLen_or_Ind
);

Arguments

GetOutputParam

Získejte informace o daném výstupním parametru pro konkrétní relaci.

Tato funkce se volá pro každý parametr z @params v sp_execute_external_script označený .OUTPUT

Syntax

SQLRETURN GetOutputParam(
    SQLGUID        SessionId,
    SQLUSMALLINT   ParamNumber,
    SQLPOINTER*    ParamValue,
    SQLINTEGER*    StrLen_or_Ind
);

Arguments

GetInterfaceVersion

Získejte verzi rozhraní.

Tato funkce vrací celé číslo představující verzi rozhraní rozšíření.

Podporované hodnoty:

1. Verze 1 je počáteční verze API. Podporováno na SQL Server 2019 (15.x) RTM.
2. Verze 2 přidala podporu pro InstallExternalLibrary API UninstallExternalLibrary a je podporována od SQL Server 2019 (15.x) CU 3.

Syntax

SQLUSMALLINT GetInterfaceVersion();

CleanupSession

Ukliďte informace z jednotlivých sezení.

Syntax

SQLRETURN CleanupSession(
    SQLGUID        SessionId,
    SQLUSMALLINT   TaskId
);

Arguments

Cleanup

Vyčistit globální, sdílené informace (například JVM).

Syntax

SQLRETURN Cleanup();

GetTelemetryResults

Získává telemetrická data (páry klíč-hodnota) z rozšíření. Funkce je volitelná a nevyžaduje implementaci. Telemetrie je zpřístupněna dm_db_external_script_execution_stats dynamickým správcovým zobrazením (DMV).

Existuje čítač jménem script_executions, který posílá framework. Příponka by tento název používat neměla.

Každý záznam v telemetrii je pár klíč-hodnota. Klíče jsou struny. Hodnoty jsou 64bitová celá čísla, tedy čítače. Výstup tedy obsahuje dvě logická pole: názvy a jejich odpovídající čítače. Každé pole je výstupem.

Délka každého pole je , RowsNumbercož je výstup. První logický výstup obsahuje ukazatele na řetězce. Je reprezentován dvěma poli: CounterNames (skutečná data řetězce) a CounterNamesLength (délka každého řetězce). Druhý logický výstup je uložen v ukazateli CounterValues .

Syntax

SQLRETURN GetTelemetryResults(
    SQLGUID        SessionId,
    SQLUSMALLINT   TaskId,
    SQLUINTEGER    *RowsNumber,
    SQLCHAR        ***CounterNames,
    SQLINTEGER     **CounterNamesLength,
    SQLBIGINT      **CounterValues
);

Arguments

InstallExternalLibrary

Nainstaluje knihovnu. Funkce je volitelná a nevyžaduje implementaci. Výchozí implementace je zkopírovat obsah knihovny (viz CREATE EXTERNAL LIBRARY) do souboru na správném místě. Název souboru je název knihovny.

Syntax

SQLRETURN InstallExternalLibrary(
    SQLGUID    SetupSessionId,
    SQLCHAR    *LibraryName,
    SQLINTEGER LibraryNameLength,
    SQLCHAR    *LibraryFile,
    SQLINTEGER LibraryFileLength,
    SQLCHAR    *LibraryInstallDirectory,
    SQLINTEGER LibraryInstallDirectoryLength,
    SQLCHAR    **LibraryError,
    SQLINTEGER *LibraryErrorLength
);

Arguments

UninstallExternalLibrary

Odinstaluje knihovnu. Funkce je volitelná a nevyžaduje implementaci. Výchozí implementací je zrušit práci vykonanou výchozí implementací .InstallExternalLibrary Výchozí implementace maže obsah LibraryName souboru pod .LibraryInstallDirectory

Syntax

SQLRETURN UninstallExternalLibrary(
    SQLGUID    SetupSessionId,
    SQLCHAR    *LibraryName,
    SQLINTEGER LibraryNameLength,
    SQLCHAR    *LibraryInstallDirectory,
    SQLINTEGER LibraryInstallDirectoryLength,
    SQLCHAR    **LibraryError,
    SQLINTEGER *LibraryErrorLength
);

Arguments

Související obsah

• Microsoft Extensibility SDK pro Javu pro SQL Server
• Instalace vlastního modulu runtime Pythonu pro SQL Server
• Instalace vlastního modulu runtime R pro SQL Server