Get-​Sql​Database

Gets a SQL database object for each database that is present in the target instance of SQL Server.

Syntax

Get-SqlDatabase
   [[-Name] <String>]
   [[-Path] <String>]
   [-Script]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Get-SqlDatabase
   [[-Name] <String>]
   [-ServerInstance] <String[]>
   [-Script]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-WhatIf]
   [-Confirm]
   [-Credential <PSCredential>]
   [-ConnectionTimeout <Int32>]
   [<CommonParameters>]
Get-SqlDatabase
   [[-Name] <String>]
   [-InputObject] <Server>
   [-Script]
   [-InformationAction <ActionPreference>]
   [-InformationVariable <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Get-SqlDatabase cmdlet gets a SQL database object for each database that is present in the target instance of SQL Server. If the name of the database is provided, the cmdlet will return only this specific database object.

This cmdlet supports the following modes of operation to get the SQL database object:

- Specify the instance Windows PowerShell path.

  • Specify the server object.
  • Specify the ServerInstance object of the target instance of SQL Server.

Examples

Example 1: Get a SQL database object

PS C:\> CD SQLSERVER:\SQL\Computer\Instance;
PS SQLSERVER:\SQL\Computer\Instance> Get-SqlDatabase -Name "DbName" -Credential $SqlCredential;

The first command changes the working directory to SQLSERVER:\SQL\Computer\Instance.

The second command gets the database object for the database named DbName of the server instance Computer\Instance. The current working directory is used to determine the server instance where the operation occurs.

Example 2: Get all instances of SQL Server on a computer

PS C:\> Get-SqlInstance -Credential $Credential -MachineName "Computer001" | Get-SqlDatabase -Credential $SqlCredential;

This command gets all instances of SQL Server on the computer named Computer001and returns all the databases that are present in the instances.

Required Parameters

-InputObject

Specifies the server object of the target instance.

Type:Server
Position:2
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-ServerInstance

Specifies the name of an instance of SQL Server, as a string array, that becomes the target of the operation.

Type:String[]
Position:2
Default value:None
Accept pipeline input:True (ByPropertyName, ByValue)
Accept wildcard characters:False

Optional Parameters

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-ConnectionTimeout

Specifies the number of seconds to wait for a SQL Server connection before a timeout failure. The timeout value must be an integer value between 0 and 65534. If 0 is specified, connection attempts do not time out.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Credential

Specifies a user account with Windows Administrator credentials on the target machine.

Type:PSCredential
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationAction

Specifies how this cmdlet responds to an information event.The acceptable values for this parameter are:- Continue

  • Ignore
  • Inquire
  • SilentlyContinue
  • Stop
  • Suspend
Type:ActionPreference
Aliases:infa
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InformationVariable

Specifies an information variable.

Type:String
Aliases:iv
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Name

Specifies the name of the database that this cmdlet gets the SQL database object.

Type:String
Position:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Path

Specifies the path to the instance of SQL Server on which this cmdlet runs the operation. If you do not specify a value for this parameter, the cmdlet uses the current working location.

Type:String
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Script

Indicates that this cmdlet generates a Transact-SQL script that runs the task.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False