Migrator.OnUpgrade(Int32, Int32, GenericDocument) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Migrates GenericDocument to a newer version of AppSearchSchema.
[Android.Runtime.Register("onUpgrade", "(IILandroid/app/appsearch/GenericDocument;)Landroid/app/appsearch/GenericDocument;", "GetOnUpgrade_IILandroid_app_appsearch_GenericDocument_Handler", ApiSince=31)]
public abstract Android.App.AppSearch.GenericDocument OnUpgrade (int currentVersion, int finalVersion, Android.App.AppSearch.GenericDocument document);[<Android.Runtime.Register("onUpgrade", "(IILandroid/app/appsearch/GenericDocument;)Landroid/app/appsearch/GenericDocument;", "GetOnUpgrade_IILandroid_app_appsearch_GenericDocument_Handler", ApiSince=31)>]
abstract member OnUpgrade : int * int * Android.App.AppSearch.GenericDocument -> Android.App.AppSearch.GenericDocumentParameters
- currentVersion
- Int32
The current version of the document's schema.
- finalVersion
- Int32
The final version that documents need to be migrated to.
- document
- GenericDocument
The GenericDocument need to be translated to new version.
Returns
A GenericDocument in new version.
- Attributes
Remarks
Migrates GenericDocument to a newer version of AppSearchSchema.
This method will be invoked only if the SetSchemaRequest is setting a higher version number than the current AppSearchSchema saved in AppSearch.
If this Migrator is provided to cover a compatible schema change via AppSearchSession#setSchema, documents under the old version won't be removed unless you use the same document ID.
This method will be invoked on the background worker thread provided via AppSearchSession#setSchema.
Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.