Get-DbaDbSchema

Synopsis

Retrieves database schema objects from SQL Server instances for inventory, security auditing, and management tasks

Description

Returns SQL Server Management Object (SMO) schema objects from one or more databases, allowing you to inspect schema ownership, enumerate database organization, and identify schema-level security configurations. This function is essential for database documentation, security auditing when you need to track who owns which schemas, and migration planning where schema ownership and structure must be preserved. You can filter results by specific schema names, schema owners, or databases, and optionally include system schemas like dbo, sys, and INFORMATION_SCHEMA which are excluded by default.

Syntax

Get-DbaDbSchema
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Database] <String[]>]
    [[-Schema] <String[]>]
    [[-SchemaOwner] <String[]>]
    [-IncludeSystemDatabases]
    [-IncludeSystemSchemas]
    [[-InputObject] <Database[]>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaDbSchema -SqlInstance localhost

Gets all non-system database schemas from all user databases on the localhost instance. Note: the dbo schema is a system schema and won’t be included in the output from this example. To include the
dbo schema specify -IncludeSystemSchemas

Example: 2

PS C:\> Get-DbaDbSchema -SqlInstance localhost -Schema dbo -IncludeSystemSchemas

Returns the dbo schema from the databases on the localhost instance.

Example: 3

PS C:\> Get-DbaDbSchema -SqlInstance localhost -IncludeSystemDatabases -IncludeSystemSchemas

Gets all database schemas from all databases on the localhost instance.

Example: 4

PS C:\> Get-DbaDbSchema -SqlInstance localhost -Schema TestSchema

Finds and returns the TestSchema schema from the localhost instance.

Example: 5

PS C:\> Get-DbaDbSchema -SqlInstance localhost -SchemaOwner DBUser1

Finds and returns the schemas owned by DBUser1 from the localhost instance.

Example: 6

PS C:\> Get-DbaDbSchema -SqlInstance localhost -Database TestDB -SchemaOwner DBUser1

Finds and returns the schemas owned by DBUser1 in the TestDB database from the localhost instance.

Example: 7

PS C:\> $schema = Get-DbaDbSchema -SqlInstance localhost -Database TestDB -Schema TestSchema
PS C:\> $schema.Owner = DBUser2
PS C:\> $schema.Alter()

Finds the TestSchema in the TestDB on the localhost instance and then changes the schema owner to DBUser2

Example: 8

PS C:\> $schema = Get-DbaDbSchema -SqlInstance localhost -Database TestDB -Schema TestSchema
PS C:\> $schema.Drop()

Finds the TestSchema in the TestDB on the localhost instance and then drops it. Note: to drop a schema all objects must be transferred to another schema or dropped.

Example: 9

PS C:\> $db = Get-DbaDatabase -SqlInstance localhost -Database TestDB
PS C:\> $schema = $db | Get-DbaDbSchema -Schema TestSchema

Finds the TestSchema in the TestDB which is passed via pipeline into the Get-DbaDbSchema command.

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 which databases to retrieve schemas from. Accepts wildcards for pattern matching.
Use this when you need to focus on specific databases instead of all databases on the instance.

-Schema

Filters results to include only schemas with the specified names. Accepts multiple schema names.
Use this when you need to check specific schemas like custom application schemas or verify particular schema configurations.

-SchemaOwner

Filters results to schemas owned by the specified database users or roles. Accepts multiple owner names.
Use this for security audits to identify all schemas owned by specific users, or when troubleshooting schema ownership issues.

-IncludeSystemDatabases

Includes system databases (master, model, msdb, tempdb) in the schema retrieval.
Use this when you need to audit or document schema configurations across all databases including system databases.

-IncludeSystemSchemas

Includes built-in system schemas like dbo, sys, guest, and INFORMATION_SCHEMA in the results.
Use this when you need complete schema inventory including system schemas, or when specifically working with dbo schema objects.

-InputObject

Accepts database objects from Get-DbaDatabase via pipeline input for processing.
Use this to chain database operations or when you already have database objects and want to retrieve their schemas efficiently.

-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.