What s New in Core Data?

Transcription

1 Session App Frameworks #WWDC17 What s New in Core? Persisting since Melissa Turner, Core Engineer Rishi Verma, Core Engineer 2017 Apple Inc. All rights reserved. Redistribution or public display not permitted without written permission from Apple.

2 Roadmap Core Spotlight integration New indexing APIs Persistent history tracking

3 Alphonse Says Hi

4 CoreSpotlight

5 What is Spotlight Original search API on macos Document-centric Search results identify document Not location in document Not ideal for databases

6 What is Core Spotlight Original search tool on ios base-friendly Spotlight API Search for content in apps Allows deep linking

7 What is Core Spotlight NEW Original search tool on ios base-friendly Spotlight API Search for content in apps Allows deep linking Ships on Mac OS and ios

8 Core Spotlight

9 Core Spotlight

10 Core Spotlight

11 Core Spotlight

12 Core Spotlight

13 What is Core Spotlight Original search tool on ios base-friendly Spotlight API Search for content in apps Allows deep linking Ships on Mac OS and ios

14 What is Core Spotlight Original search tool on ios base-friendly Spotlight API Search for content in apps Allows deep linking Ships on Mac OS and ios Access CoreSpotlight search data from your app

15 What is Core Spotlight Original search tool on ios base-friendly Spotlight API Search for content in apps Allows deep linking Ships on Mac OS and ios Access CoreSpotlight search data from your app No zero-length files

16 Three Pieces Way to indicate property participation NSPropertyDescription.indexedBySpotlight Way to specify display name NSEntityDescription.coreSpotlightDisplayNameExpression Exporter

17 corespotlightdisplaynameexpression NSExpression Evaluated during Core Spotlight update object parameter will be an instance of NSManaged Can return anything Core Spotlight can accept CSLocalizedString

18 corespotlightdisplaynameexpression Keypath Property name Function lowercase:(displayname) MyUtilityClass displaynamefor:, self))

19 NSCoreCoreSpotlightDelegate Implements CSSearchableIndexDelegate Default implementations of all methods Uses a separate store on a background thread Initialize with NSPersistentStoreDescription + model Override point is NSCDCSD.attributeSet(for object:)

20 override func attributeset(for object: NSManaged) -> CSSearchableItemAttributeSet? { guard let attributeset = super.attributeset(for: object) else { return nil } if "Photo" == object.entity.name { let photo = object as! Photo let tags = photo.tags let localizedstring = localizedtagstring(photo) attributeset.setvalue(localizedstring, forcustomkey: attributekey!) } return attributeset; }

21 override func attributeset(for object: NSManaged) -> CSSearchableItemAttributeSet? { guard let attributeset = super.attributeset(for: object) else { return nil } if "Photo" == object.entity.name { let photo = object as! Photo let tags = photo.tags let localizedstring = localizedtagstring(photo) attributeset.setvalue(localizedstring, forcustomkey: attributekey!) } return attributeset; }

22 override func attributeset(for object: NSManaged) -> CSSearchableItemAttributeSet? { guard let attributeset = super.attributeset(for: object) else { return nil } if "Photo" == object.entity.name { let photo = object as! Photo let tags = photo.tags let localizedstring = localizedtagstring(photo) attributeset.setvalue(localizedstring, forcustomkey: attributekey!) } return attributeset; }

23 override func attributeset(for object: NSManaged) -> CSSearchableItemAttributeSet? { guard let attributeset = super.attributeset(for: object) else { return nil } if "Photo" == object.entity.name { let photo = object as! Photo let tags = photo.tags let localizedstring = localizedtagstring(photo) attributeset.setvalue(localizedstring, forcustomkey: attributekey!) } return attributeset; }

24 Demo

25 Non-Sharp Corners Will automatically export to Core Spotlight on first launch Uses Persistent History Tracking to ensure all data is pushed

26 Sharpish Corners Core Spotlight and Spotlight integration mutually exclusive entity.corespotlightdisplaynameexpression OR property.storedinexternalrecord Doesn t track results of batch operations

27 Sharpish Corners Entitlement to talk to Core Spotlight com.apple.application-identifier You need to handle the search result public func application(_ application: NSApplication, continue useractivity: NSUserActivity, ([Any]) -> Void) -> Bool

28 public func application(_ application: NSApplication, continue useractivity: NSUserActivity, ([Any]) -> Void) -> Bool { let userinfo = useractivity.userinfo as! NSDictionary let identifier = userinfo.value(forkey: kcssearchableitemactivityidentifier ) let uri = URL(string: identifier as! String) let coordinator = self.persistentcontainer.persistentstorecoordinator let managedid = managedid(forurirepresentation: uri!) } // insert your code here

29 public func application(_ application: NSApplication, continue useractivity: NSUserActivity, ([Any]) -> Void) -> Bool { let userinfo = useractivity.userinfo as! NSDictionary let identifier = userinfo.value(forkey: kcssearchableitemactivityidentifier ) let uri = URL(string: identifier as! String) let coordinator = self.persistentcontainer.persistentstorecoordinator let managedid = managedid(forurirepresentation: uri!) } // insert your code here

30 public func application(_ application: NSApplication, continue useractivity: NSUserActivity, ([Any]) -> Void) -> Bool { let userinfo = useractivity.userinfo as! NSDictionary let identifier = userinfo.value(forkey: kcssearchableitemactivityidentifier ) let uri = URL(string: identifier as! String) let coordinator = self.persistentcontainer.persistentstorecoordinator let managedid = managedid(forurirepresentation: uri!) } // insert your code here

31 public func application(_ application: NSApplication, continue useractivity: NSUserActivity, ([Any]) -> Void) -> Bool { let userinfo = useractivity.userinfo as! NSDictionary let identifier = userinfo.value(forkey: kcssearchableitemactivityidentifier ) let uri = URL(string: identifier as! String) let coordinator = self.persistentcontainer.persistentstorecoordinator let managedid = managedid(forurirepresentation: uri!) } // insert your code here

32 public func application(_ application: NSApplication, continue useractivity: NSUserActivity, ([Any]) -> Void) -> Bool { let userinfo = useractivity.userinfo as! NSDictionary let identifier = userinfo.value(forkey: kcssearchableitemactivityidentifier ) let uri = URL(string: identifier as! String) let coordinator = self.persistentcontainer.persistentstorecoordinator let managedid = managedid(forurirepresentation: uri!) } // insert your code here

33 Sharp Corners Up to you to delete old reference files x86_64 only

34 New Indexing API

35 Indexing Configure database for faster search One or more columns per index One or more indexes per column base will choose most efficient index based on query

36 Digression: Indexing Binary indexes Basic form Strict comparison only RTree indexes Optimized for ranged based searching

37 BTree

38 BTree Index

39 RTree R2 R5 R4 R1 R3 R6 R8 R10 R7 R9

40 RTree Index R1 R2 R6 R10 R4 R5 R3 R7 R8 R9

41 Current Indexing APIs Single property index NSAttributeDescription.isIndexed Multiple column index NSEntityDescription.compoundIndexes

42 Evolving Core Indexing Ability to support more index types More configurable indexing

43 More Powerful API NSFetchIndexDescription NSFetchIndexElementDescription NSEntityDescription.indexes Functions to control index use indexed:by:(indexname, propertyname) noindex:(propertyname)

44 NSFetchIndexElementDescription Property Type Binary RTree Direction

45 NSFetchIndexDescription Specify a single index Name Elements Predicate Validates index composition

46 Sharp Corners Can t mix and match element types Range indexes require numeric properties <= 32-bit Which can t be optional Create indexes last Changing entity hierarchy structurally drops indexes

47 Maybe Sharp Corners? Doesn t affect version hash Won t cause migration (with perf hit) Won t cause migration (user won t get updated indexes) Update model s versionhashmodifier to trigger migration SQL store will ignore unsupported indexes

48 Demo

49 Miscellaneous

50 New Attribute Types NSUUIDAttributeType NSUUID NSURIAttributeType NSURL

51 Persistent History Tracking History 201 Rishi Verma, Core Engineer

52 Story of the App

53 Story of the App Application View Context Background Context

54 Story of the App Application Shared Container Persistent Store View Context Background Context

55 Story of the App Application Shared Container Persistent Store View Context Background Context

56 Story of the App Application Shared Container Persistent Store View Context Background Context

57 Story of the App Application Shared Container Persistent Store View Context Remote Content Background Context

58 Story of the App Application Shared Container Persistent Store View Context Remote Content Background Context Document

59 Story of the App Application Shared Container Persistent Store View Context Remote Content Background Context Document Share

60 Story of the App Application Shared Container Persistent Store View Context Remote Content Background Context Document Share Photo Editing

61 Trains in the Night Application Shared Container Persistent Store View Context Remote Content Background Context Document Share Photo Editing

62 Trains in the Night Application Shared Container Persistent Store View Context Remote Content Background Context Document Share Photo Editing

63 Trains in the Night Application Shared Container Persistent Store View Context Remote Content Background Context Document Share Photo Editing

64 Trains in the Night Application Shared Container Persistent Store View Context Remote Content Background Context Document Share Photo Editing

65 Trains in the Night Shared Container Persistent Store Remote Content Document Share Photo Editing

66 Trains in the Night Application Shared Container Persistent Store View Context Remote Content Background Context Document Share Photo Editing

67 Ghost in the base Document Share Photos Application viewcontext backgroundcontext

68 Ghost in the base Document Share Photos Application viewcontext backgroundcontext

69 Ghost in the base Document Share Photos Application viewcontext backgroundcontext

70 Ghost in the base Document Share Photos Application viewcontext backgroundcontext

71 Ghost in the base Document Share Photos Application viewcontext backgroundcontext

72 Ghost in the base Document Share Photos Application viewcontext backgroundcontext

73 Ghost in the base Document Share Photos Application viewcontext backgroundcontext

74 Ghost in the base Document Share Photos Application viewcontext backgroundcontext

75 Ghost in the base Document Share Photos Application viewcontext backgroundcontext

76 Ghost in the base Document Share Photos Application viewcontext backgroundcontext

77 Ghost in the base Document Share Photos Application viewcontext backgroundcontext

78 Ghost in the base Document Share Photos Application viewcontext backgroundcontext

79 Ghost in the base Document Share Photos Application viewcontext backgroundcontext

80 //Uncovering The Mystery - Made Easy, as simple as ABC let container = NSPersistentContainer(name: "WWDCDemo") let storedescription = container.persistentstoredescriptions.first storedescription?.setoption(true as NSNumber forkey:nspersistenthistorytrackingkey) container.loadpersistentstores { storedescription, error in }

81 //Uncovering The Mystery - Made Easy, as simple as ABC let container = NSPersistentContainer(name: "WWDCDemo") let storedescription = container.persistentstoredescriptions.first storedescription?.setoption(true as NSNumber forkey:nspersistenthistorytrackingkey) container.loadpersistentstores { storedescription, error in }

82 //Uncovering The Mystery - Made Easy, as simple as ABC let container = NSPersistentContainer(name: "WWDCDemo") let storedescription = container.persistentstoredescriptions.first storedescription?.setoption(true as NSNumber forkey:nspersistenthistorytrackingkey) container.loadpersistentstores { storedescription, error in }

83 //Uncovering The Mystery - Made Easy, as simple as ABC let container = NSPersistentContainer(name: "WWDCDemo") let storedescription = container.persistentstoredescriptions.first storedescription?.setoption(true as NSNumber forkey:nspersistenthistorytrackingkey) container.loadpersistentstores { storedescription, error in }

84 Ghost in the base Document Share Photos Application viewcontext backgroundcontext

85 Ghost in the base Document Share Photos Application viewcontext backgroundcontext

86 Ghost in the base Document Share Photos History Application 1 backgroundcontext Apps viewcontext backgroundcontext

87 Ghost in the base Document Share Photos History Application 1 backgroundcontext Apps viewcontext backgroundcontext

88 Ghost in the base Document Share Photos History Application 1 backgroundcontext Apps viewcontext backgroundcontext

89 Ghost in the base Document Share Photos History Application 1 backgroundcontext Apps 2 Document Files viewcontext backgroundcontext

90 Ghost in the base Document Share Photos History Application 1 backgroundcontext Apps 2 Document Files viewcontext backgroundcontext

91 Ghost in the base Document Share Photos History Application 1 backgroundcontext Apps 2 Document Files viewcontext backgroundcontext

92 Ghost in the base Document Share Photos History Application 1 backgroundcontext Apps 2 Document Files viewcontext 3 Share Safari backgroundcontext

93 Ghost in the base Document Share Photos History Application 1 backgroundcontext Apps 2 Document Files viewcontext 3 Share Safari backgroundcontext

94 Ghost in the base Document Share Photos History Application 1 backgroundcontext Apps 2 Document Files viewcontext 3 Share Safari backgroundcontext

95 Ghost in the base Document Share Photos History Application 1 backgroundcontext Apps viewcontext 2 Document Files 3 Share Safari backgroundcontext 4 Photos Photos

96 Ghost in the base Document Share Photos History Application 1 backgroundcontext Apps viewcontext 2 Document Files 3 Share Safari backgroundcontext 4 Photos Photos

97 Ghost in the base Document Share Photos History Application 1 backgroundcontext Apps viewcontext 2 Document Files 3 Share Safari backgroundcontext 4 Photos Photos

98 Ghost in the base Document Share Photos History Application 1 backgroundcontext Apps viewcontext 2 Document Files 3 Share Safari backgroundcontext 4 Photos Photos

99 //Reading History, the journey of a historian NEW open class NSPersistentHistoryChangeRequest : NSPersistentStoreRequest { open class func fetchhistory(after date: Date) -> Self open class func fetchhistory(after token: NSPersistentHistoryToken?) -> Self open class func fetchhistory(after transaction: NSPersistentHistoryTransaction?) -> Self open var resulttype: NSPersistentHistoryResultType }

100 //Reading History, the journey of a historian NEW open class NSPersistentHistoryChangeRequest : NSPersistentStoreRequest { open class func fetchhistory(after date: Date) -> Self open class func fetchhistory(after token: NSPersistentHistoryToken?) -> Self open class func fetchhistory(after transaction: NSPersistentHistoryTransaction?) -> Self open var resulttype: NSPersistentHistoryResultType }

101 //Reading History, the journey of a historian NEW open class NSPersistentHistoryChangeRequest : NSPersistentStoreRequest { open class func fetchhistory(after date: Date) -> Self open class func fetchhistory(after token: NSPersistentHistoryToken?) -> Self open class func fetchhistory(after transaction: NSPersistentHistoryTransaction?) -> Self open var resulttype: NSPersistentHistoryResultType }

102 //Reading History, the journey of a historian NEW open class NSPersistentHistoryChangeRequest : NSPersistentStoreRequest { open class func fetchhistory(after date: Date) -> Self open class func fetchhistory(after token: NSPersistentHistoryToken?) -> Self open class func fetchhistory(after transaction: NSPersistentHistoryTransaction?) -> Self open var resulttype: NSPersistentHistoryResultType }

103 //Reading History, the journey of a historian NEW open class NSPersistentHistoryChangeRequest : NSPersistentStoreRequest { open class func fetchhistory(after date: Date) -> Self open class func fetchhistory(after token: NSPersistentHistoryToken?) -> Self open class func fetchhistory(after transaction: NSPersistentHistoryTransaction?) -> Self open var resulttype: NSPersistentHistoryResultType }

104 //Reading History, the journey of a historian NEW open class NSPersistentHistoryChangeRequest : NSPersistentStoreRequest { open class func fetchhistory(after date: Date) -> Self open class func fetchhistory(after token: NSPersistentHistoryToken?) -> Self open class func fetchhistory(after transaction: NSPersistentHistoryTransaction?) -> Self open var resulttype: NSPersistentHistoryResultType }

105 //Reducing History, history is purged by the consumers NEW open class NSPersistentHistoryChangeRequest : NSPersistentStoreRequest { open class func deletehistory(before date: Date) -> Self open class func deletehistory(before token: NSPersistentHistoryToken?) -> Self open class func deletehistory(before transaction: NSPersistentHistoryTransaction?) -> Self } //A single gatekeeper should be in charge of purging history

106 //Reducing History, history is purged by the consumers NEW open class NSPersistentHistoryChangeRequest : NSPersistentStoreRequest { open class func deletehistory(before date: Date) -> Self open class func deletehistory(before token: NSPersistentHistoryToken?) -> Self open class func deletehistory(before transaction: NSPersistentHistoryTransaction?) -> Self } //A single gatekeeper should be in charge of purging history

107 //Reducing History, history is purged by the consumers NEW open class NSPersistentHistoryChangeRequest : NSPersistentStoreRequest { open class func deletehistory(before date: Date) -> Self open class func deletehistory(before token: NSPersistentHistoryToken?) -> Self open class func deletehistory(before transaction: NSPersistentHistoryTransaction?) -> Self } //A single gatekeeper should be in charge of purging history

108 //Reducing History, history is purged by the consumers NEW open class NSPersistentHistoryChangeRequest : NSPersistentStoreRequest { open class func deletehistory(before date: Date) -> Self open class func deletehistory(before token: NSPersistentHistoryToken?) -> Self open class func deletehistory(before transaction: NSPersistentHistoryTransaction?) -> Self } //A single gatekeeper should be in charge of purging history

109 //Reducing History, history is purged by the consumers NEW open class NSPersistentHistoryChangeRequest : NSPersistentStoreRequest { open class func deletehistory(before date: Date) -> Self open class func deletehistory(before token: NSPersistentHistoryToken?) -> Self open class func deletehistory(before transaction: NSPersistentHistoryTransaction?) -> Self } //A single gatekeeper should be in charge of purging history

110 //Reducing History, history is purged by the consumers NEW open class NSPersistentHistoryChangeRequest : NSPersistentStoreRequest { open class func deletehistory(before date: Date) -> Self open class func deletehistory(before token: NSPersistentHistoryToken?) -> Self open class func deletehistory(before transaction: NSPersistentHistoryTransaction?) -> Self } //A single gatekeeper should be in charge of purging history

111 //NSPersistentHistoryTransaction NEW open class NSPersistentHistoryTransaction : NS, NSCopying { open var timestamp: Date { get } open var changes: [NSPersistentHistoryChange]? { get } open var transactionnumber: Int64 { get } open var storeid: String { get } open var bundleid: String { get } open var processid: String { get } open var contextname: String? { get } open var author: String? { get } open var token: NSPersistentHistoryToken { get } } // Get a notification that can be consumed by a NSManagedContext open func objectidnotification() -> Notification

112 //NSPersistentHistoryTransaction NEW open class NSPersistentHistoryTransaction : NS, NSCopying { open var timestamp: Date { get } open var changes: [NSPersistentHistoryChange]? { get } open var transactionnumber: Int64 { get } open var storeid: String { get } open var bundleid: String { get } open var processid: String { get } open var contextname: String? { get } open var author: String? { get } open var token: NSPersistentHistoryToken { get } } // Get a notification that can be consumed by a NSManagedContext open func objectidnotification() -> Notification

113 //NSPersistentHistoryTransaction NEW open class NSPersistentHistoryTransaction : NS, NSCopying { open var timestamp: Date { get } open var changes: [NSPersistentHistoryChange]? { get } open var transactionnumber: Int64 { get } open var storeid: String { get } open var bundleid: String { get } open var processid: String { get } open var contextname: String? { get } open var author: String? { get } open var token: NSPersistentHistoryToken { get } } // Get a notification that can be consumed by a NSManagedContext open func objectidnotification() -> Notification

114 //NSPersistentHistoryTransaction NEW open class NSPersistentHistoryTransaction : NS, NSCopying { open var timestamp: Date { get } open var changes: [NSPersistentHistoryChange]? { get } open var transactionnumber: Int64 { get } open var storeid: String { get } open var bundleid: String { get } open var processid: String { get } open var contextname: String? { get } open var author: String? { get } open var token: NSPersistentHistoryToken { get } } // Get a notification that can be consumed by a NSManagedContext open func objectidnotification() -> Notification

115 //NSManagedContext NEW /* Set the author for the context, this will be used as an identifier in the Persistent History Transactions (NSPersistentHistoryTransaction) */ open var transactionauthor: String?

116 //NSPersistentHistoryChange NEW public enum NSPersistentHistoryChangeType : Int { case insert case update case delete } open class NSPersistentHistoryChange : NS, NSCopying { open var changeid: Int64 { get open var changedid: NSManagedID { get } open var changetype: NSPersistentHistoryChangeType { get } open var tombstone: [AnyHashable : Any]? { get } open var transaction: NSPersistentHistoryTransaction? { get } open var updatedproperties: Set<NSPropertyDescription>? { get } }

117 //NSPersistentHistoryChange NEW public enum NSPersistentHistoryChangeType : Int { case insert case update case delete } open class NSPersistentHistoryChange : NS, NSCopying { open var changeid: Int64 { get open var changedid: NSManagedID { get } open var changetype: NSPersistentHistoryChangeType { get } open var tombstone: [AnyHashable : Any]? { get } open var transaction: NSPersistentHistoryTransaction? { get } open var updatedproperties: Set<NSPropertyDescription>? { get } }

118 //NSPersistentHistoryChange NEW public enum NSPersistentHistoryChangeType : Int { case insert case update case delete } open class NSPersistentHistoryChange : NS, NSCopying { open var changeid: Int64 { get open var changedid: NSManagedID { get } open var changetype: NSPersistentHistoryChangeType { get } open var tombstone: [AnyHashable : Any]? { get } open var transaction: NSPersistentHistoryTransaction? { get } open var updatedproperties: Set<NSPropertyDescription>? { get } }

119 //NSPersistentHistoryChange NEW public enum NSPersistentHistoryChangeType : Int { case insert case update case delete } open class NSPersistentHistoryChange : NS, NSCopying { open var changeid: Int64 { get open var changedid: NSManagedID { get } open var changetype: NSPersistentHistoryChangeType { get } open var tombstone: [AnyHashable : Any]? { get } open var transaction: NSPersistentHistoryTransaction? { get } open var updatedproperties: Set<NSPropertyDescription>? { get } }

120 Model Editor

121 Model Editor

122 Demo History In Action!

123 Recap History is fun!

124 Recap History is fun! Simple to enable Persistent History

125 Recap History is fun! Simple to enable Persistent History Uncover missing changes

126 Recap History is fun! Simple to enable Persistent History Uncover missing changes Never be in the dark again!

127 Migration Easy as pie

128 Migration Easy as pie We preserve as much history as possible

129 Migration Easy as pie We preserve as much history as possible Except when removing:

130 Migration Easy as pie We preserve as much history as possible Except when removing: Entities

131 Migration Easy as pie We preserve as much history as possible Except when removing: Entities Tombstones

132 Migration Easy as pie We preserve as much history as possible Except when removing: Entities Tombstones We will preserve the history until the last transaction that is complete

133 Performance Everything has consequences

134 Performance Everything has consequences Slight impact on save-and-batch operations

135 Performance Everything has consequences Slight impact on save-and-batch operations An increase in memory during such operations

136 Performance Everything has consequences Slight impact on save-and-batch operations An increase in memory during such operations Small storage overhead, but history can be purged

137 Summary

138 Summary CoreSpotlight easily share your app data with Spotlight

139 Summary CoreSpotlight easily share your app data with Spotlight New Indexing API faster searches, faster apps

140 Summary CoreSpotlight easily share your app data with Spotlight New Indexing API faster searches, faster apps Persistent History always know who dun it

141

142 More Information

143 Related Sessions What s New in Cocoa Video Online What s New in Foundation Hall 2 Wednesday 11:00 AM Build Better Apps with CloudKit Dashboard Grand Ballroom B Thursday 10:00 AM What s New in Core Spotlight for ios and macos Grand Ballroom B Thursday 4:10 PM Cocoa Development Tips Grand Ballroom B Friday 9:00 AM

144 Labs Cocoa Lab Technology Lab C Wed 11:00AM-1:00PM Foundation Lab Technology Lab C Wed 1:00PM-3:30PM Core Lab Technology Lab C Wed 3:10PM-6:00PM CloudKit and icloud Lab Technology Lab C Thu 11:00AM-1:00PM Core Lab Technology Lab H Thu 4:10PM-6:00PM CoreSpotlight and Search Lab Technology Lab H Fri 9:00AM-11:00AM Cocoa Lab Technology Lab B Fri 1:50PM-3:20PM

145