Docs Menu
Docs Home
/ /
Atlas Device SDKs
/ /

Build for tvOS

On this page

  • Overview
  • Avoid Storing Important User Data
  • Share Realm Files with TV Services Extensions

This page details considerations when using Realm on tvOS.


See also:

Avoid storing important user data in a realm on tvOS. Instead, it's best to treat Realm as a rebuildable cache.


The reason for this has to do with where Realm writes its Realm files. On other Apple platforms, Realm writes its Realm files to the "Documents" directory. Because tvOS restricts writes to that directory, the default Realm file location on tvOS is instead NSCachesDirectory. tvOS can purge files in that directory at any time, so reliable long-term persistence is not possible. For cloud-backed persistence on tvOS, consider using Device Sync.

You can also use Realm as an initial data source by bundling prebuilt Realm files in your app. Note that the App Store guidelines limit your app size to 4GB.


Browse our tvOS examples for sample tvOS apps that demonstrate how to use Realm as an offline cache.

To share a Realm file between a tvOS app and a TV services extension such as Top Shelf, use the Library/Caches/ directory in the shared container for the application group:

let fileUrl = FileManager.default
.containerURL(forSecurityApplicationGroupIdentifier: "")!
← Encrypt a Realm