Azure AI Search'te eşzamanlılığı yönetme
Dizinler ve veri kaynakları gibi Azure AI Search kaynaklarını yönetirken, özellikle de uygulamanızın farklı bileşenleri tarafından kaynaklara eşzamanlı olarak erişiliyorsa kaynakları güvenli bir şekilde güncelleştirmek önemlidir. İki istemci eş zamanlı olarak koordinasyon olmadan bir kaynağı güncelleştirdiğinde, yarış koşulları mümkündür. Bunu önlemek için Azure AI Search iyimser bir eşzamanlılık modeli kullanır. Kaynakta kilit yok. Bunun yerine, her kaynak için kaynak sürümünü tanımlayan bir ETag vardır, böylece yanlışlıkla üzerine yazmayı önleyen istekleri formüle edebilirsiniz.
Nasıl çalışır?
İyimser eşzamanlılık, dizinlere, dizin oluşturuculara, veri kaynaklarına, beceri kümelerine ve eş anlamlıMap kaynaklarına yazılan API çağrılarındaki erişim koşulu denetimleri aracılığıyla uygulanır.
Tüm kaynakların nesne sürümü bilgilerini sağlayan bir varlık etiketi (ETag) vardır. İlk olarak ETag'i denetleyerek, kaynağın ETag'inin yerel kopyanızla eşleştiğinden emin olarak tipik bir iş akışında eşzamanlı güncelleştirmelerden (yerel olarak alma, değiştirme, güncelleştirme) kaçınabilirsiniz.
REST API, istek üst bilgisinde bir ETag kullanır.
.NET için Azure SDK, ETag'i bir accessCondition nesnesi aracılığıyla ayarlar ve If-Match | Kaynakta If-Match-None üst bilgisi . SynonymMap.ETag ve SearchIndex.ETag gibi ETag kullanan nesnelerin accessCondition nesnesi vardır.
Bir kaynağı her güncelleştirdiğinizde ETag'i otomatik olarak değişir. Eşzamanlılık yönetimi uyguladığınızda, tek yaptığınız güncelleştirme isteğine uzak kaynağın istemcide değiştirdiğiniz kaynağın kopyasıyla aynı ETag'e sahip olmasını gerektiren bir önkoşul koymaktır. Başka bir işlem uzak kaynağı değiştirirse, ETag önkoşulla eşleşmez ve istek HTTP 412 ile başarısız olur. .NET SDK'sını kullanıyorsanız, bu hata uzantı yönteminin IsAccessConditionFailed() true döndürdüğü bir özel durum olarak bildirir.
Not
Eşzamanlılık için tek bir mekanizma vardır. Kaynak güncelleştirmeleri için hangi API veya SDK kullanıldığından bağımsız olarak her zaman kullanılır.
Örnek
Aşağıdaki kod, güncelleştirme işlemi için iyimser eşzamanlılığı gösterir. Nesnenin ETag'i önceki bir güncelleştirmeyle değiştirildiğinden ikinci güncelleştirme başarısız olur. Daha açık belirtmek gerekirse, istek üst bilgisindeki ETag artık nesnenin ETag'iyle eşleşmediğinde, arama hizmeti 400 (hatalı istek) durum kodu döndürür ve güncelleştirme başarısız olur.
using Azure;
using Azure.Search.Documents;
using Azure.Search.Documents.Indexes;
using Azure.Search.Documents.Indexes.Models;
using System;
using System.Net;
using System.Threading.Tasks;
namespace AzureSearch.SDKHowTo
{
class Program
{
// This sample shows how ETags work by performing conditional updates and deletes
// on an Azure Search index.
static void Main(string[] args)
{
string serviceName = "PLACEHOLDER FOR YOUR SEARCH SERVICE NAME";
string apiKey = "PLACEHOLDER FOR YOUR SEARCH SERVICE ADMIN API KEY";
// Create a SearchIndexClient to send create/delete index commands
Uri serviceEndpoint = new Uri($"https://{serviceName}.search.windows.net/");
AzureKeyCredential credential = new AzureKeyCredential(apiKey);
SearchIndexClient adminClient = new SearchIndexClient(serviceEndpoint, credential);
// Delete index if it exists
Console.WriteLine("Check for index and delete if it already exists...\n");
DeleteTestIndexIfExists(adminClient);
// Every top-level resource in Azure Search has an associated ETag that keeps track of which version
// of the resource you're working on. When you first create a resource such as an index, its ETag is
// empty.
SearchIndex index = DefineTestIndex();
Console.WriteLine(
$"Test searchIndex hasn't been created yet, so its ETag should be blank. ETag: '{index.ETag}'");
// Once the resource exists in Azure Search, its ETag is populated. Make sure to use the object
// returned by the SearchIndexClient. Otherwise, you will still have the old object with the
// blank ETag.
Console.WriteLine("Creating index...\n");
index = adminClient.CreateIndex(index);
Console.WriteLine($"Test index created; Its ETag should be populated. ETag: '{index.ETag}'");
// ETags prevent concurrent updates to the same resource. If another
// client tries to update the resource, it will fail as long as all clients are using the right
// access conditions.
SearchIndex indexForClientA = index;
SearchIndex indexForClientB = adminClient.GetIndex("test-idx");
Console.WriteLine("Simulating concurrent update. To start, clients A and B see the same ETag.");
Console.WriteLine($"ClientA ETag: '{indexForClientA.ETag}' ClientB ETag: '{indexForClientB.ETag}'");
// indexForClientA successfully updates the index.
indexForClientA.Fields.Add(new SearchField("a", SearchFieldDataType.Int32));
indexForClientA = adminClient.CreateOrUpdateIndex(indexForClientA);
Console.WriteLine($"Client A updates test-idx by adding a new field. The new ETag for test-idx is: '{indexForClientA.ETag}'");
// indexForClientB tries to update the index, but fails due to the ETag check.
try
{
indexForClientB.Fields.Add(new SearchField("b", SearchFieldDataType.Boolean));
adminClient.CreateOrUpdateIndex(indexForClientB);
Console.WriteLine("Whoops; This shouldn't happen");
Environment.Exit(1);
}
catch (RequestFailedException e) when (e.Status == 400)
{
Console.WriteLine("Client B failed to update the index, as expected.");
}
// Uncomment the next line to remove test-idx
//adminClient.DeleteIndex("test-idx");
Console.WriteLine("Complete. Press any key to end application...\n");
Console.ReadKey();
}
private static void DeleteTestIndexIfExists(SearchIndexClient adminClient)
{
try
{
if (adminClient.GetIndex("test-idx") != null)
{
adminClient.DeleteIndex("test-idx");
}
}
catch (RequestFailedException e) when (e.Status == 404)
{
//if an exception occurred and status is "Not Found", this is working as expected
Console.WriteLine("Failed to find index and this is because it's not there.");
}
}
private static SearchIndex DefineTestIndex() =>
new SearchIndex("test-idx", new[] { new SearchField("id", SearchFieldDataType.String) { IsKey = true } });
}
}
Tasarım deseni
İyimser eşzamanlılık uygulamak için tasarım deseni, erişim koşulu denetimini yeniden deneyen bir döngü, erişim koşulu için bir test ve isteğe bağlı olarak değişiklikleri yeniden uygulamayı denemeden önce güncelleştirilmiş bir kaynağı alan bir döngü içermelidir.
Bu kod parçacığı, zaten var olan bir dizine synonymMap eklenmesini gösterir.
Kod parçacığı "hotels" dizinini alır, bir güncelleştirme işleminde nesne sürümünü denetler, koşul başarısız olursa bir özel durum oluşturur ve ardından en son sürümü almak için sunucudan dizin alımından başlayarak işlemi (en fazla üç kez) yeniden dener.
private static void EnableSynonymsInHotelsIndexSafely(SearchServiceClient serviceClient)
{
int MaxNumTries = 3;
for (int i = 0; i < MaxNumTries; ++i)
{
try
{
Index index = serviceClient.Indexes.Get("hotels");
index = AddSynonymMapsToFields(index);
// The IfNotChanged condition ensures that the index is updated only if the ETags match.
serviceClient.Indexes.CreateOrUpdate(index, accessCondition: AccessCondition.IfNotChanged(index));
Console.WriteLine("Updated the index successfully.\n");
break;
}
catch (Exception e) when (e.IsAccessConditionFailed())
{
Console.WriteLine($"Index update failed : {e.Message}. Attempt({i}/{MaxNumTries}).\n");
}
}
}
private static Index AddSynonymMapsToFields(Index index)
{
index.Fields.First(f => f.Name == "category").SynonymMaps = new[] { "desc-synonymmap" };
index.Fields.First(f => f.Name == "tags").SynonymMaps = new[] { "desc-synonymmap" };
return index;
}