<!--
{
  "availability" : [
    "iOS: 17.0.0 -",
    "iPadOS: 17.0.0 -",
    "macCatalyst: 17.0.0 -",
    "macOS: 14.0.0 -",
    "swift: 5.9.0 -",
    "tvOS: 17.0.0 -",
    "visionOS: 1.0.0 -",
    "watchOS: 10.0.0 -"
  ],
  "documentType" : "symbol",
  "framework" : "SwiftData",
  "identifier" : "/documentation/SwiftData/PersistentModel",
  "metadataVersion" : "0.1.0",
  "role" : "Protocol",
  "symbol" : {
    "kind" : "Protocol",
    "modules" : [
      "SwiftData"
    ],
    "preciseIdentifier" : "s:9SwiftData15PersistentModelP"
  },
  "title" : "PersistentModel"
}
-->

# PersistentModel

An interface that enables SwiftData to manage a Swift class as a stored model.

```
protocol PersistentModel : AnyObject, Observable, Hashable, Identifiable, SendableMetatype
```

## Topics

### Creating a persistent model

[`init(backingData:)`](/documentation/SwiftData/PersistentModel/init(backingData:))

### Identifying the model instance

[`persistentModelID`](/documentation/SwiftData/PersistentModel/persistentModelID)

[`PersistentIdentifier`](/documentation/SwiftData/PersistentIdentifier)

A type that describes the aggregate identity of a SwiftData model.

[`modelContext`](/documentation/SwiftData/PersistentModel/modelContext)

### Accessing a value by key path

[`getValue(forKey:)`](/documentation/SwiftData/PersistentModel/getValue(forKey:)-299oe)

[`getValue(forKey:)`](/documentation/SwiftData/PersistentModel/getValue(forKey:)-3o59k)

[`getValue(forKey:)`](/documentation/SwiftData/PersistentModel/getValue(forKey:)-4cs0c)

[`getValue(forKey:)`](/documentation/SwiftData/PersistentModel/getValue(forKey:)-5m792)

[`getValue(forKey:)`](/documentation/SwiftData/PersistentModel/getValue(forKey:)-998oq)

[`getTransformableValue(forKey:)`](/documentation/SwiftData/PersistentModel/getTransformableValue(forKey:))

### Modifying a value by key path

[`setValue(forKey:to:)`](/documentation/SwiftData/PersistentModel/setValue(forKey:to:)-18176)

[`setValue(forKey:to:)`](/documentation/SwiftData/PersistentModel/setValue(forKey:to:)-3mmp2)

[`setValue(forKey:to:)`](/documentation/SwiftData/PersistentModel/setValue(forKey:to:)-3uqwc)

[`setValue(forKey:to:)`](/documentation/SwiftData/PersistentModel/setValue(forKey:to:)-8wepb)

[`setValue(forKey:to:)`](/documentation/SwiftData/PersistentModel/setValue(forKey:to:)-xt24)

[`setTransformableValue(forKey:to:)`](/documentation/SwiftData/PersistentModel/setTransformableValue(forKey:to:))

### Accessing supplementary information

[`schemaMetadata`](/documentation/SwiftData/PersistentModel/schemaMetadata)

[`persistentBackingData`](/documentation/SwiftData/PersistentModel/persistentBackingData)

[`hasChanges`](/documentation/SwiftData/PersistentModel/hasChanges)

[`isDeleted`](/documentation/SwiftData/PersistentModel/isDeleted)

### Internal

[Internal symbols](/documentation/SwiftData/PersistentModelInternal)

Restricted-use symbols that the framework requires for macro expansion and
other internal tasks.



---

Copyright &copy; 2026 Apple Inc. All rights reserved. | [Terms of Use](https://www.apple.com/legal/internet-services/terms/site.html) | [Privacy Policy](https://www.apple.com/privacy/privacy-policy)