Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abbgrade/PsSmo
The PowerShell SQL Client module replaces the SQL Server utilities SQLCMD with native PowerShell commands.
https://github.com/abbgrade/PsSmo
automation azure-sql powershell sql-server sqlcmd
Last synced: 3 months ago
JSON representation
The PowerShell SQL Client module replaces the SQL Server utilities SQLCMD with native PowerShell commands.
- Host: GitHub
- URL: https://github.com/abbgrade/PsSmo
- Owner: abbgrade
- License: mit
- Created: 2021-09-12T14:21:36.000Z (about 3 years ago)
- Default Branch: develop
- Last Pushed: 2024-01-30T15:16:26.000Z (9 months ago)
- Last Synced: 2024-05-18T06:35:07.064Z (6 months ago)
- Topics: automation, azure-sql, powershell, sql-server, sqlcmd
- Language: PowerShell
- Homepage:
- Size: 95.7 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: Readme.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - abbgrade/PsSmo - The PowerShell SQL Client module replaces the SQL Server utilities SQLCMD with native PowerShell commands. (PowerShell)
README
# PsSmo
The PowerShell SQL Client module replaces the SQL Server utilities [SQLCMD](https://docs.microsoft.com/de-de/sql/tools/sqlcmd-utility) with native PowerShell commands.
## Installation
This module can be installed from [PsGallery](https://www.powershellgallery.com/packages/PsSmo).
```powershell
Install-Module -Name PsSmo -Scope CurrentUser
```
Alternatively it can be build and installed from source.
1. Install the development dependencies
2. Download or clone it from GitHub
3. Run the installation task:
```powershell
Invoke-Build Install
```
## Usage
TODO
Execute SQLCMD scripts like those created by [DacFX](https://github.com/microsoft/DacFx).
### Commands
| Command | Description | Status |
| ------------------------------- | --------------------------------------- | ------- |
| Connect-Instance | Create a new database connection. | ☑ |
| Disconnect-Instance | Close connection | ☑ |
| Invoke-Command | Execute SQLCMD scripts | ☐ |
| ⮱ Batch support | Support `GO` statements | ☑ |
| ⮱ File support | Script source from file | ☑ |
| ⮱ Variable support | Support variables like `$(variable)` | ☑ |
| ⮱ :setvar support | Support `:setvar` | ☑ |
| ⮱ SQLCMD command support | Support SQLCMD commans like `:on error` | ☐ |
| Uninstall-Schema | Remove a database schema recursively | ☐ |
## Changelog
See the [changelog](./CHANGELOG.md) file.
## Development
- This is a [Portable Module](https://docs.microsoft.com/de-de/powershell/scripting/dev-cross-plat/writing-portable-modules?view=powershell-7) based on [PowerShell Standard](https://github.com/powershell/powershellstandard) and [.NET Standard](https://docs.microsoft.com/en-us/dotnet/standard/net-standard).
- [VSCode](https://code.visualstudio.com) is recommended as IDE. [VSCode Tasks](https://code.visualstudio.com/docs/editor/tasks) are configured.
- Build automation is based on [InvokeBuild](https://github.com/nightroman/Invoke-Build)
- Test automation is based on [Pester](https://pester.dev)
- Commands are named based on [Approved Verbs for PowerShell Commands](https://docs.microsoft.com/de-de/powershell/scripting/developer/cmdlet/approved-verbs-for-windows-powershell-commands)
- This project uses [git-flow](https://github.com/nvie/gitflow).
- This project uses [keep a changelog](https://keepachangelog.com/en/1.0.0/).
- This project uses [PsBuildTasks](https://github.com/abbgrade/PsBuildTasks).
### Status
[](https://github.com/abbgrade/PsSmo/actions/workflows/build-validation.yml)
### 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`.
### Testing
The tests scripts are based on Pester. If it is not installed, install it with the command `Install-Module -Name Pester -Force -SkipPublisherCheck`. Some tests require a SQL Server. The test creates a SQL Server in a Docker container. If needed, [install Docker](https://www.docker.com/get-started). The container are created using PSDocker, which can be installed using `Install-Module PSDocker -Scope CurrentUser`.
For local testing use the VSCode test tasks or execute the test scripts directly or with `Invoke-Pester`.
The InvokeBuild test tasks are for CI and do not generate console output.
### Release
1. Create a release branch using git-flow.
2. Update the version number in the module manifest.
3. Extend the changelog in this readme.
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.