Upgrade na sadu .NET SDK služby Azure Search verze 5
Pokud používáte sadu .NET SDK verze 4.0 preview nebo starší, pomůže vám tento článek upgradovat aplikaci tak, aby používala verzi 5.
Obecnější návod k sadě SDK včetně příkladů najdete v tématu Použití služby Azure Search z aplikace .NET.
Verze 5 sady .NET SDK služby Azure Search obsahuje některé změny z předchozích verzí. Většinou jsou menší, takže změna kódu by měla vyžadovat jen minimální úsilí. Pokyny ke změně kódu na používání nové verze sady SDK najdete v části Postup upgradu .
Poznámka
Pokud používáte verzi 2.0-Preview nebo starší, měli byste nejprve upgradovat na verzi 3 a pak upgradovat na verzi 5. Pokyny najdete v tématu Upgrade na sadu .NET SDK služby Azure Search verze 3 .
Vaše instance Azure Search podporuje několik verzí rozhraní REST API, včetně nejnovější verze. Verzi můžete dál používat, pokud už není nejnovější, ale doporučujeme migrovat kód tak, aby používal nejnovější verzi. Při použití rozhraní REST API je nutné zadat verzi rozhraní API v každém požadavku prostřednictvím parametru api-version. Při použití sady .NET SDK určuje verze sady SDK, kterou používáte, odpovídající verzi rozhraní REST API. Pokud používáte starší sadu SDK, můžete tento kód dál spouštět beze změn, i když je služba upgradována tak, aby podporovala novější verzi rozhraní API.
Novinky ve verzi 5
Verze 5 sady .NET SDK služby Azure Search cílí na nejnovější obecně dostupnou verzi rozhraní REST API služby Azure Search, konkrétně 2017-11-11. To umožňuje používat nové funkce služby Azure Search z aplikace .NET, včetně následujících:
- Synonyma.
- Nyní můžete programově přistupovat k upozorněním v historii provádění indexeru (další podrobnosti najdete
Warning
v referenčních informacíchIndexerExecutionResult
k rozhraní .NET). - Podpora pro .NET Core 2
- Nová struktura balíčků podporuje použití pouze částí sady SDK, které potřebujete (podrobnosti najdete v tématu Zásadní změny ve verzi 5 ).
Postup upgradu
Nejprve aktualizujte referenční NuGet pro Microsoft.Azure.Search
použití konzoly NuGet Správce balíčků nebo kliknutím pravým tlačítkem myši na odkazy na projekt a výběrem možnosti Spravovat NuGet balíčky... v Visual Studio.
Jakmile NuGet stáhnou nové balíčky a jejich závislosti, znovu sestavte projekt. V závislosti na struktuře kódu se může úspěšně znovu sestavit. Pokud ano, jste připravení jít!
Pokud se sestavení nezdaří, měla by se zobrazit chyba sestavení, jako je následující:
The name 'SuggesterSearchMode' does not exist in the current context
Dalším krokem je oprava této chyby sestavení. Podrobnosti o tom, co způsobuje chybu a jak ji opravit, najdete v tématu Zásadní změny ve verzi 5 .
Upozorňujeme, že kvůli změnám v balení sady .NET SDK služby Azure Search je nutné aplikaci znovu sestavit, abyste mohli používat verzi 5. Tyto změny jsou podrobně popsané v zásadních změnách ve verzi 5.
Může se zobrazit další upozornění sestavení týkající se zastaralých metod nebo vlastností. Upozornění budou obsahovat pokyny k tomu, co použít místo zastaralé funkce. Pokud například vaše aplikace tuto metodu IndexingParametersExtensions.DoNotFailOnUnsupportedContentType
používá, měla by se zobrazit upozornění s informací, že toto chování je teď ve výchozím nastavení povolené, takže volání této metody už není nutné.
Jakmile opravíte chyby nebo upozornění sestavení, můžete v aplikaci provádět změny, které vám umožní využívat nové funkce, pokud chcete. Nové funkce v sadě SDK jsou podrobně popsané v novinkách ve verzi 5.
Zásadní změny ve verzi 5
Nová struktura balíčku
Nejvýraznější zásadní změnou verze 5 je, že Microsoft.Azure.Search
sestavení a jeho obsah byly rozděleny do čtyř samostatných sestavení, která jsou nyní distribuována jako čtyři samostatné balíčky NuGet:
-
Microsoft.Azure.Search
: Jedná se o metabal, který zahrnuje všechny ostatní balíčky Azure Search jako závislosti. Pokud upgradujete ze starší verze sady SDK, stačí, když tento balíček upgradujete a znovu sestavíte, abyste mohli začít používat novou verzi. -
Microsoft.Azure.Search.Data
: Tento balíček použijte, pokud vyvíjíte aplikaci .NET pomocí služby Azure Search a potřebujete pouze dotazovat nebo aktualizovat dokumenty v indexech. Pokud potřebujete také vytvořit nebo aktualizovat indexy, mapy synonym nebo jiné prostředky na úrovni služby, použijteMicrosoft.Azure.Search
místo toho balíček. -
Microsoft.Azure.Search.Service
: Tento balíček použijte, pokud vyvíjíte automatizaci v .NET ke správě indexů, map synonym, indexerů, zdrojů dat nebo jiných prostředků na úrovni služby. Pokud potřebujete dotazovat nebo aktualizovat dokumenty jenom v indexech, použijte místoMicrosoft.Azure.Search.Data
toho balíček. Pokud potřebujete všechny funkce služby Azure Search, použijte místo tohoMicrosoft.Azure.Search
balíček. -
Microsoft.Azure.Search.Common
: Běžné typy vyžadované knihovnami .NET služby Azure Search Tento balíček byste neměli používat přímo ve vaší aplikaci; Je určen pouze jako závislost.
Tato změna je technicky zásadní, protože mnoho typů bylo přesunuto mezi sestaveními. To je důvod, proč je opětovné sestavení aplikace nezbytné k upgradu na verzi 5 sady SDK.
Ve verzi 5 existuje malý počet dalších zásadních změn, které mohou kromě opětovného sestavení aplikace vyžadovat změny kódu.
Změna na návrhy
Konstruktor Suggester
již nemá enum
parametr pro SuggesterSearchMode
. Tento výčet měl pouze jednu hodnotu a byl proto redundantní. Pokud se v důsledku toho zobrazí chyby sestavení, jednoduše odeberte odkazy na SuggesterSearchMode
parametr.
Odebrání zastaralých členů
Může se zobrazit chyby sestavení související s metodami nebo vlastnostmi, které byly v dřívějších verzích označeny jako zastaralé a následně odebrány ve verzi 5. Pokud narazíte na takové chyby, tady je postup jejich řešení:
- Pokud jste použili metodu
IndexingParametersExtensions.IndexStorageMetadataOnly
, použijte místoSetBlobExtractionMode(BlobExtractionMode.StorageMetadata)
toho. - Pokud jste použili metodu
IndexingParametersExtensions.SkipContent
, použijte místoSetBlobExtractionMode(BlobExtractionMode.AllMetadata)
toho.
Odebrání funkcí preview
Pokud upgradujete z verze 4.0 preview na verzi 5, mějte na paměti, že podpora parsování polí JSON a CSV pro indexery objektů blob byla odebrána, protože tyto funkce jsou stále ve verzi Preview. Konkrétně byly odebrány následující metody IndexingParametersExtensions
třídy:
ParseJsonArrays
ParseDelimitedTextFiles
Pokud má vaše aplikace pevnou závislost na těchto funkcích, nebudete moct upgradovat na verzi 5 sady .NET SDK služby Azure Search. Můžete dál používat verzi 4.0-Preview. Mějte ale na paměti, že nedoporučujeme používat sady SDK ve verzi Preview v produkčních aplikacích. Funkce preview jsou určené jenom pro zkušební verzi a můžou se změnit.
Závěr
Pokud potřebujete další podrobnosti o používání sady .NET SDK služby Azure Search, podívejte se na postupy .NET.
Vítáme vaši zpětnou vazbu k sadě SDK. Pokud narazíte na problémy, můžete nás požádat o pomoc se službou Stack Overflow. Pokud zjistíte chybu, můžete problém podat v úložišti Azure .NET SDK GitHub. Nezapomeňte předponu názvu vašeho problému předponou [Azure Search].
Děkujeme vám za používání služby Azure Search!