PsSqlLocalDb

PsSqlLocalDb is a PowerShell module for managing SQL Server LocalDB instances through the SqlLocalDB utility.

Requirements

• Windows with SQL Server LocalDB installed.
• PowerShell 7.2 or later.

Installation

The module is available from the PowerShell Gallery:

Install-Module -Name PsSqlLocalDb

To build and install from source, clone the repository, install InvokeBuild, then run:

Invoke-Build Install

Usage

Import the module and check the installed LocalDB versions and instances:

Import-Module PsSqlLocalDb
Get-LocalDbVersion
Get-LocalDbInstance

See the command reference for all commands, parameters, and examples.

Changelog

See CHANGELOG.md.

Development

• This is a Portable Module.
• VSCode is recommended as IDE. VSCode Tasks are configured.
• Build automation is based on InvokeBuild
• Test automation is based on Pester
• Commands are named based on Approved Verbs for PowerShell Commands
• This project uses git-flow.
• This project uses keep a changelog.

Build

The build scripts require InvokeBuild. If it is not installed, install it with the command Install-Module InvokeBuild -Scope CurrentUser.

You can build the module using the VS Code build task or with the command Invoke-Build Build.

Release

1. Create a release branch using git-flow.
2. Update the version number in the module manifest.
3. Extend the changelog in CHANGELOG.md.
4. If you want to create a pre-release.
   1. Push the release branch to GitHub, to publish the pre-release to PsGallery.
5. Finish release using git-flow.
6. Check if tags are not pushed to GitHub.
7. Check if the release branch is deleted on GitHub.
8. Create the release on GitHub.