diff --git a/docs/Classes.html b/docs/Classes.html index c1c4222..442faf0 100644 --- a/docs/Classes.html +++ b/docs/Classes.html @@ -21,20 +21,20 @@

- CoreStore Docs + CoreStore 9.1.0 Docs - (90% documented) + (91% documented)

-

+

-

+

- + GitHub View on GitHub

@@ -43,7 +43,7 @@

CoreStore Reference - + Classes Reference

@@ -59,81 +59,6 @@
  • BaseDataTransaction
    • -
  • - CSAsynchronousDataTransaction -
    • -
  • - CSBaseDataTransaction -
    • -
  • - CSCoreStore -
    • -
  • - CSDataStack -
    • -
  • - CSError -
    • -
  • - CSFrom -
    • -
  • - CSGroupBy -
    • -
  • - CSInMemoryStore -
    • -
  • - CSInto -
    • -
  • - CSListMonitor -
    • -
  • - CSMigrationResult -
    • -
  • - CSMigrationType -
    • -
  • - CSObjectMonitor -
    • -
  • - CSOrderBy -
    • -
  • - CSSQLiteStore -
    • -
  • - CSSectionBy -
    • -
  • - CSSelect -
    • -
  • - CSSelectTerm -
    • -
  • - CSSetupResult -
    • -
  • - CSSynchronousDataTransaction -
    • -
  • - CSTweak -
    • -
  • - CSUnsafeDataModelSchema -
    • -
  • - CSUnsafeDataTransaction -
    • -
  • - CSWhere -
    • -
  • - CSXcodeDataModelSchema -
  • CoreStoreObject
    • @@ -170,6 +95,15 @@
  • DataStack
    • +
  • + – AsyncNamespace +
    • +
  • + – ReactiveNamespace +
    • +
  • + – AddStoragePublisher +
  • DefaultLogger
    • @@ -188,9 +122,27 @@
  • ListMonitor
    • +
  • + ListPublisher +
    • +
  • + – ReactiveNamespace +
    • +
  • + – SnapshotPublisher +
  • ObjectMonitor
    • +
  • + ObjectPublisher +
    • +
  • + – ReactiveNamespace +
    • +
  • + – SnapshotPublisher +
  • SQLiteStore
    • @@ -218,10 +170,10 @@
  • - Global Variables + Global Variables
    • @@ -229,13 +181,7 @@ Enumerations + +
    +
    + + +
    + +

    SQLiteStore +

    +
    +
    +
      +
    • +
      + + + + SQLiteStore + +
      +
      +
      +
      +
      +
      +

      A storage interface that is backed by an SQLite database.

      +
      +

      Warning

      + The default SQLite file location for the LegacySQLiteStore and SQLiteStore are different. If the app was depending on CoreStore’s default directories prior to 2.0.0, make sure to use the SQLiteStore.legacy(...) factory methods to create the SQLiteStore instead of using initializers directly. + +
      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public final class SQLiteStore : LocalStorage
      +
      extension SQLiteStore: CustomDebugStringConvertible, CoreStoreDebugStringConvertible
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    SynchronousDataTransaction +

    +
    +
    +
      +
    • + +
      +
      +
      +
      +
      +

      The SynchronousDataTransaction provides an interface for DynamicObject creates, updates, and deletes. A transaction object should typically be only used from within a transaction block initiated from DataStack.beginSynchronous(_:).

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public final class SynchronousDataTransaction : BaseDataTransaction
      +
      extension SynchronousDataTransaction: CustomDebugStringConvertible, CoreStoreDebugStringConvertible
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    UnsafeDataTransaction +

    +
    +
    +
      +
    • +
      + + + + UnsafeDataTransaction + +
      +
      +
      +
      +
      +
      +

      The UnsafeDataTransaction provides an interface for non-contiguous NSManagedObject or CoreStoreObject creates, updates, and deletes. This is useful for making temporary changes, such as partially filled forms. An unsafe transaction object should typically be only used from the main queue.

      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public final class UnsafeDataTransaction : BaseDataTransaction
      +
      extension UnsafeDataTransaction: CustomDebugStringConvertible, CoreStoreDebugStringConvertible
      + +
      +
      +
      +
      +
      • +
    +
    +
    +
    + + +
    + +

    XcodeDataModelSchema +

    +
    +
    +
      +
    • +
      + + + + XcodeDataModelSchema + +
      +
      +
      +
      +
      +
      +

      The XcodeDataModelSchema describes a model version declared in a single *.xcdatamodeld file.

      +
      CoreStoreDefaults.dataStack = DataStack(
+    XcodeDataModelSchema(modelName: "MyAppV1", bundle: .main)
+)
+
      + + See more +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public final class XcodeDataModelSchema : DynamicSchema
      +
      extension XcodeDataModelSchema: CustomDebugStringConvertible, CoreStoreDebugStringConvertible
      @@ -2763,9 +1934,11 @@ Observers registered via addObserver(_:) are not retained. Li
      - -

      CoreStoreObjectValueDiff

      -       +
      + +

      CoreStoreObjectValueDiff +

      +
      • @@ -2796,17 +1969,6 @@ Observers registered via addObserver(_:) are not retained. Li
      • -
    -
    -
    -
    - - - -

    CoreStoreObjectValueDiff

    -     -
    -
  • - Global Variables + Global Variables
    • @@ -229,13 +181,7 @@ Enumerations
    @@ -1003,7 +1147,7 @@

    Declaration

    Swift

    - 
    public override func create<D>(_ into: Into<D>) -> D where D : DynamicObject
    + 
    public override func create<O>(_ into: Into<O>) -> O where O : DynamicObject
    @@ -1038,7 +1182,7 @@ - edit(_:) + edit(_:)
    @@ -1053,7 +1197,7 @@

    Declaration

    Swift

    - 
    public override func edit<D>(_ object: D?) -> D? where D : DynamicObject
    + 
    public override func edit<O>(_ object: O?) -> O? where O : DynamicObject
    @@ -1088,7 +1232,7 @@ - edit(_:_:) + edit(_:_:)
    @@ -1103,7 +1247,7 @@

    Declaration

    Swift

    - 
    public override func edit<D>(_ into: Into<D>, _ objectID: NSManagedObjectID) -> D? where D : DynamicObject
    + 
    public override func edit<O>(_ into: Into<O>, _ objectID: NSManagedObjectID) -> O? where O : DynamicObject
    @@ -1148,9 +1292,9 @@
  • @@ -1158,14 +1302,60 @@
    -

    Deletes a specified NSManagedObject or CoreStoreObject.

    +

    Deletes the objects with the specified NSManagedObjectIDs.

    Declaration

    Swift

    - 
    public override func delete<D>(_ object: D?) where D : DynamicObject
    + 
    public override func delete<S>(objectIDs: S) where S : Sequence, S.Element : NSManagedObjectID
    + +
    +
    +
    +

    Parameters

    + + + + + + + +
    + + objectIDs + + +
    +

    the NSManagedObjectIDs of the objects to delete

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + delete(_:_:) + +
    +
    +
    +
    +
    +
    +

    Deletes the specified NSManagedObjects or CoreStoreObjects represented by series of ObjectRepresentations.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public override func delete<O>(_ object: O?, _ objects: O?...) where O : ObjectRepresentation
    @@ -1181,65 +1371,7 @@
    -

    the NSManagedObject or CoreStoreObject to be deleted

    -
    - - - - -
    - - -
    • -
  • -
    - - - - delete(_:_:_:) - -
    -
    -
    -
    -
    -
    -

    Deletes the specified DynamicObjects.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public override func delete<D>(_ object1: D?, _ object2: D?, _ objects: D?...) where D : DynamicObject
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - @@ -1251,7 +1383,7 @@ @@ -1264,9 +1396,9 @@
  • @@ -1274,14 +1406,14 @@
    -

    Deletes the specified DynamicObjects.

    +

    Deletes the specified NSManagedObjects or CoreStoreObjects represented by an ObjectRepresenation.

    Declaration

    Swift

    - 
    public override func delete<S>(_ objects: S) where S : Sequence, S.Element : DynamicObject
    + 
    public override func delete<S>(_ objects: S) where S : Sequence, S.Element : ObjectRepresentation
    @@ -1297,7 +1429,7 @@
    • @@ -1309,50 +1441,15 @@ -
    -
    - - - -

    CoreStoreSwiftType

    -     -
    - -
    - -

    CustomDebugStringConvertible

    -     +
    + +

    CustomDebugStringConvertible +

    +
    • @@ -1389,9 +1486,8 @@
    -

    © 2019 John Estropia. All rights reserved. (Last updated: 2019-03-31)

    -

    Generated by jazzy ♪♫ v0.9.5, a Realm project.

    +

    © 2023 John Estropia. All rights reserved. (Last updated: 2023-06-08)

    +

    Generated by jazzy ♪♫ v0.14.3, a Realm project.

    - diff --git a/docs/Classes/BaseDataTransaction.html b/docs/Classes/BaseDataTransaction.html index 10644a0..d708630 100644 --- a/docs/Classes/BaseDataTransaction.html +++ b/docs/Classes/BaseDataTransaction.html @@ -21,20 +21,20 @@

    - CoreStore Docs + CoreStore 9.1.0 Docs - (90% documented) + (91% documented)

    -

    +

    -

    +

    - + GitHub View on GitHub

    @@ -43,7 +43,7 @@

    CoreStore Reference - + BaseDataTransaction Class Reference

    @@ -59,81 +59,6 @@
  • BaseDataTransaction
    • -
  • - CSAsynchronousDataTransaction -
    • -
  • - CSBaseDataTransaction -
    • -
  • - CSCoreStore -
    • -
  • - CSDataStack -
    • -
  • - CSError -
    • -
  • - CSFrom -
    • -
  • - CSGroupBy -
    • -
  • - CSInMemoryStore -
    • -
  • - CSInto -
    • -
  • - CSListMonitor -
    • -
  • - CSMigrationResult -
    • -
  • - CSMigrationType -
    • -
  • - CSObjectMonitor -
    • -
  • - CSOrderBy -
    • -
  • - CSSQLiteStore -
    • -
  • - CSSectionBy -
    • -
  • - CSSelect -
    • -
  • - CSSelectTerm -
    • -
  • - CSSetupResult -
    • -
  • - CSSynchronousDataTransaction -
    • -
  • - CSTweak -
    • -
  • - CSUnsafeDataModelSchema -
    • -
  • - CSUnsafeDataTransaction -
    • -
  • - CSWhere -
    • -
  • - CSXcodeDataModelSchema -
  • CoreStoreObject
    • @@ -170,6 +95,15 @@
  • DataStack
    • +
  • + – AsyncNamespace +
    • +
  • + – ReactiveNamespace +
    • +
  • + – AddStoragePublisher +
  • DefaultLogger
    • @@ -188,9 +122,27 @@
  • ListMonitor
    • +
  • + ListPublisher +
    • +
  • + – ReactiveNamespace +
    • +
  • + – SnapshotPublisher +
  • ObjectMonitor
    • +
  • + ObjectPublisher +
    • +
  • + – ReactiveNamespace +
    • +
  • + – SnapshotPublisher +
  • SQLiteStore
    • @@ -218,10 +170,10 @@
  • - Global Variables + Global Variables
    • @@ -229,13 +181,7 @@ Enumerations
    - - object1 - - -
    -

    the DynamicObject to be deleted

    -
    -
    - - object2 - - -
    -

    another DynamicObject to be deleted

    +

    the ObjectRepresentation representing an NSManagedObject or CoreStoreObject to be deleted
    -

    other DynamicObjects to be deleted

    +

    other ObjectRepresentations representing NSManagedObjects or CoreStoreObjects to be deleted
    -

    the DynamicObjects to be deleted

    +

    the ObjectRepresenations representing NSManagedObjects or CoreStoreObjects to be deleted
    + + + + + + +
    + + objectIDs + + +
    +

    the NSManagedObjectIDs of the objects to delete

    +
    +
    +
    +
    +
    +
    • +
  • +
    + + + + delete(_:_:) + +
    +
    +
    +
    +
    +
    +

    Deletes the specified NSManagedObjects or CoreStoreObjects represented by series of ObjectRepresentations.

    + +
    +
    +

    Declaration

    +
    +

    Swift

    + 
    public func delete<O>(_ object: O?, _ objects: O?...) where O : ObjectRepresentation
    @@ -1130,65 +1318,7 @@
    -

    the NSManagedObject or CoreStoreObject to be deleted

    -
    - - - - -
    - - -
    • -
  • -
    - - - - delete(_:_:_:) - -
    -
    -
    -
    -
    -
    -

    Deletes the specified NSManagedObjects or CoreStoreObjects.

    - -
    -
    -

    Declaration

    -
    -

    Swift

    - 
    public func delete<D>(_ object1: D?, _ object2: D?, _ objects: D?...) where D : DynamicObject
    - -
    -
    -
    -

    Parameters

    - - - - - - - - - @@ -1200,7 +1330,7 @@ @@ -1213,9 +1343,9 @@
  • @@ -1223,14 +1353,14 @@
    -

    Deletes the specified NSManagedObjects or CoreStoreObjects.

    +

    Deletes the specified NSManagedObjects or CoreStoreObjects represented by an ObjectRepresenation.

    Declaration

    Swift

    - 
    public func delete<S>(_ objects: S) where S : Sequence, S.Element : DynamicObject
    + 
    public func delete<S>(_ objects: S) where S : Sequence, S.Element : ObjectRepresentation
    @@ -1246,7 +1376,7 @@
    • @@ -1289,17 +1419,69 @@
    - -

    Inspecting Pending Objects

    -     +
    + +

    Inspecting Pending Objects +

    +
      +
    • + +
      +
      +
      +
      +
      +

      Returns true if the object has any property values changed. This method should not be called after the commit() method was called.

      + +
      +
      +

      Declaration

      +
      +

      Swift

      + 
      public func objectHasPersistentChangedValues<O>(_ object: O) -> Bool where O : DynamicObject
      + +
      +
      +
      +

      Parameters

      +
    - - object1 - - -
    -

    the NSManagedObject or CoreStoreObject to be deleted

    -
    -
    - - object2 - - -
    -

    another NSManagedObject or CoreStoreObject to be deleted

    +

    the ObjectRepresentation representing an NSManagedObject or CoreStoreObject to be deleted
    -

    other NSManagedObjects or CoreStoreObjects to be deleted

    +

    other ObjectRepresentations representing NSManagedObjects or CoreStoreObjects to be deleted
    -

    the NSManagedObjects or CoreStoreObjects to be deleted

    +

    the ObjectRepresenations representing NSManagedObjects or CoreStoreObjects to be deleted
    + + + + + + +
    + + object + + +
    +

    the DynamicObject instance

    +
    +
    +
    +
    +

    Return Value

    +

    true if the object has any property values changed.

    +
    +
    +
    +
  • @@ -1314,7 +1496,7 @@

    Declaration

    Swift

    - 
    public func insertedObjects<D>(_ entity: D.Type) -> Set<D> where D : DynamicObject, D : Hashable
    + 
    public func insertedObjects<O>(_ entity: O.Type) -> Set<O> where O : DynamicObject, O : Hashable
    @@ -1380,7 +1562,7 @@ - insertedObjectIDs(_:) + insertedObjectIDs(_:)
    @@ -1395,7 +1577,7 @@

    Declaration

    Swift

    - 
    public func insertedObjectIDs<D>(_ entity: D.Type) -> Set<NSManagedObjectID> where D : DynamicObject
    + 
    public func insertedObjectIDs<O>(_ entity: O.Type) -> Set<NSManagedObjectID> where O : DynamicObject
    @@ -1430,7 +1612,7 @@ - updatedObjects(_:) + updatedObjects(_:)
    @@ -1445,7 +1627,7 @@

    Declaration

    Swift

    - 
    public func updatedObjects<D>(_ entity: D.Type) -> Set<D> where D : DynamicObject, D : Hashable
    + 
    public func updatedObjects<O>(_ entity: O.Type) -> Set<O> where O : DynamicObject, O : Hashable
    @@ -1511,7 +1693,7 @@ - updatedObjectIDs(_:) + updatedObjectIDs(_:)
    @@ -1526,7 +1708,7 @@

    Declaration

    Swift

    - 
    public func updatedObjectIDs<D>(_ entity: D.Type) -> Set<NSManagedObjectID> where D : DynamicObject
    + 
    public func updatedObjectIDs<O>(_ entity: O.Type) -> Set<NSManagedObjectID> where O : DynamicObject
    @@ -1561,7 +1743,7 @@ - deletedObjects(_:) + deletedObjects(_:)
    @@ -1576,7 +1758,7 @@

    Declaration

    Swift

    - 
    public func deletedObjects<D>(_ entity: D.Type) -> Set<D> where D : DynamicObject, D : Hashable
    + 
    public func deletedObjects<O>(_ entity: O.Type) -> Set<O> where O : DynamicObject, O : Hashable
    @@ -1661,7 +1843,7 @@ - deletedObjectIDs(_:) + deletedObjectIDs(_:)
    @@ -1676,7 +1858,7 @@

    Declaration

    Swift

    - 
    public func deletedObjectIDs<D>(_ entity: D.Type) -> Set<NSManagedObjectID> where D : DynamicObject
    + 
    public func deletedObjectIDs<O>(_ entity: O.Type) -> Set<NSManagedObjectID> where O : DynamicObject
    @@ -1712,11 +1894,40 @@
    - -

    3rd Party Utilities

    -     +
    + +

    3rd Party Utilities +

    +