Dela via

Skapa en Windows PowerShell Container Provider

Detta ämne beskriver hur man skapar en Windows PowerShell-leverantör som kan arbeta med flerskiktsdatabaser. För denna typ av datalagring innehåller den övre nivån i lagret rotobjekten och varje efterföljande nivå kallas en nod av barnobjekt. Genom att låta användaren arbeta på dessa barnnoder kan användaren interagera hierarkiskt genom datalagret.

Leverantörer som kan arbeta med flernivådatalagringar kallas Windows PowerShell-containerleverantörer. Var dock medveten om att en Windows PowerShell-containerleverantör endast kan användas när det finns en container (inga nästlade containrar) med objekt i. Om det finns nästlade containrar måste du implementera en Windows PowerShell-navigationsleverantör. För mer information om implementering av Windows PowerShell-navigationsleverantör, se Skapa en Windows PowerShell-navigationsleverantör.

Anmärkning

Du kan ladda ner C#-källfilen (AccessDBSampleProvider04.cs) för denna leverantör med Microsoft Windows Software Development Kit för Windows Vista och .NET Framework 3.0 Runtime Components. För nedladdningsinstruktioner, se Hur man installerar Windows PowerShell och laddar ner Windows PowerShell SDK. De nedladdade källfilerna finns tillgängliga i <PowerShell Samples-katalogen> . För mer information om andra implementeringar av Windows PowerShell-leverantörer, se Designing Your Windows PowerShell Provider.

Windows PowerShell-containerleverantören som beskrivs här definierar databasen som sin enda container, där tabellerna och raderna i databasen definieras som objekt i containern.

Försiktighet

Var medveten om att denna design förutsätter en databas som har ett fält med namn-ID, och att fältets typ är LongInteger.

Definiera en Windows PowerShell Container Provider-klass

En Windows PowerShell-containerleverantör måste definiera en .NET-klass som härstammar från basklassen System.Management.Automation.Provider.ContainerCmdletProvider . Här är klassdefinitionen för Windows PowerShell-containerleverantören som beskrivs i detta avsnitt.

[CmdletProvider("AccessDB", ProviderCapabilities.None)]
public class AccessDBProvider : ContainerCmdletProvider

Observera att i denna klassdefinition innehåller attributet System.Management.Automation.Provider.CmdletProviderAttribute två parametrar. Den första parametern specificerar ett användarvänligt namn för leverantören som används av Windows PowerShell. Den andra parametern specificerar de Windows PowerShell-specifika funktioner som leverantören exponerar för Windows PowerShell-runtime under kommandobearbetningen. För denna leverantör finns inga Windows PowerShell-specifika funktioner som lagts till.

Definiera basfunktionalitet

Som beskrivs i Designing Your Windows PowerShell Provider härstammar klassen System.Management.Automation.Provider.ContainerCmdletProvider från flera andra klasser som erbjöd olika leverantörsfunktionalitet. En Windows PowerShell-containerleverantör måste därför definiera all funktionalitet som tillhandahålls av dessa klasser.

För att implementera funktionalitet för att lägga till sessionsspecifik initialiseringsinformation och för att släppa resurser som används av leverantören, se Skapa en grundläggande Windows PowerShell-leverantör. De flesta leverantörer (inklusive den som beskrivs här) kan dock använda standardimplementeringen av denna funktionalitet som tillhandahålls av Windows PowerShell.

För att få tillgång till datalagret måste leverantören implementera metoderna i Basklassen System.Management.Automation.Provider.DriveCmdletProvider . För mer information om hur man implementerar dessa metoder, se Skapa en Windows PowerShell Drive Provider.

För att manipulera objekten i en datalagring, såsom att hämta, sätta och rensa objekt, måste leverantören implementera metoderna som tillhandahålls av Basklassen System.Management.Automation.Provider.ItemCmdletProvider . För mer information om hur man implementerar dessa metoder, se Skapa en Windows PowerShell Item Provider.

Hämta barnföremål

För att hämta ett barnobjekt måste Windows PowerShell-containerleverantören åsidosätta System.Management.Automation.Provider.ContainerCmdletProvider.GetChildItems* för att stödja anrop från Get-ChildItem cmdleten. Denna metod hämtar barnobjekt från datalagringen och skriver dem till pipelinen som objekt. Om parametern recurse för cmdleten specificeras, hämtar metoden alla barn oavsett vilken nivå de befinner sig på. Om parametern recurse inte specificeras, hämtar metoden endast en enda nivå av barn.

Här är implementeringen av System.Management.Automation.Provider.ContainerCmdletProvider.GetChildItems* för denna leverantör. Observera att denna metod hämtar barnobjekten i alla databastabeller när vägen anger Access-databasen, och hämtar barnelementen från raderna i den tabellen om sökvägen indikerar en datatabell.

protected override void GetChildItems(string path, bool recurse)
{
    // If path represented is a drive then the children in the path are 
    // tables. Hence all tables in the drive represented will have to be
    // returned
    if (PathIsDrive(path))
    {
        foreach (DatabaseTableInfo table in GetTables())
        {
            WriteItemObject(table, path, true);

            // if the specified item exists and recurse has been set then 
            // all child items within it have to be obtained as well
            if (ItemExists(path) && recurse)
            {
                GetChildItems(path + pathSeparator + table.Name, recurse);
            }
        } // foreach (DatabaseTableInfo...
    } // if (PathIsDrive...
    else
    {
        // Get the table name, row number and type of path from the
        // path specified
        string tableName;
        int rowNumber;

        PathType type = GetNamesFromPath(path, out tableName, out rowNumber);

        if (type == PathType.Table)
        {
            // Obtain all the rows within the table
            foreach (DatabaseRowInfo row in GetRows(tableName))
            {
                WriteItemObject(row, path + pathSeparator + row.RowNumber,
                        false);
            } // foreach (DatabaseRowInfo...
        }
        else if (type == PathType.Row)
        {
            // In this case the user has directly specified a row, hence
            // just give that particular row
            DatabaseRowInfo row = GetRow(tableName, rowNumber);
            WriteItemObject(row, path + pathSeparator + row.RowNumber,
                        false);
        }
        else
        {
            // In this case, the path specified is not valid
            ThrowTerminatingInvalidPathException(path);
        }
    } // else
} // GetChildItems

Saker att komma ihåg när man implementerar GetChildItems

Följande villkor kan gälla för din implementation av System.Management.Automation.Provider.ContainerCmdletProvider.GetChildItems*:

Att fästa dynamiska parametrar till Get-ChildItem cmdleten

Ibland kräver cmdleten som anropar Get-ChildItemSystem.Management.Automation.Provider.ContainerCmdletProvider.GetChildItems* ytterligare parametrar som specificeras dynamiskt vid körning. För att tillhandahålla dessa dynamiska parametrar måste Windows PowerShell-containerleverantören implementera metoden System.Management.Automation.Provider.ContainerCmdletProvider.GetChildItemsDynamicParameters* . Denna metod hämtar dynamiska parametrar för objektet vid den angivna sökvägen och returnerar ett objekt som har egenskaper och fält med parsingattribut liknande en cmdlet-klass eller ett System.Management.Automation.RuntimeDefinedParameterDictionary-objekt . Windows PowerShell-runtime använder det returnerade objektet för att lägga till parametrarna i Get-ChildItem cmdleten.

Denna Windows PowerShell-containerleverantör implementerar inte denna metod. Följande kod är dock standardimplementeringen av denna metod.

Hämta namn på barnobjekt

För att hämta namnen på barnobjekt måste Windows PowerShell-containerleverantören åsidosätta System.Management.Automation.Provider.ContainerCmdletProvider.GetChildNames för att stödja anrop från cmdleten Get-ChildItem när dess Name parameter specificeras. Denna metod hämtar namnen på barnobjekten för den angivna sökvägen eller barn-objektnamn för alla behållare om parametern returnAllContainers för cmdleten är specificerad. Ett barnnamn är bladdelen av en stig. Till exempel är barnnamnet för sökvägen C:\windows\system32\abc.dll "abc.dll". Barnnamnet för katalogen C:\windows\system32 är "system32".

Här är implementeringen av System.Management.Automation.Provider.ContainerCmdletProvider.GetChildNames* för denna leverantör. Observera att metoden hämtar tabellnamn om den angivna sökvägen anger Access-databasen (disken) och radnummer om vägen anger en tabell.

protected override void GetChildNames(string path,
                              ReturnContainers returnContainers)
{
    // If the path represented is a drive, then the child items are
    // tables. get the names of all the tables in the drive.
    if (PathIsDrive(path))
    {
        foreach (DatabaseTableInfo table in GetTables())
        {
            WriteItemObject(table.Name, path, true);
        } // foreach (DatabaseTableInfo...
    } // if (PathIsDrive...
    else
    {
        // Get type, table name and row number from path specified
        string tableName;
        int rowNumber;

        PathType type = GetNamesFromPath(path, out tableName, out rowNumber);

        if (type == PathType.Table)
        {
            // Get all the rows in the table and then write out the 
            // row numbers.
            foreach (DatabaseRowInfo row in GetRows(tableName))
            {
                WriteItemObject(row.RowNumber, path, false);
            } // foreach (DatabaseRowInfo...
        }
        else if (type == PathType.Row)
        {
            // In this case the user has directly specified a row, hence
            // just give that particular row
            DatabaseRowInfo row = GetRow(tableName, rowNumber);

            WriteItemObject(row.RowNumber, path, false);
        }
        else
        {
            ThrowTerminatingInvalidPathException(path);
        }
    } // else
} // GetChildNames

Saker att komma ihåg när du implementerar GetChildNames

Följande villkor kan gälla för din implementation av System.Management.Automation.Provider.ContainerCmdletProvider.GetChildItems*:

Att fästa dynamiska parametrar till Get-ChildItem cmdlet (namn)

Ibland kräver cmdleten Get-ChildItem (med parametern Name ) ytterligare parametrar som specificeras dynamiskt vid körning. För att tillhandahålla dessa dynamiska parametrar måste Windows PowerShell-containerleverantören implementera System.Management.Automation.Provider.ContainerCmdletProvider.GetChildNamesDynamicParameters* -metoden. Denna metod hämtar de dynamiska parametrarna för objektet vid den angivna sökvägen och returnerar ett objekt som har egenskaper och fält med parsningsattribut liknande en cmdlet-klass eller ett System.Management.Automation.RuntimeDefinedParameterDictionary-objekt . Windows PowerShell-runtime använder det returnerade objektet för att lägga till parametrarna i Get-ChildItem cmdleten.

Denna leverantör implementerar inte denna metod. Följande kod är dock standardimplementeringen av denna metod.

Namnbyte av föremål

För att byta namn på ett objekt måste en Windows PowerShell-containerleverantör åsidosätta metoden System.Management.Automation.Provider.ContainerCmdletProvider.RenameItem* för att stödja anrop från Rename-Item cmdleten. Denna metod ändrar namnet på objektet på den angivna vägen till det nya namnet som angavs. Det nya namnet måste alltid vara relativt till föräldraobjektet (containern).

Denna leverantör åsidosätter inte System.Management.Automation.Provider.ContainerCmdletProvider.RenameItem* -metoden. Följande är dock standardimplementeringen.

Saker att komma ihåg när du implementerar RenameItem

Följande villkor kan gälla för din implementation av System.Management.Automation.Provider.ContainerCmdletProvider.RenameItem*:

Att fästa dynamiska parametrar till Rename-Item cmdleten

Ibland kräver cmdleten Rename-Item ytterligare parametrar som specificeras dynamiskt vid körning. För att tillhandahålla dessa dynamiska parametrar måste Windows PowerShell-containerleverantören implementera System.Management.Automation.Provider.ContainerCmdletProvider.RenameItemDynamicParameters* -metoden. Denna metod hämtar parametrarna för objektet på den angivna vägen och returnerar ett objekt som har egenskaper och fält med parsingattribut liknande en cmdlet-klass eller ett System.Management.Automation.RuntimeDefinedParameterDictionary-objekt . Windows PowerShell-runtime använder det returnerade objektet för att lägga till parametrarna i Rename-Item cmdleten.

Denna containerleverantör implementerar inte denna metod. Följande kod är dock standardimplementeringen av denna metod.

Skapa nya föremål

För att skapa nya objekt måste en containerleverantör implementera metoden System.Management.Automation.Provider.ContainerCmdletProvider.NewItem* för att stödja anrop från New-Item cmdleten. Denna metod skapar ett dataobjekt som är placerat vid den angivna sökvägen. Parametern type för cmdleten innehåller den leverantörsdefinierade typen för det nya objektet. Till exempel använder Filsystemleverantören en type parameter med värdet "fil" eller "katalog". Parametern newItemValue i cmdleten specificerar ett leverantörsspecifikt värde för det nya objektet.

Här är implementeringen av System.Management.Automation.Provider.ContainerCmdletProvider.NewItem* för denna leverantör.

protected override void NewItem( string path, string type, object newItemValue )
{
    // Create the new item here after
    // performing necessary validations
    //
    // WriteItemObject(newItemValue, path, false);

    // Example
    //
    // if (ShouldProcess(path, "new item"))
    // {
    //      // Create a new item and then call WriteObject
    //      WriteObject(newItemValue, path, false);
    // }

} // NewItem

{
    case 1:
        {
            string name = pathChunks[0];

            if (TableNameIsValid(name))
            {
                tableName = name;
                retVal = PathType.Table;
            }
        }
        break;

    case 2:
        {
            string name = pathChunks[0];

Saker att komma ihåg när du implementerar NewItem

Följande villkor kan gälla för din implementation av System.Management.Automation.Provider.ContainerCmdletProvider.NewItem*:

Att fästa dynamiska parametrar till New-Item cmdleten

Ibland kräver cmdleten New-Item ytterligare parametrar som specificeras dynamiskt vid körning. För att tillhandahålla dessa dynamiska parametrar måste containerleverantören implementera metoden System.Management.Automation.Provider.ContainerCmdletProvider.NewItemDynamicParameters* . Denna metod hämtar parametrarna för objektet på den angivna vägen och returnerar ett objekt som har egenskaper och fält med parsingattribut liknande en cmdlet-klass eller ett System.Management.Automation.RuntimeDefinedParameterDictionary-objekt . Windows PowerShell-runtime använder det returnerade objektet för att lägga till parametrarna i New-Item cmdleten.

Denna leverantör implementerar inte denna metod. Följande kod är dock standardimplementeringen av denna metod.

Borttagning av föremål

För att ta bort element måste Windows PowerShell-leverantören åsidosätta metoden System.Management.Automation.Provider.ContainerCmdletProvider.RemoveItem* för att stödja anrop från Remove-Item cmdleten. Denna metod raderar ett objekt från datalagringen på den angivna vägen. Om parametern recurse för cmdleten Remove-Item sätts till true, tar metoden bort alla barnobjekt oavsett deras nivå. Om parametern är satt till false, tar metoden bort endast ett enda element på den angivna vägen.

Denna leverantör stödjer inte borttagning av föremål. Följande kod är dock standardimplementeringen av System.Management.Automation.Provider.ContainerCmdletProvider.RemoveItem*.

Saker att komma ihåg när man implementerar RemoveItem

Följande villkor kan gälla för din implementation av System.Management.Automation.Provider.ContainerCmdletProvider.NewItem*:

Att fästa dynamiska parametrar till Remove-Item cmdleten

Ibland kräver cmdleten Remove-Item ytterligare parametrar som specificeras dynamiskt vid körning. För att tillhandahålla dessa dynamiska parametrar måste containerleverantören implementera metoden System.Management.Automation.Provider.ContainerCmdletProvider.RemoveItemDynamicParameters* för att hantera dessa parametrar. Denna metod hämtar de dynamiska parametrarna för objektet vid den angivna sökvägen och returnerar ett objekt som har egenskaper och fält med parsningsattribut liknande en cmdlet-klass eller ett System.Management.Automation.RuntimeDefinedParameterDictionary-objekt . Windows PowerShell-runtime använder det returnerade objektet för att lägga till parametrarna i Remove-Item cmdleten.

Denna containerleverantör implementerar inte denna metod. Följande kod är dock standardimplementeringen av System.Management.Automation.Provider.ContainerCmdletProvider.RemoveItemDynamicParameters*.

Sökning efter barnobjekt

För att kontrollera om barnobjekt finns på den angivna sökvägen måste Windows PowerShell-containerleverantören åsidosätta System.Management.Automation.Provider.ContainerCmdletProvider.HasChildItems* -metoden. Denna metod returnerar true om objektet har barn, och false annars. För en null- eller tom väg betraktar metoden alla objekt i datalagringen som barn och returnerar true.

Här är överskrivningen för metoden System.Management.Automation.Provider.ContainerCmdletProvider.HasChildItems* . Om det finns fler än två vägdelar skapade av ChunkPath-hjälpmetoden, returnerar falsemetoden , eftersom endast en databascontainer och en tabellcontainer är definierade. För mer information om denna hjälpmetod, se ChunkPath-metoden som diskuteras i Creating a Windows PowerShell Item Provider.

protected override bool HasChildItems( string path )
{
    return false;
} // HasChildItems

        ErrorCategory.InvalidOperation, tableName));
}

return results;

Saker att komma ihåg när du implementerar HasChildItems

Följande villkor kan gälla för din implementation av System.Management.Automation.Provider.ContainerCmdletProvider.HasChildItems*:

Kopiering av föremål

För att kopiera objekt måste containerleverantören implementera metoden System.Management.Automation.Provider.ContainerCmdletProvider.CopyItem för att stödja anrop från Copy-Item cmdleten. Denna metod kopierar ett dataobjekt från platsen som anges av path cmdlet-parametern till platsen som parametern copyPath angav. Om parametern recurse anges kopierar metoden alla delbehållare. Om parametern inte anges kopierar metoden endast en enda nivå av objekt.

Denna leverantör implementerar inte denna metod. Följande kod är dock standardimplementeringen av System.Management.Automation.Provider.ContainerCmdletProvider.CopyItem.

Saker att komma ihåg när man implementerar CopyItem

Följande villkor kan gälla för din implementation av System.Management.Automation.Provider.ContainerCmdletProvider.CopyItem:

Att fästa dynamiska parametrar till Copy-Item cmdleten

Ibland kräver cmdleten Copy-Item ytterligare parametrar som specificeras dynamiskt vid körning. För att tillhandahålla dessa dynamiska parametrar måste Windows PowerShell-containerleverantören implementera metoden System.Management.Automation.Provider.ContainerCmdletProvider.CopyItemDynamicParameters* för att hantera dessa parametrar. Denna metod hämtar parametrarna för objektet på den angivna vägen och returnerar ett objekt som har egenskaper och fält med parsingattribut liknande en cmdlet-klass eller ett System.Management.Automation.RuntimeDefinedParameterDictionary-objekt . Windows PowerShell-runtime använder det returnerade objektet för att lägga till parametrarna i Copy-Item cmdleten.

Denna leverantör implementerar inte denna metod. Följande kod är dock standardimplementeringen av System.Management.Automation.Provider.ContainerCmdletProvider.CopyItemDynamicParameters*.

Kodexempel

För komplett exempelkod, se AccessDbProviderSample04 kodexempel.

Bygga Windows PowerShell-leverantören

Se hur du registrerar cmdlets, leverantörer och värdapplikationer.

Testning av Windows PowerShell-leverantören

När din Windows PowerShell-leverantör har registrerats hos Windows PowerShell kan du testa det genom att köra de stödda cmdletarna på kommandoraden. Var medveten om att följande exempelutdata använder en fiktiv Access-databas.

  1. Kör cmdleten Get-ChildItem för att hämta listan över barnobjekt från en Kunder-tabell i Access-databasen.

    Get-ChildItem mydb:customers

    Följande utdata syns.

    PSPath        : AccessDB::customers
PSDrive       : mydb
PSProvider    : System.Management.Automation.ProviderInfo
PSIsContainer : True
Data          : System.Data.DataRow
Name          : Customers
RowCount      : 91
Columns       :

  2. Kör cmdleten Get-ChildItem igen för att hämta data från en tabell.

    (Get-ChildItem mydb:customers).Data

    Följande utdata syns.

    TABLE_CAT   : C:\PS\northwind
TABLE_SCHEM :
TABLE_NAME  : Customers
TABLE_TYPE  : TABLE
REMARKS     :

  3. Använd nu cmdleten Get-Item för att hämta objekten på rad 0 i datatabellen.

    Get-Item mydb:\customers\0

    Följande utdata syns.

    PSPath        : AccessDB::customers\0
PSDrive       : mydb
PSProvider    : System.Management.Automation.ProviderInfo
PSIsContainer : False
Data          : System.Data.DataRow
RowNumber     : 0

  4. Återanvänd Get-Item för att hämta data för objekten i rad 0.

    (Get-Item mydb:\customers\0).Data

    Följande utdata syns.

    CustomerID   : 1234
CompanyName  : Fabrikam
ContactName  : Eric Gruber
ContactTitle : President
Address      : 4567 Main Street
City         : Buffalo
Region       : NY
PostalCode   : 98052
Country      : USA
Phone        : (425) 555-0100
Fax          : (425) 555-0101

  5. Använd nu cmdleten New-Item för att lägga till en rad i en befintlig tabell. Parametern Path specificerar hela vägen till raden och måste ange ett radnummer som är större än det befintliga antalet rader i tabellen. Parametern Type anger Row att ange vilken typ av objekt som ska läggas till. Slutligen specificerar parametern Value en kommaavgränsad lista av kolumnvärden för raden.

    New-Item -Path mydb:\Customers\3 -ItemType "Row" -Value "3,CustomerFirstName,CustomerLastName,CustomerEmailAddress,CustomerTitle,CustomerCompany,CustomerPhone, CustomerAddress,CustomerCity,CustomerState,CustomerZip,CustomerCountry"

  6. Verifiera att den nya artikeloperationen är korrekt enligt följande.

    PS mydb:\> cd Customers
PS mydb:\Customers> (Get-Item 3).Data

    Följande utdata syns.

    ID        : 3
FirstName : Eric
LastName  : Gruber
Email     : ericgruber@fabrikam.com
Title     : President
Company   : Fabrikam
WorkPhone : (425) 555-0100
Address   : 4567 Main Street
City      : Buffalo
State     : NY
Zip       : 98052
Country   : USA

Se även

Skapa Windows PowerShell-leverantörer

Designa din Windows PowerShell-leverantör

Implementering av en PowerShell-leverantör för Item Windows

Implementering av en Navigation Windows PowerShell-leverantör

Hur man registrerar cmdlets, leverantörer och värdapplikationer

Windows PowerShell SDK

Windows PowerShell Programmerarguide

  • Last updated on