One Logo Pool Ball
SwiftData · IOS API REFERENCE

ModelConfiguration

struct · iOS 17.0+ · SDK 27.1

struct ModelConfiguration

A type that describes the configuration of an app's schema or specific group of models.

Members (16)

get · iOS 17.0+

allowsSave

TypeScript
get allowsSave(): boolean
Swift declaration
let allowsSave: Bool
get · iOS 17.0+

groupContainer

TypeScript
get groupContainer(): ModelConfiguration_GroupContainer
Swift declaration
let groupContainer: ModelConfiguration.GroupContainer
get · iOS 17.0+

cloudKitDatabase

TypeScript
get cloudKitDatabase(): ModelConfiguration_CloudKitDatabase
Swift declaration
let cloudKitDatabase: ModelConfiguration.CloudKitDatabase
get · iOS 17.0+

debugDescription

TypeScript
get debugDescription(): string
Swift declaration
var debugDescription: String { get }

A textual representation of this instance, suitable for debugging. Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the `String(reflecting:)` initializer. This initializer works with any type, and uses the custom `debugDescription` property for types that conform to `CustomDebugStringConvertible`: struct Point: CustomDebugStringConvertible { let x: Int, y: Int var debugDescription: String { return "(\(x), \(y))" } } let p = Point(x: 21, y: 30) let s = String(reflecting: p) print(s) // Prints "(21, 30)" The conversion of `p` to a string in the assignment to `s` uses the `Point` type's `debugDescription` property.

init · iOS 17.0+

init

TypeScript
static initIsStoredInMemoryOnly(isStoredInMemoryOnly?: boolean): ModelConfiguration
Swift declaration
init(isStoredInMemoryOnly: Bool = false)
get · iOS 17.0+

isStoredInMemoryOnly

TypeScript
get isStoredInMemoryOnly(): boolean
Swift declaration
let isStoredInMemoryOnly: Bool
get · iOS 17.0+

cloudKitContainerIdentifier

TypeScript
get cloudKitContainerIdentifier(): (string) | null
Swift declaration
let cloudKitContainerIdentifier: String?
get · iOS 17.0+

groupAppContainerIdentifier

TypeScript
get groupAppContainerIdentifier(): (string) | null
Swift declaration
let groupAppContainerIdentifier: String?
get · iOS 17.0+

id

TypeScript
get id(): string
Swift declaration
var id: URL { get }

The stable identity of the entity associated with this instance.

get · iOS 17.0+

url

TypeScript
get url(): string
Swift declaration
let url: URL
get · iOS 17.0+

name

TypeScript
get name(): string
Swift declaration
let name: String
get · iOS 17.0+

schema

TypeScript
get schema(): (Schema) | null
Swift declaration
var schema: Schema?
set · iOS 17.0+

schema

TypeScript
set schema(value: (Schema) | null)
Swift declaration
var schema: Schema?
method · iOS 18.0+

validate

TypeScript
validate(): void
Swift declaration
func validate() throws
init · iOS 17.0+

init

TypeScript
static initSchemaIsStoredInMemoryOnlyAllowsSaveGroupContainerCloudKitDatabase(name?: (string) | null, schema?: (Schema) | null, isStoredInMemoryOnly?: boolean, allowsSave?: boolean, groupContainer?: ModelConfiguration_GroupContainer, cloudKitDatabase?: ModelConfiguration_CloudKitDatabase): ModelConfiguration
Swift declaration
init(_ name: String? = nil, schema: Schema? = nil, isStoredInMemoryOnly: Bool = false, allowsSave: Bool = true, groupContainer: ModelConfiguration.GroupContainer = .automatic, cloudKitDatabase: ModelConfiguration.CloudKitDatabase = .automatic)
init · iOS 17.0+

init

TypeScript
static initSchemaUrlAllowsSaveCloudKitDatabase(name: (string) | null, schema: (Schema) | null, url: string, allowsSave?: boolean, cloudKitDatabase?: ModelConfiguration_CloudKitDatabase): ModelConfiguration
Swift declaration
init(_ name: String? = nil, schema: Schema? = nil, url: URL, allowsSave: Bool = true, cloudKitDatabase: ModelConfiguration.CloudKitDatabase = .automatic)

Skipped declarations

1 declarations were excluded from these bindings. Each reason comes from the generator or the iOS SDK compiler.

ModelConfiguration.init(for:isStoredInMemoryOnly:)

Passing a Swift type itself is not supported.

All SwiftData types →