Remove-DbaDbSchema

Synopsis

Removes database schemas from one or more SQL Server databases.

Description

Removes database schemas from SQL Server databases using the DROP SCHEMA T-SQL command. This function is useful for cleaning up unused schemas during database maintenance, development environment resets, or application decommissioning. The schema must be completely empty before removal - any tables, views, functions, or other objects within the schema will prevent the drop operation from succeeding. You’ll need to remove or relocate all schema objects first before running this command.

Syntax

Remove-DbaDbSchema
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Database] <String[]>]
    [-Schema] <String[]>
    [[-InputObject] <Database[]>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Remove-DbaDbSchema -SqlInstance sqldev01 -Database example1 -Schema TestSchema1

Removes the TestSchema1 schema in the example1 database in the sqldev01 instance.

Example: 2

PS C:\> Get-DbaDatabase -SqlInstance sqldev01, sqldev02 -Database example1 | Remove-DbaDbSchema -Schema TestSchema1, TestSchema2

Passes in the example1 db via pipeline and removes the TestSchema1 and TestSchema2 schemas.

Required Parameters

-Schema

Specifies the name(s) of the schema(s) to remove from the target databases. The schema must be completely empty before removal.
Any tables, views, functions, stored procedures, or other objects within the schema must be dropped or moved first.

Optional Parameters

-SqlInstance

The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function
to be executed against multiple SQL Server instances.

-SqlCredential

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.
For MFA support, please use Connect-DbaInstance.

-Database

Specifies the target database(s) where schemas will be removed. Required when using SqlInstance parameter.
Use this to limit schema removal to specific databases rather than affecting all databases on the instance.

-InputObject

Accepts database objects from Get-DbaDatabase via pipeline input. Use this when you need to work with pre-filtered database collections.
Eliminates the need to specify SqlInstance and Database parameters when database objects are already available.

-EnableException

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
This avoids overwhelming you with “sea of red” exceptions, but is inconvenient because it basically disables advanced scripting.
Using this switch turns this “nice by default” feature off and enables you to catch exceptions with your own try/catch.

-WhatIf

Shows what would happen if the command were to run. No actions are actually performed.

-Confirm

Prompts you for confirmation before executing any changing operations within the command.