EFPosh

Entity Framework for PowerShell

This module exposes a lot of Entity Framework Core features through PowerShell! Now you can create and interact with databases without having to write any SQL!

Getting Started

Install the module with Install-Module EFPosh

Entity Framework works by taking existing classes and mapping them to databases. This works with any class, whether it be defined in PowerShell or a dll. To quickly get started with this module, define your classes in PowerShell:

Class TestTableOne {
    [string]$MyUniqueId
    [string]$Name
}

Class TestTableTwo {
    [int]$MyOtherUniqueId
    [string]$Name
}

Then build a Table array:

$Tables = @(
    ( New-EFPoshEntityDefinition -Type 'TestTableOne' -PrimaryKey 'MyUniqueId' ),
    ( New-EFPoshEntityDefinition -Type 'TestTableTwo' -PrimaryKey 'MyOtherUniqueId' )
)

Note: New-EFPoshEntityDefinition has a "Keyless" option. Keyless means there's no unique column. This will model the table/view but make it read-only. A key is required to write to the database. Keys default to a column named "Id" but can be defined with -PrimaryKey (which accepts an array of columns)

After building the table array, build your database context!

$DBFile = "$PSScriptRoot\bin\MyDatabase.sqlite"
$Context = New-EFPoshContext -ConnectionString $SQLiteConnectionString -DBType 'SQLite' -Entities $Tables -EnsureCreated

EnsureCreated will create the database if it does not exist, with the tables specified. If the database exists, it will not check to ensure the database columns have not changed. That is currently not supported. If your columns change, you have to create a new DB to get the new schema or update the schema yourself.

Now your $Context object lets you do a lot of normal Entity Framework actions!

You can add an object to the database:

$NewObject = [TestTableTwo]::new()
$NewObject.Name = 'MyTest'

Add-EFPoshEntity -Entity $NewObject -SaveChanges

You can query for existing objects:

Search-EFPosh -DbContext $Context -Entity TestTableTwo -Expression { $_.Name -eq 'MyTest' }

For simple querying with variables, all you have to do is:

Search-EFPosh -DbContext $Context -Entity TestTableTwo -Expression { $_.Name -eq $SearchFor }

There is another way to query if the above doesn't work. Sometimes we can't get the value of the variable, so if that happens use the -Arguments switch to provide it, and $0 for the variable!

$SearchFor = 'MyTest'
Search-EFPosh -DbContext $Context -Entity TestTableTwo -Expression { $_.Name -eq $0 } -Arguments @($SearchFor)

In the above example, use number variables representing the index in the Arguments array. So $0 corresponds to index 0 in Arguments, $1 corresponds to 1, etc.

You can easily edit objects in the database:

$Result = Search-EFPosh -DbContext $Context -Entity TestTableTwo -FirstOrDefault
$Result.Name = 'MyNewName'
Save-EFposhChanges -Context $Context

Please let me know if you have any issues!

Ryan2065/EFPosh

EFPosh

Entity Framework for PowerShell

Getting Started