UpdateDefinitionExtensions.Rename(TDocument) Method (UpdateDefinition(TDocument), FieldDefinition(TDocument), String)

UpdateDefinitionExtensionsRenameTDocument Method (UpdateDefinitionTDocument, FieldDefinitionTDocument, String)

Combines an existing update with a field renaming operator.

Namespace: MongoDB.Driver
Assembly: MongoDB.Driver (in MongoDB.Driver.dll) Version: 2.4.1

Syntax

public static UpdateDefinition<TDocument> Rename<TDocument>(
	this UpdateDefinition<TDocument> update,
	FieldDefinition<TDocument> field,
	string newName
)

<ExtensionAttribute>
Public Shared Function Rename(Of TDocument) ( 
	update As UpdateDefinition(Of TDocument),
	field As FieldDefinition(Of TDocument),
	newName As String
) As UpdateDefinition(Of TDocument)

[<ExtensionAttribute>]
static member Rename : 
        update : UpdateDefinition<'TDocument> * 
        field : FieldDefinition<'TDocument> * 
        newName : string -> UpdateDefinition<'TDocument>

Parameters

update: Type: MongoDB.DriverUpdateDefinitionTDocument
The update.
field: Type: MongoDB.DriverFieldDefinitionTDocument
The field.
newName: Type: SystemString
The new name.

Type Parameters

TDocument: The type of the document.

Return Value

Type: UpdateDefinitionTDocument
A combined update.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type UpdateDefinitionTDocument. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Reference

UpdateDefinitionExtensions Class

Rename Overload

MongoDB.Driver Namespace