Classes
Declaration
Swift
-public final class CoreDataStack: CustomStringConvertible, Equatable
+ public final class CoreDataStack
diff --git a/docs/Classes.html b/docs/Classes.html index 24dc6304..3b48b4f3 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -10,6 +10,7 @@
+Swift
-public final class CoreDataStack: CustomStringConvertible, Equatable
+ public final class CoreDataStack
public final class CoreDataStack: CustomStringConvertible, Equatable
+ public final class CoreDataStack
-
+
- mainContext
+ mainContext
The main managed object context for the stack, which operates on the main queue.
-This context is a root level context that is connected to the storeCoordinator
.
-It is kept in sync with backgroundContext
.
storeCoordinator
.
+It is kept in sync with backgroundContext
.
Swift
-public let mainContext: NSManagedObjectContext
+ public let mainContext: NSManagedObjectContext
-
+
- backgroundContext
+ backgroundContext
The background managed object context for the stack, which operates on a background queue.
-This context is a root level context that is connected to the storeCoordinator
.
-It is kept in sync with mainContext
.
storeCoordinator
.
+It is kept in sync with mainContext
.
Swift
-public let backgroundContext: NSManagedObjectContext
+ public let backgroundContext: NSManagedObjectContext
-
+
- storeCoordinator
+ storeCoordinator
Swift
-public let storeCoordinator: NSPersistentStoreCoordinator
+ public let storeCoordinator: NSPersistentStoreCoordinator
-
+
- childContext(concurrencyType:mergePolicyType:)
+ childContext(concurrencyType:mergePolicyType:)
Creates a new child context with the specified concurrencyType
and mergePolicyType
.
The parent context is either mainContext
or backgroundContext
dependending on the specified concurrencyType
:
The parent context is either mainContext
or backgroundContext
dependending on the specified concurrencyType
:
.PrivateQueueConcurrencyType
will set backgroundContext
as the parent..MainQueueConcurrencyType
will set mainContext
as the parent..PrivateQueueConcurrencyType
will set backgroundContext
as the parent..MainQueueConcurrencyType
will set mainContext
as the parent.Saving the returned context will propagate changes through the parent context and then to the persistent store.
@@ -302,8 +280,8 @@Swift
-public func childContext(concurrencyType: NSManagedObjectContextConcurrencyType = .mainQueueConcurrencyType,
- mergePolicyType: NSMergePolicyType = .mergeByPropertyObjectTrumpMergePolicyType) -> ChildContext
+ public func childContext(concurrencyType: NSManagedObjectContextConcurrencyType = .mainQueueConcurrencyType,
+ mergePolicyType: NSMergePolicyType = .mergeByPropertyObjectTrumpMergePolicyType) -> NSManagedObjectContext.ChildContext
Swift
-public func reset(onQueue queue: DispatchQueue = .global(qos: .userInitiated),
+ public func reset(onQueue queue: DispatchQueue = .global(qos: .userInitiated),
completion: @escaping (StackResult) -> Void)
-
-
- StoreType
+
+
+ ModelFileExtension
Describes a Core Data persistent store type.
+Describes a Core Data model file exention type based on the +Model File Format and Versions +documentation.
- See more + See moreSwift
-public enum StoreType: Equatable
+ public enum ModelFileExtension : String
Swift
-public enum MigrationError: Error
+ public enum MigrationError : Error
Swift
-public enum SaveResult: Equatable
+ public enum SaveResult : Equatable
-
-
- ModelFileExtension
+
+
+ StackResult
Describes a Core Data model file exention type based on the -Model File Format and Versions -documentation.
+A result object representing the result of creating a CoreDataStack
via a CoreDataStackFactory
.
Swift
-public enum ModelFileExtension: String
+ public enum StackResult : Equatable
-
-
- StackResult
+
+
+ StoreType
A result object representing the result of creating a CoreDataStack
via a CoreDataStackFactory
.
Describes a Core Data persistent store type.
- See more + See moreSwift
-public enum StackResult: Equatable
+ public enum StoreType : Equatable
public enum MigrationError: Error
+ public enum MigrationError : Error
-
-
- sourceModelNotFound
+
+
+ sourceModelNotFound(model:)
Swift
-case sourceModelNotFound(model: CoreDataModel)
+ case sourceModelNotFound(model: CoreDataModel)
Swift
-case mappingModelNotFound(destinationModel: NSManagedObjectModel)
+ case mappingModelNotFound(destinationModel: NSManagedObjectModel)
public enum ModelFileExtension: String
+ public enum ModelFileExtension : String
Swift
-case bundle = "momd"
+ case bundle = "momd"
-
+
- versionedFile
+ versionedFile
Swift
-case versionedFile = "mom"
+ case versionedFile = "mom"
Swift
-case mapping = "cdm"
+ case mapping = "cdm"
Swift
-case sqlite = "sqlite"
+ case sqlite = "sqlite"
public enum SaveResult: Equatable
+ public enum SaveResult : Equatable
Swift
-case success
+ case success
-
-
- failure
+
+
+ failure(_:)
Swift
-case failure(NSError)
+ case failure(NSError)
Swift
-public func error() -> NSError?
+ public func error() -> NSError?
public enum StackResult: Equatable
+ public enum StackResult : Equatable
-
-
- success
+
+
+ success(_:)
-
-
- failure
+
+
+ failure(_:)
Swift
-case failure(NSError)
+ case failure(NSError)
Swift
-public func error() -> NSError?
+ public func error() -> NSError?
public enum StoreType: Equatable
+ public enum StoreType : Equatable
-
-
- sqlite
+
+
+ sqlite(_:)
Swift
-case sqlite(URL)
+ case sqlite(URL)
-
-
- binary
+
+
+ binary(_:)
Swift
-case binary(URL)
+ case binary(URL)
Swift
-case inMemory
+ case inMemory
Swift
-public var type: String
+ public var type: String { get }
Swift
-public func storeDirectory() -> URL?
+ public func storeDirectory() -> URL?
JSQCoreDataKit Docs (100% documented)
@@ -21,7 +22,7 @@The following global variables are available globally.
+The following extensions are available globally.
-
-
- defaultStoreOptions
+
+
+ NSManagedObjectContext
Describes default persistent store options.
- + + See moreSwift
-public let defaultStoreOptions: PersistentStoreOptions = [
+ class NSManagedObjectContext : NSObject, NSCoding, NSLocking
JSQCoreDataKit Docs (100% documented)
+ +class NSManagedObjectContext : NSObject, NSCoding, NSLocking
+
+
+
+
+ ChildContext
+
+ Describes a child managed object context.
+ +Swift
+public typealias ChildContext = NSManagedObjectContext
+
+
+
+
+ save(wait:completion:)
+
+ Attempts to commit unsaved changes to registered objects in the context. +This function is performed in a block on the context’s queue. If the context has no changes, +then this function returns immediately and the completion block is not called.
+ +Swift
+public func save(wait: Bool = true, completion: ((SaveResult) -> Void)? = nil)
+
+
+
+ wait
+
+ |
+
+
+
+ If |
+
+
+ completion
+
+ |
+
+
+
+ The closure to be executed when the save operation completes. + |
+
JSQCoreDataKit Docs (100% documented)
- -The following functions are available globally.
- -
-
-
- defaultDirectoryURL()
-
- The default directory used to initialize a CoreDataModel
.
-On tvOS, this is the caches directory. All other platforms use the document directory.
Swift
-public func defaultDirectoryURL() -> URL
-
-
-
-
- saveContext(_:wait:completion:)
-
- Attempts to commit unsaved changes to registered objects in the context. -This function is performed in a block on the context’s queue. If the context has no changes, -then this function returns immediately and the completion block is not called.
- -Swift
-public func saveContext(_ context: NSManagedObjectContext, wait: Bool = true, completion: ((SaveResult) -> Void)? = nil)
-
-
-
- context
-
- |
-
-
-
- The managed object context to save. - |
-
-
- wait
-
- |
-
-
-
- If |
-
-
- completion
-
- |
-
-
-
- The closure to be executed when the save operation completes. - |
-
Swift
-public protocol CoreDataEntityProtocol: class
+ public protocol CoreDataEntityProtocol : AnyObject
public protocol CoreDataEntityProtocol: class
+ public protocol CoreDataEntityProtocol : AnyObject
-
+
- entityName
+ entityName
Default implementation
@@ -159,7 +137,7 @@ Swift
-static var entityName: String
+ static var entityName: String { get }
Swift
-static var defaultSortDescriptors: [NSSortDescriptor]
+ static var defaultSortDescriptors: [NSSortDescriptor] { get }
-
+
- fetchRequest
+ fetchRequest
Extension method
@@ -213,14 +191,14 @@ Returns a new fetch request with defaultSortDescriptors
.
Returns a new fetch request with defaultSortDescriptors
.
Swift
-public static var fetchRequest: NSFetchRequest<Self>
+ public static var fetchRequest: NSFetchRequest<Self> { get }
-
+
- entity(context:)
+ entity(context:)
Extension method
@@ -251,7 +229,7 @@ Swift
-public static func entity(context: NSManagedObjectContext) -> NSEntityDescription
+ public static func entity(context: NSManagedObjectContext) -> NSEntityDescription
-
-
- CoreDataStackFactory
+
+
+ CoreDataModel
An instance of CoreDataStackFactory
is responsible for creating instances of CoreDataStack
.
Because the adding of the persistent store to the persistent store coordinator during initialization
-of a CoreDataStack
can take an unknown amount of time, you should not perform this operation on the main queue.
See this guide for more details.
-Warning
- You should not create instances ofCoreDataStack
directly. Use a CoreDataStackFactory
instead.
-
-An instance of CoreDataModel
represents a Core Data model — a .xcdatamodeld
file package.
+It provides the model and store URLs as well as methods for interacting with the store.
Swift
-public struct CoreDataStackFactory: Equatable
+ public struct CoreDataModel
-
-
- CoreDataModel
+
+
+ CoreDataStackFactory
An instance of CoreDataModel
represents a Core Data model — a .xcdatamodeld
file package.
-It provides the model and store URLs as well as methods for interacting with the store.
An instance of CoreDataStackFactory
is responsible for creating instances of CoreDataStack
.
Because the adding of the persistent store to the persistent store coordinator during initialization
+of a CoreDataStack
can take an unknown amount of time, you should not perform this operation on the main queue.
See this guide for more details.
+Warning
+ You should not create instances ofCoreDataStack
directly. Use a CoreDataStackFactory
instead.
+
+Swift
-public struct CoreDataModel: Equatable
+ public struct CoreDataStackFactory
public struct CoreDataModel: Equatable
+ public struct CoreDataModel
Swift
-public let name: String
+ public let name: String
Swift
-public let bundle: Bundle
+ public let bundle: Bundle
Swift
-public var storeURL: URL?
+ public var storeURL: URL? { get }
The file URL specifying the model file in the bundle specified by bundle
.
The file URL specifying the model file in the bundle specified by bundle
.
Swift
-public var modelURL: URL
+ public var modelURL: URL { get }
-
+
- databaseFileName
+ databaseFileName
Swift
-public var databaseFileName: String
+ public var databaseFileName: String { get }
-
+
- managedObjectModel
+ managedObjectModel
The managed object model for the model specified by name
.
The managed object model for the model specified by name
.
Swift
-public var managedObjectModel: NSManagedObjectModel
+ public var managedObjectModel: NSManagedObjectModel { get }
-
+
- needsMigration
+ needsMigration
Swift
-public var needsMigration: Bool
+ public var needsMigration: Bool { get }
Swift
-public func removeExistingStore() throws
+ public func removeExistingStore() throws
+
+
+
+
+ defaultDirectoryURL()
+
+ The default directory used to initialize a CoreDataModel
.
+On tvOS, this is the caches directory. All other platforms use the document directory.
Swift
+public static func defaultDirectoryURL() -> URL
Progressively migrates the persistent store of the CoreDataModel
based on mapping models found in the model’s bundle.
-If the model returns false from needsMigration
, then this function does nothing.
needsMigration
, then this function does nothing.
Throws
If an error occurs, either an NSError
or a MigrationError
is thrown. If an NSError
is thrown, it could
@@ -531,7 +537,7 @@
Swift
-public func migrate() throws
+ public func migrate() throws
public struct CoreDataStackFactory: Equatable
+ public struct CoreDataStackFactory
+
+
+ PersistentStoreOptions
+
+ Describes the initialization options for a persistent store.
+ +Swift
+public typealias PersistentStoreOptions = [AnyHashable : Any]
+
+
-
+
+
+ defaultStoreOptions
+
+ Describes default persistent store options.
+ +Swift
+public static let defaultStoreOptions: CoreDataStackFactory.PersistentStoreOptions
+
+ Constructs a new CoreDataStackFactory
instance with the specified model
and options
.
Constructs a new CoreDataStackFactory
instance with the specified model
and options
.
Swift
-public init(model: CoreDataModel, options: PersistentStoreOptions? = defaultStoreOptions)
+ public init(model: CoreDataModel, options: PersistentStoreOptions? = defaultStoreOptions)
Initializes a new CoreDataStack
instance using the factory’s model
and options
.
Initializes a new CoreDataStack
instance using the factory’s model
and options
.
Warning
If a queue is provided, this operation is performed asynchronously on the specified queue, @@ -314,7 +357,7 @@
Swift
-public func createStack(onQueue queue: DispatchQueue? = .global(qos: .userInitiated),
+ public func createStack(onQueue queue: DispatchQueue? = .global(qos: .userInitiated),
completion: @escaping (StackResult) -> Void)
JSQCoreDataKit Docs (100% documented)
- -The following type aliases are available globally.
- -
-
-
- ChildContext
-
- Describes a child managed object context.
- -Swift
-public typealias ChildContext = NSManagedObjectContext
-
-
-
-
- PersistentStoreOptions
-
- Describes the initialization options for a persistent store.
- -Swift
-public typealias PersistentStoreOptions = [AnyHashable : AnyObject]
-
- Read the docs. Generated with jazzy. Hosted by GitHub Pages.
$ ./build_docs.sh
+$ ./scripts/build_docs.sh
Preview
-$ open index.html -a Safari
+$ open index.html -a Safari
Contribute
@@ -199,8 +178,8 @@ License
Describes a child managed object context.
"},"Typealiases.html#/s:14JSQCoreDataKit22PersistentStoreOptionsa":{"name":"PersistentStoreOptions","abstract":"Describes the initialization options for a persistent store.
"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV4nameSSv":{"name":"name","abstract":"The name of the Core Data model resource.
","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV6bundleSo6BundleCv":{"name":"bundle","abstract":"The bundle in which the model is located.
","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV9storeTypeAA05StoreG0Ov":{"name":"storeType","abstract":"The type of the Core Data persistent store for the model.
","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV8storeURL10Foundation0G0VSgv":{"name":"storeURL","abstract":"The file URL specifying the full path to the store.
","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV8modelURL10Foundation0G0Vv":{"name":"modelURL","abstract":"The file URL specifying the model file in the bundle specified by bundle
.
The database file name for the store.
","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV013managedObjectE0So09NSManagedgE0Cv":{"name":"managedObjectModel","abstract":"The managed object model for the model specified by name
.
Queries the meta data for the persistent store specified by the receiver","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelVACSS4name_So6BundleC6bundleAA9StoreTypeO05storeJ0tcfc":{"name":"init(name:bundle:storeType:)","abstract":"
Constructs a new CoreDataModel
instance with the specified name and bundle.
Removes the existing model store specfied by the receiver.
","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV7migrateyyKF":{"name":"migrate()","abstract":"Progressively migrates the persistent store of the CoreDataModel
based on mapping models found in the model’s bundle.","parent_name":"CoreDataModel"},"Structs/CoreDataStackFactory.html#/s:14JSQCoreDataKit04CoreB12StackFactoryV5modelAA0dB5ModelVv":{"name":"model","abstract":"
The model for the stack that the factory produces.
","parent_name":"CoreDataStackFactory"},"Structs/CoreDataStackFactory.html#/s:14JSQCoreDataKit04CoreB12StackFactoryV7optionss10DictionaryVys11AnyHashableVyXlGSgv":{"name":"options","abstract":"A dictionary that specifies options for the store that the factory produces.","parent_name":"CoreDataStackFactory"},"Structs/CoreDataStackFactory.html#/s:14JSQCoreDataKit04CoreB12StackFactoryVAcA0dB5ModelV5model_s10DictionaryVys11AnyHashableVyXlGSg7optionstcfc":{"name":"init(model:options:)","abstract":"
Constructs a new CoreDataStackFactory
instance with the specified model
and options
.
Initializes a new CoreDataStack
instance using the factory’s model
and options
.
An instance of CoreDataStackFactory
is responsible for creating instances of CoreDataStack
.
An instance of CoreDataModel
represents a Core Data model — a .xcdatamodeld
file package."},"Protocols/CoreDataEntityProtocol.html#/s:14JSQCoreDataKit04CoreB14EntityProtocolP10entityNameSSvZ":{"name":"entityName","abstract":"
The name of the entity.
","parent_name":"CoreDataEntityProtocol"},"Protocols/CoreDataEntityProtocol.html#/s:14JSQCoreDataKit04CoreB14EntityProtocolP22defaultSortDescriptorsSaySo16NSSortDescriptorCGvZ":{"name":"defaultSortDescriptors","abstract":"The default sort descriptors for a fetch request.
","parent_name":"CoreDataEntityProtocol"},"Protocols/CoreDataEntityProtocol.html#/s:14JSQCoreDataKit04CoreB14EntityProtocolPAASo15NSManagedObjectCRbzAaBRzlE12fetchRequestSo07NSFetchJ0CyxGvZ":{"name":"fetchRequest","abstract":"Returns a new fetch request with defaultSortDescriptors
.
Returns the entity with the specified name from the managed object model associated","parent_name":"CoreDataEntityProtocol"},"Protocols/CoreDataEntityProtocol.html":{"name":"CoreDataEntityProtocol","abstract":"
Describes an entity in Core Data.
"},"Functions.html#/s:14JSQCoreDataKit19defaultDirectoryURL10Foundation0F0VyF":{"name":"defaultDirectoryURL()","abstract":"The default directory used to initialize a CoreDataModel
."},"Functions.html#/s:14JSQCoreDataKit11saveContextySo015NSManagedObjectE0C_Sb4waityAA10SaveResultOcSg10completiontF":{"name":"saveContext(_:wait:completion:)","abstract":"
Attempts to commit unsaved changes to registered objects in the context."},"Enums/StackResult.html#/s:14JSQCoreDataKit11StackResultO7successAcA04CorebD0CcACmF":{"name":"success","abstract":"
The success result, containing the successfully initialized CoreDataStack
.
The failure result, containing an NSError
instance that describes the error.
The extension for a model bundle, or a .xcdatamodeld
file package.
The extension for a versioned model file, or a .xcdatamodel
file.
The extension for a mapping model file, or a .xcmappingmodel
file.
The extension for a sqlite store.
","parent_name":"ModelFileExtension"},"Enums/SaveResult.html#/s:14JSQCoreDataKit10SaveResultO7successA2CmF":{"name":"success","abstract":"The success result.
","parent_name":"SaveResult"},"Enums/SaveResult.html#/s:14JSQCoreDataKit10SaveResultO7failureACSo7NSErrorCcACmF":{"name":"failure","abstract":"The failure result, containing an NSError
instance that describes the error.
Specifies that the NSManagedObjectModel
corresponding to the existing persistent store was not found in the model’s bundle.
Specifies that an NSMappingModel
was not found in the model’s bundle in the progressive migration ‘path’.
The SQLite database store type. The associated file URL specifies the directory for the store.
","parent_name":"StoreType"},"Enums/StoreType.html#/s:14JSQCoreDataKit9StoreTypeO6binaryAC10Foundation3URLVcACmF":{"name":"binary","abstract":"The binary store type. The associated file URL specifies the directory for the store.
","parent_name":"StoreType"},"Enums/StoreType.html#/s:14JSQCoreDataKit9StoreTypeO8inMemoryA2CmF":{"name":"inMemory","abstract":"The in-memory store type.
","parent_name":"StoreType"},"Enums/StoreType.html#/s:14JSQCoreDataKit9StoreTypeO4typeSSv":{"name":"type","abstract":"Returns the type string description for the store type.
","parent_name":"StoreType"},"Enums/StoreType.html#/s:14JSQCoreDataKit9StoreTypeO14storeDirectory10Foundation3URLVSgyF":{"name":"storeDirectory()","abstract":"Describes a Core Data persistent store type.
"},"Enums/MigrationError.html":{"name":"MigrationError","abstract":"An error type that specifies possible errors that are thrown by calling CoreDataModel.migrate() throws
.
A result object representing the result of saving an NSManagedObjectContext
.
Describes a Core Data model file exention type based on the"},"Enums/StackResult.html":{"name":"StackResult","abstract":"
A result object representing the result of creating a CoreDataStack
via a CoreDataStackFactory
.
Describes default persistent store options.
"},"Classes/CoreDataStack.html#/s:14JSQCoreDataKit04CoreB5StackC5modelAA0dB5ModelVv":{"name":"model","abstract":"The model for the stack.
","parent_name":"CoreDataStack"},"Classes/CoreDataStack.html#/s:14JSQCoreDataKit04CoreB5StackC11mainContextSo015NSManagedObjectG0Cv":{"name":"mainContext","abstract":"The main managed object context for the stack, which operates on the main queue.","parent_name":"CoreDataStack"},"Classes/CoreDataStack.html#/s:14JSQCoreDataKit04CoreB5StackC17backgroundContextSo015NSManagedObjectG0Cv":{"name":"backgroundContext","abstract":"
The background managed object context for the stack, which operates on a background queue.","parent_name":"CoreDataStack"},"Classes/CoreDataStack.html#/s:14JSQCoreDataKit04CoreB5StackC16storeCoordinatorSo017NSPersistentStoreG0Cv":{"name":"storeCoordinator","abstract":"
The persistent store coordinator for the stack. Both contexts are connected to this coordinator.
","parent_name":"CoreDataStack"},"Classes/CoreDataStack.html#/s:14JSQCoreDataKit04CoreB5StackC12childContextSo015NSManagedObjectG0CSC0hiG15ConcurrencyTypeO011concurrencyK0_SC013NSMergePolicyK0O05mergenK0tF":{"name":"childContext(concurrencyType:mergePolicyType:)","abstract":"Creates a new child context with the specified concurrencyType
and mergePolicyType
.
Resets the managed object contexts in the stack on their respective threads.","parent_name":"CoreDataStack"},"Classes/CoreDataStack.html":{"name":"CoreDataStack","abstract":"
An instance of CoreDataStack
encapsulates the entire Core Data stack."},"getting-started.html":{"name":"Getting Started"},"Guides.html":{"name":"Guides","abstract":"
The following guides are available globally.
"},"Classes.html":{"name":"Classes","abstract":"The following classes are available globally.
"},"Global Variables.html":{"name":"Global Variables","abstract":"The following global variables are available globally.
"},"Enums.html":{"name":"Enumerations","abstract":"The following enumerations are available globally.
"},"Functions.html":{"name":"Functions","abstract":"The following functions are available globally.
"},"Protocols.html":{"name":"Protocols","abstract":"The following protocols are available globally.
"},"Structs.html":{"name":"Structures","abstract":"The following structures are available globally.
"},"Typealiases.html":{"name":"Type Aliases","abstract":"The following type aliases are available globally.
"}} \ No newline at end of file +{"Structs/CoreDataStackFactory.html#/s:14JSQCoreDataKit04CoreB12StackFactoryV22PersistentStoreOptionsa":{"name":"PersistentStoreOptions","abstract":"Describes the initialization options for a persistent store.
","parent_name":"CoreDataStackFactory"},"Structs/CoreDataStackFactory.html#/s:14JSQCoreDataKit04CoreB12StackFactoryV19defaultStoreOptionsSDys11AnyHashableVypGvpZ":{"name":"defaultStoreOptions","abstract":"Describes default persistent store options.
","parent_name":"CoreDataStackFactory"},"Structs/CoreDataStackFactory.html#/s:14JSQCoreDataKit04CoreB12StackFactoryV5modelAA0dB5ModelVvp":{"name":"model","abstract":"The model for the stack that the factory produces.
","parent_name":"CoreDataStackFactory"},"Structs/CoreDataStackFactory.html#/s:14JSQCoreDataKit04CoreB12StackFactoryV7optionsSDys11AnyHashableVypGSgvp":{"name":"options","abstract":"A dictionary that specifies options for the store that the factory produces.","parent_name":"CoreDataStackFactory"},"Structs/CoreDataStackFactory.html#/s:14JSQCoreDataKit04CoreB12StackFactoryV5model7optionsAcA0dB5ModelV_SDys11AnyHashableVypGSgtcfc":{"name":"init(model:options:)","abstract":"
Constructs a new CoreDataStackFactory
instance with the specified model
and options
.
Initializes a new CoreDataStack
instance using the factory’s model
and options
.
The name of the Core Data model resource.
","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV6bundleSo8NSBundleCvp":{"name":"bundle","abstract":"The bundle in which the model is located.
","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV9storeTypeAA05StoreG0Ovp":{"name":"storeType","abstract":"The type of the Core Data persistent store for the model.
","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV8storeURL10Foundation0G0VSgvp":{"name":"storeURL","abstract":"The file URL specifying the full path to the store.
","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV8modelURL10Foundation0G0Vvp":{"name":"modelURL","abstract":"The file URL specifying the model file in the bundle specified by bundle
.
The database file name for the store.
","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV013managedObjectE0So09NSManagedgE0Cvp":{"name":"managedObjectModel","abstract":"The managed object model for the model specified by name
.
Queries the meta data for the persistent store specified by the receiver","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV4name6bundle9storeTypeACSS_So8NSBundleCAA05StoreI0Otcfc":{"name":"init(name:bundle:storeType:)","abstract":"
Constructs a new CoreDataModel
instance with the specified name and bundle.
Removes the existing model store specfied by the receiver.
","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV19defaultDirectoryURL10Foundation0H0VyFZ":{"name":"defaultDirectoryURL()","abstract":"The default directory used to initialize a CoreDataModel
.","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html#/s:14JSQCoreDataKit04CoreB5ModelV7migrateyyKF":{"name":"migrate()","abstract":"
Progressively migrates the persistent store of the CoreDataModel
based on mapping models found in the model’s bundle.","parent_name":"CoreDataModel"},"Structs/CoreDataModel.html":{"name":"CoreDataModel","abstract":"
An instance of CoreDataModel
represents a Core Data model — a .xcdatamodeld
file package."},"Structs/CoreDataStackFactory.html":{"name":"CoreDataStackFactory","abstract":"
An instance of CoreDataStackFactory
is responsible for creating instances of CoreDataStack
.
The name of the entity.
","parent_name":"CoreDataEntityProtocol"},"Protocols/CoreDataEntityProtocol.html#/s:14JSQCoreDataKit04CoreB14EntityProtocolP22defaultSortDescriptorsSaySo16NSSortDescriptorCGvpZ":{"name":"defaultSortDescriptors","abstract":"The default sort descriptors for a fetch request.
","parent_name":"CoreDataEntityProtocol"},"Protocols/CoreDataEntityProtocol.html#/s:14JSQCoreDataKit04CoreB14EntityProtocolPAASo15NSManagedObjectCRbzrlE12fetchRequestSo07NSFetchJ0CyxGvpZ":{"name":"fetchRequest","abstract":"Returns a new fetch request with defaultSortDescriptors
.
Returns the entity with the specified name from the managed object model associated","parent_name":"CoreDataEntityProtocol"},"Protocols/CoreDataEntityProtocol.html":{"name":"CoreDataEntityProtocol","abstract":"
Describes an entity in Core Data.
"},"Extensions/NSManagedObjectContext.html#/s:So22NSManagedObjectContextC14JSQCoreDataKitE05ChildC0a":{"name":"ChildContext","abstract":"Describes a child managed object context.
","parent_name":"NSManagedObjectContext"},"Extensions/NSManagedObjectContext.html#/s:So22NSManagedObjectContextC14JSQCoreDataKitE4save4wait10completionySb_yAC10SaveResultOcSgtF":{"name":"save(wait:completion:)","abstract":"Attempts to commit unsaved changes to registered objects in the context.","parent_name":"NSManagedObjectContext"},"Extensions/NSManagedObjectContext.html":{"name":"NSManagedObjectContext"},"Enums/StoreType.html#/s:14JSQCoreDataKit9StoreTypeO6sqliteyAC10Foundation3URLVcACmF":{"name":"sqlite(_:)","abstract":"
The SQLite database store type. The associated file URL specifies the directory for the store.
","parent_name":"StoreType"},"Enums/StoreType.html#/s:14JSQCoreDataKit9StoreTypeO6binaryyAC10Foundation3URLVcACmF":{"name":"binary(_:)","abstract":"The binary store type. The associated file URL specifies the directory for the store.
","parent_name":"StoreType"},"Enums/StoreType.html#/s:14JSQCoreDataKit9StoreTypeO8inMemoryyA2CmF":{"name":"inMemory","abstract":"The in-memory store type.
","parent_name":"StoreType"},"Enums/StoreType.html#/s:14JSQCoreDataKit9StoreTypeO4typeSSvp":{"name":"type","abstract":"Returns the type string description for the store type.
","parent_name":"StoreType"},"Enums/StoreType.html#/s:14JSQCoreDataKit9StoreTypeO14storeDirectory10Foundation3URLVSgyF":{"name":"storeDirectory()","abstract":"The success result, containing the successfully initialized CoreDataStack
.
The failure result, containing an NSError
instance that describes the error.
The success result.
","parent_name":"SaveResult"},"Enums/SaveResult.html#/s:14JSQCoreDataKit10SaveResultO7failureyACSo7NSErrorCcACmF":{"name":"failure(_:)","abstract":"The failure result, containing an NSError
instance that describes the error.
Specifies that the NSManagedObjectModel
corresponding to the existing persistent store was not found in the model’s bundle.
Specifies that an NSMappingModel
was not found in the model’s bundle in the progressive migration ‘path’.
The extension for a model bundle, or a .xcdatamodeld
file package.
The extension for a versioned model file, or a .xcdatamodel
file.
The extension for a mapping model file, or a .xcmappingmodel
file.
The extension for a sqlite store.
","parent_name":"ModelFileExtension"},"Enums/ModelFileExtension.html":{"name":"ModelFileExtension","abstract":"Describes a Core Data model file exention type based on the"},"Enums/MigrationError.html":{"name":"MigrationError","abstract":"
An error type that specifies possible errors that are thrown by calling CoreDataModel.migrate() throws
.
A result object representing the result of saving an NSManagedObjectContext
.
A result object representing the result of creating a CoreDataStack
via a CoreDataStackFactory
.
Describes a Core Data persistent store type.
"},"Classes/CoreDataStack.html#/s:14JSQCoreDataKit04CoreB5StackC5modelAA0dB5ModelVvp":{"name":"model","abstract":"The model for the stack.
","parent_name":"CoreDataStack"},"Classes/CoreDataStack.html#/s:14JSQCoreDataKit04CoreB5StackC11mainContextSo015NSManagedObjectG0Cvp":{"name":"mainContext","abstract":"The main managed object context for the stack, which operates on the main queue.","parent_name":"CoreDataStack"},"Classes/CoreDataStack.html#/s:14JSQCoreDataKit04CoreB5StackC17backgroundContextSo015NSManagedObjectG0Cvp":{"name":"backgroundContext","abstract":"
The background managed object context for the stack, which operates on a background queue.","parent_name":"CoreDataStack"},"Classes/CoreDataStack.html#/s:14JSQCoreDataKit04CoreB5StackC16storeCoordinatorSo017NSPersistentStoreG0Cvp":{"name":"storeCoordinator","abstract":"
The persistent store coordinator for the stack. Both contexts are connected to this coordinator.
","parent_name":"CoreDataStack"},"Classes/CoreDataStack.html#/s:14JSQCoreDataKit04CoreB5StackC12childContext15concurrencyType011mergePolicyI0So015NSManagedObjectG0CSo0lmg11ConcurrencyI0V_So07NSMergekI0VtF":{"name":"childContext(concurrencyType:mergePolicyType:)","abstract":"Creates a new child context with the specified concurrencyType
and mergePolicyType
.
Resets the managed object contexts in the stack on their respective threads.","parent_name":"CoreDataStack"},"Classes/CoreDataStack.html":{"name":"CoreDataStack","abstract":"
An instance of CoreDataStack
encapsulates the entire Core Data stack."},"getting-started.html":{"name":"Getting Started"},"Guides.html":{"name":"Guides","abstract":"
The following guides are available globally.
"},"Classes.html":{"name":"Classes","abstract":"The following classes are available globally.
"},"Enums.html":{"name":"Enumerations","abstract":"The following enumerations are available globally.
"},"Extensions.html":{"name":"Extensions","abstract":"The following extensions are available globally.
"},"Protocols.html":{"name":"Protocols","abstract":"The following protocols are available globally.
"},"Structs.html":{"name":"Structures","abstract":"The following structures are available globally.
"}} \ No newline at end of file