【SwiftData】@Query の引数と Descriptor の関係

@Query て何となく直感で使ってたけど、記述が豊富ですよね。


@Query(sort: \Snippet.creationDate, order: .reverse)
var snippets: [Snippet]


@Query(sort: [SortDescriptor(\Snippet.creationDate)])
var allSnippets: [Snippet]
 
@Query(
  filter: #Predicate<Snippet>  { $0.isFavorite },
  sort: [SortDescriptor(\.creationDate)] 
)
var favoriteSnippets: [Snippet]


static var fetchDescriptor: FetchDescriptor<Recipe> {
  let descriptor = FetchDescriptor<Recipe>(
    predicate: #Predicate { $0.isFavorite == true },
    sortBy: [.init(\.createdAt)]
  )
  descriptor.fetchLimit = 10
  return descriptor
}

@Query(FavoriteRecipesList.fetchDescriptor) private var favoriteRecipes: [Recipe]

ドキュメント見てみると、書き方が多すぎ。

👉 Query() | Apple Developer Documentation

どれもデータ取得時の操作をしてるのだろうけど、

上手に使えるように整理しておきたい。

■ 引数

ドキュメントから引数まわりをすべて抽出して眺めながら並べ替えてみる。


Query<Value, Element>(filter: Predicate<Element>?, sort: KeyPath<Element, Value>, order: SortOrder, transaction: Transaction?)
Query<Value, Element>(filter: Predicate<Element>?, sort: KeyPath<Element, Value?>, order: SortOrder, transaction: Transaction?)
Query<Value, Element>(filter: Predicate<Element>?, sort: KeyPath<Element, Value>, order: SortOrder, animation: Animation)
Query<Value, Element>(filter: Predicate<Element>?, sort: KeyPath<Element, Value?>, order: SortOrder, animation: Animation)

Query<Element>(filter: Predicate<Element>?, sort: [SortDescriptor<Element>], transaction: Transaction?)
Query<Element>(filter: Predicate<Element>?, sort: [SortDescriptor<Element>], animation: Animation)

Query<Element>(FetchDescriptor<Element>, transaction: Transaction?)
Query<Element>(FetchDescriptor<Element>, animation: Animation)

Query(transaction: Transaction)
Query(animation: Animation)

Transaction、Animation を除くと、引数は、


filter: Predicate<Element>
sort: KeyPath<Element, Value>
order: SortOrder
sort: [SortDescriptor<Element>]
FetchDescriptor<Element>

の5つであることがわかります。

上のサンプルコードからも、直感的に、


Predicate  →  抽出条件のフィルター (filter)
KeyPath    →  並び替えのキー (sort)
SortOrder  →  並び替えの順序 (order)

は意味が分かりますが。

「Descriptor」

とは何なのか。

■ SortDescriptor

「並び替えのキーと順序の入れ物」のようです。

並び替え順序は省略できます。


@Query(
  sort: [
    SortDescriptor(\Movie.title), 
    SortDescriptor(\Movie.releaseYear, order: .reverse)
  ]
) 
var movies: [Movie]

SortDescriptor に入れることで、複数の並び替えのキーを配列に入れて @Query にセットできるようになります。

なので、細かい並び替えの指定ができます。

👉 SortDescriptor | Apple Developer Documentation

■ FetchDescriptor

「抽出条件の Predicate と並び替えの配列 [SortDescriptor] の入れ物」です。


init(
  predicate: Predicate<T>? = nil,
  sortBy: [SortDescriptor<T>] = []
)

👉 init(predicate:sortBy:) | Apple Developer Documentation

なので、@Query に入れる抽出条件と並び替えの指定は、すべてこれに入れることができるようになります。

しかし、@Query より ModelContext.fetch() で使われる方が多い印象。

👉 FetchDescriptor | Apple Developer Documentation

■ まとめ

ざっくりそれぞれの関係を表でまとめておきます。

以下、GitHub 公開コードより抜粋列挙。

@Query を使う場合は、大体どれかと似た形になりそうです。


@Query private var birds: [Bird]


@Query(sort: \Backyard.creationDate)
private var backyards: [Backyard]


@Query(
  filter: #Predicate<BirdFood> { $0.id == "Nutrition Pellet" }
)
private var birdFood: [BirdFood]


@Query(
  filter: #Predicate<Episode> {$0.finishedPlaying != true },
  sort: [
    SortDescriptor(\Episode.pubDate, order: .reverse)
  ]
) 
var episodes: [Episode]


@Query(
  sort: [
    SortDescriptor(\Station.order), 
    SortDescriptor(\Station.stationName)
  ]
)
private var stations: [Station]


@Query(
  FetchDescriptor<Album>(
    predicate: #Predicate { $0.parentAlbum == nil },
    sortBy: [SortDescriptor<Album>(\.name)]
  )
) 
var albums: [Album]

基本的な操作はこれだけでいけるかな。無理かな。