managed Flexible Sync 구독 - .NET SDK

구독 추가

영역에서 읽거나 영역에 쓰려면 먼저 구독이 하나 이상 있어야 합니다. 초기화 후 구독을 추가하는 대신 Flexible Sync를 구성할 때 초기 구독을 하나 이상 생성해야 합니다.

var config = new FlexibleSyncConfiguration(app.CurrentUser)
{
    PopulateInitialSubscriptions = (realm) =>
    {
        var myItems = realm.All<Item>().Where(n => n.OwnerId == myUserId);
        realm.Subscriptions.Add(myItems);
    }
};
// The process will complete when all the user's items have been downloaded.
var realm = await Realm.GetInstanceAsync(config);

var query = realm.All<Team>().Where(t => t.Name == "MyTeam");
await query.SubscribeAsync();
// you can also pass a SubscriptionOptions object:
var query2 = realm.All<Team>().Where(t => t.Name == "DevelopmentTeam");
await query2.SubscribeAsync(
    new SubscriptionOptions() { Name = "devTeamSubscription" });

realm.Subscriptions.Update(() =>
{
    // Subscribe to all long running items, and name
    // the subscription "longRunningItems"
    var longRunningTasksQuery = realm.All<Item>()
        .Where(t => t.ProgressMinutes > 120);
    realm.Subscriptions.Add(longRunningTasksQuery,
        new SubscriptionOptions() { Name = "longRunningItems" });
    // Subscribe to all of Ben's Items
    realm.Subscriptions.Add(realm.All<Item>()
        .Where(t => t.Owner == "Ben"));
    // Subscribe to all Teams, name the subscription
    // 'teamsSubscription', and throw an error if
    // this subscription name already exists.
    realm.Subscriptions.Add(realm.All<Team>(),
        new SubscriptionOptions()
        { Name = "teams", UpdateExisting = false });
});

새 쿼리로 구독 업데이트하기

새 쿼리로 명명된 구독을 업데이트할 수 있습니다. 구독 쿼리를 업데이트하려면 업데이트하려는 구독 이름과 함께 새 쿼리와 구독 옵션을 SubscriptionSet.Add() 메서드에 전달합니다. 새 구독을 추가하는 것과 마찬가지로 SubscriptionSet.Update() 메서드를 호출하여 업데이트 블록 내에서 구독을 업데이트해야 합니다.

다음 예에서 장기 실행 작업은 130분 이상 소요된 모든 작업으로 재정의됩니다.

realm.Subscriptions.Update(() =>
{
    var updatedLongRunningTasksQuery = realm.All<Item>()
        .Where(t => t.Status == "completed" && t.ProgressMinutes > 130);
    realm.Subscriptions.Add(updatedLongRunningTasksQuery,
        new SubscriptionOptions() { Name = "longRunningTasks" });
});

구독 제거

구독 세트에서 구독을 제거하려면 다음을 수행합니다.

• 지정된 쿼리로 단일 구독 제거

• 지정된 이름의 단일 구독 제거

• 지정된 구독으로 단일 구독 제거

• 특정 유형의 모든 구독 제거

• 모든 구독 삭제

구독 쿼리를 제거하면 서버는 클라이언트 장치에서 동기화된 데이터도 제거합니다.

realm.Subscriptions.Update(() =>
{
    // remove a subscription by it's query
    var query = realm.All<Item>().Where(i => i.Owner == "Ben");
    realm.Subscriptions.Remove(query);
});

realm.Subscriptions.Update(() =>
{
    // remove a named subscription
    var subscriptionName = "longRunningItemsSubscription";
    realm.Subscriptions.Remove(subscriptionName);
});

realm.Subscriptions.Update(() =>
{
    // remove all subscriptions of the "Team" Class Name
    realm.Subscriptions.RemoveAll("Team");
    // Alernatively, remove all subscriptions of the "Team" object type
    realm.Subscriptions.RemoveAll<Team>();
});

realm.Subscriptions.Update(() =>
{
    // remove all subscriptions, including named subscriptions
    realm.Subscriptions.RemoveAll(true);
});

구독 변경 사항이 Sync될 때까지 기다리기

업데이트 차단 내에서 구독 세트를 변경하는 것은 구독 변경의 일부일 뿐입니다. 로컬 구독이 변경되면 영역은 서버와 동기화되어 구독 변경으로 인한 데이터 업데이트를 해결합니다. 이는 동기화된 realm에서 데이터를 추가하거나 제거하는 것을 MEAN 수 있습니다.

SubscriptionSet.WaitForSynchronizationAsync() 메서드를 사용하여 서버가 이 구독 집합을 확인할 때까지 기다립니다. 서버가 변경 사항을 거부하면 SubscriptionSetState 는 오류 상태가 되며 예외가 발생합니다.

다음과 같은 경우 예외가 발생할 수 있습니다.

• 지원되지 않는 쿼리가 구독되었습니다. 지원되지 않는 쿼리를 구독하면 동기화가 일시 중지됩니다. 동기화를 다시 시작하려면 지원되지 않는 쿼리를 제거하세요.

• 구독과 일치하지 않는 객체를 추가하는 등 잘못된 작업을 수행하고 있습니다. 이렇게 하면 클라이언트 재설정 이 트리거됩니다. 즉, 영역에서 데이터가 지워지고 세트에 구독 없이 데이터의 새 복사본이 생성됩니다.

try
{
    await realm.Subscriptions.WaitForSynchronizationAsync();
}
catch (SubscriptionException ex)
{
    // do something in response to the exception or log it
    Console.WriteLine($@"The subscription set's state is Error and synchronization is paused:  {ex.Message}");
}

구독 상태

구독 세트의 현재 상태를 읽으려면 SubscriptionSet.state 속성을 사용하세요.

Superseded 상태는 다른 스레드가 구독 세트의 다른 인스턴스에서 구독을 업데이트할 때 발생할 수 있는 SubscriptionSetState 입니다. 상태가 Superseded 이 되면 구독 세트의 새 인스턴스를 가져와야 업데이트할 수 있습니다.

인덱싱된 쿼리 가능 필드 구독 요구 사항

앱에 인덱싱된 쿼리 가능 필드 를 추가하면 강력하게 분할된 데이터에 대한 간단한 쿼리의 성능을 향상시킬 수 있습니다. 예를 들어 user_id == $0, “641374b03725038381d2e1fb” 와 같이 쿼리가 데이터를 기기, 스토어 또는 사용자에 강력하게 매핑하는 앱은 인덱싱된 쿼리 가능 필드의 좋은 후보입니다. 그러나 인덱싱된 쿼리 가능 필드에는 쿼리 구독에 사용하기 위한 특정 요구 사항이 있습니다.

• 인덱싱된 쿼리 가능 필드는 모든 구독 쿼리에서 사용해야 합니다. 쿼리에서 누락되어서는 안 됩니다.

• 인덱싱된 쿼리 가능 필드는 구독 쿼리에서 상수에 대해 == 또는 IN 비교를 한 번 이상 사용해야 합니다. 예를 들어 user_id == $0, "641374b03725038381d2e1fb" 또는 store_id IN $0, {1,2,3}입니다.

인덱싱된 쿼리 가능 필드가 == 또는 IN을 사용하여 상수와 한 번 이상 직접 비교되는 경우, 선택적으로 AND 비교를 포함할 수 있습니다. 예를 들어 store_id IN {1,2,3} AND region=="Northeast" 또는 store_id == 1 AND (active_promotions < 5 OR num_employees < 10) 입니다.

인덱싱된 쿼리 가능 필드에 대한 유효하지 않은 Flexible Sync 쿼리에는 다음과 같은 쿼리가 포합됩니다.

• 인덱싱된 쿼리 가능 필드가 AND를 나머지 쿼리와 함께 사용하지 않는 경우.예를 들어 store_id IN {1,2,3} OR region=="Northeast"은 AND 대신 OR을 사용하므로 유효하지않습니다. 마찬가지로 store_id == 1 AND active_promotions < 5 OR num_employees < 10는 AND가 전체 쿼리가 아니라 옆에 있는 용어에만 적용되므로 유효하지 않습니다.

• 인덱싱된 쿼리 가능 필드가 동등 연산자에 사용되지 않는 경우.예를 들어 store_id > 2 AND region=="Northeast"는 > 연산자만 인덱싱된 쿼리 가능 필드에 사용하고 동등 비교는 없기 때문에 유효하지 않습니다.

• 인덱싱된 쿼리 가능 필드가 쿼리에서 완전히 누락된 경우.예를 들어region=="Northeast 또는 truepredicate는 인덱싱된 쿼리 가능 필드를 포함하지 않으므로 유효하지 않습니다.

유연한 동기화에서 지원되지 않는 쿼리 연산자

Flexible Sync는 RQL 연산자를 사용할 때 몇 가지 제한 사항이 있습니다. 동기화할 데이터를 결정하는 쿼리 구독 을 작성할 때 서버는 이러한 쿼리 연산자를 지원하지 않습니다. 그러나 전체 RQL 기능을 사용하여 클라이언트 애플리케이션에서 동기화된 데이터 세트를 쿼리할 수 있습니다.

대소문자를 구분하지 않는 쿼리([c])은(는) 인덱스를 효과적으로 사용할 수 없습니다. 대소문자를 구분하지 않는 쿼리는 성능 문제를 일으킬 수 있으므로 사용하지 않는 것이 좋습니다.

유연한 동기화는 배열 필드에 대해 @count만 지원합니다.

목록 쿼리

유연한 동기화는 IN 연산자를 사용하여 목록 쿼리를 지원합니다.

상수 목록을 쿼리하여 쿼리 가능 필드 값이 포함되어 있는지 확인할 수 있습니다:

// Query a constant list for a queryable field value
"priority IN { 1, 2, 3 }"

쿼리 가능한 필드에 배열 값이 있는 경우 해당 에 상수 값이 포함되어 있는지 쿼리할 수 있습니다.

// Query an array-valued queryable field for a constant value
"'comedy' IN genres"

// Invalid Flexible Sync query. Do not do this!
"{'comedy', 'horror', 'suspense'} IN genres"
// Another invalid Flexible Sync query. Do not do this!
"ANY {'comedy', 'horror', 'suspense'} != ANY genres"

임베디드 또는 링크된 객체

유연한 동기화는 포함된 객체 또는 링크의 속성에 대한 쿼리를 지원하지 않습니다. 예를 들어 obj1.field == "foo"이 있습니다.