https://github.com/DBTrenches/SQLChecks

Helper functions and tests for SQL Server
https://github.com/DBTrenches/SQLChecks

sqlserver

Last synced: 5 months ago
JSON representation

Helper functions and tests for SQL Server

• Host: GitHub
• URL: https://github.com/DBTrenches/SQLChecks
• Owner: DBTrenches
• License: mit
• Created: 2020-02-24T20:02:26.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-12-22T12:03:43.000Z (over 1 year ago)
• Last Synced: 2024-08-13T07:05:33.276Z (8 months ago)
• Topics: sqlserver
• Language: PowerShell
• Homepage:
• Size: 521 KB
• Stars: 3
• Watchers: 5
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - DBTrenches/SQLChecks - Helper functions and tests for SQL Server (PowerShell)

README

        
# SQLChecks

[![Build Status](https://img.shields.io/appveyor/ci/taddison/SQLChecks.svg)](https://ci.appveyor.com/project/taddison/sqlchecks)

[![Test Status](https://img.shields.io/appveyor/tests/taddison/SQLChecks.svg)](https://ci.appveyor.com/project/taddison/sqlchecks/build/tests)

Helper functions and tests for SQL Server.

Requires the `SqlServer`, `Pester`, and `OMSIngestionAPI` modules.

For more information refer to [the documentation](./docs/Readme.md).

## Example Usage

First of all import the module.

```powershell

Import-Module .\src\SQLChecks -Force

```

And then pass a configuration file to `Invoke-SqlChecks`.

```powershell

Invoke-SqlChecks -ConfigPath .\examples\simple\localhost.config.json

```

You can also test a single item based on its tag.

```powershell

Invoke-SqlChecks -ConfigPath .\examples\simple\localhost.config.json -Tag CheckForOversizedIndexes

```

Or loop through a set of configuration files (`Invoke-SqlChecks` accepts paths on the pipeline, as well as objects from `Get-ChildItem`).

```powershell

Get-ChildItem -Filter *.config.json -Path .\examples\simple | Invoke-SqlChecks

```

It is also possible to pass configurations to `Invoke-SqlChecks`.

```powershell

$config = Read-SqlChecksConfig .\examples\simple\localhost.config.json

Invoke-SqlChecks -Config $config

```

You can find some example configuration files in the `examples` folder.

## Database Specific Checks

Some checks target a database (e.g. checking for oversized indexes).  By default these checks will skip:

- Databases that are not ONLINE

- Databases that are secondaries in an availability group

Some checks also exclude system databases by default - for more detail consult the test definitions in the `src/SQLChecks/Tests` folder.

## Availability Group Support

A config file can specify that databases for a specific availability group should be checked.  This is set with the `DatabasesToCheck` configuration value and the `AvailabilityGroup` value.

To only run database-specific checks on databases that belong to the `AG1` availability group, your config might look like this:

```json

{

    "ServerInstance": "localhost",

    "DatabasesToCheck": "AGOnly",

    "AvailabilityGroup": "AG1"

    ...

}

```

You can also specify a value of `LocalOnly` for `DatabasesToCheck`, which will cause database-specific checks to skip any database that belongs to an availability group.

If you do not specify a value, then every database (except for default exclusions) is checked.

## PowerShell Core Support

SQLChecks :heart: PSCore!  Tested and working with `PSCore 6.2.1rc` and `SqlServer 21.1.18095preview`.

All other dependencies (Pester, OMSIngestionApi) work on Core as of 6.1.