Share via

  • Article

Database.Rename Method

Renames the database.

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
Public Sub Rename ( _
    newName As String _
)
'Usage
Dim instance As Database
Dim newName As String

instance.Rename(newName)

public void Rename(
    string newName
)

public:
virtual void Rename(
    String^ newName
) sealed

abstract Rename : 
        newName:string -> unit 
override Rename : 
        newName:string -> unit 

public final function Rename(
    newName : String
)

Parameters

  • newName
    Type: System.String
    A string value that specifies the new name of the database.

Implements

IRenamable.Rename(String)

Remarks

Note:   An alternative to renaming the database is to create a synonym for the database.

Examples

VB

'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server

'Reference the AdventureWorks2008R2 database.
Dim db As Database
db = srv.Databases("AdventureWorks2008R2")

'Rename the database
db.Rename("AdventureWorks2008R22")

'Refresh the properties on the database.
db.Refresh()
db.Rename("AdventureWorks2008R2")

PowerShell

$srv = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")
$db = New-Object Microsoft.SqlServer.Management.Smo.Database
$db = $srv.Databases.Item("AdventureWorks2008R2")

$db.Rename("AdventureWorks2008R22")

$db.Refresh()
$db.Rename("AdventureWorks2008R2")