ModelSchema

public struct ModelSchema

Warning

Although this has public access, it is intended for internal & codegen use and should not be used directly by host applications. The behavior of this may change without warning.

name
Declaration
Swift

public let name: String
pluralName
Declaration
Swift

public let pluralName: String?
listPluralName
Declaration
Swift

public let listPluralName: String?
syncPluralName
Declaration
Swift

public let syncPluralName: String?
authRules
Declaration
Swift

public let authRules: AuthRules
fields
Declaration
Swift

public let fields: ModelFields
attributes
Declaration
Swift

public let attributes: [ModelAttribute]
indexes
Declaration
Swift

public let indexes: [ModelAttribute]
sortedFields
Declaration
Swift

public let sortedFields: [ModelField]


                    
                    
                    primaryKey

Declaration

Swift

public var primaryKey: ModelPrimaryKey { get }


                    
                    
                    init(name:pluralName:listPluralName:syncPluralName:authRules:attributes:fields:primaryKeyFieldKeys:)

Declaration

Swift

public init(
    name: String,
    pluralName: String? = nil,
    listPluralName: String? = nil,
    syncPluralName: String? = nil,
    authRules: AuthRules = [],
    attributes: [ModelAttribute] = [],
    fields: ModelFields = [:],
    primaryKeyFieldKeys: [ModelFieldName] = []
)


                    
                    
                    field(withName:)

Declaration

Swift

public func field(withName name: String) -> ModelField?

isSyncable
Declaration
Swift

var isSyncable: Bool { get }
isSystem
Declaration
Swift

var isSystem: Bool { get }


                    
                    
                    hasAuthenticationRules

Declaration

Swift

var hasAuthenticationRules: Bool { get }

hasAssociations
Declaration
Swift

var hasAssociations: Bool { get }

ModelAttribute + Index

primaryKeyIndexFields
Returns the list of fields that make up the primary key for the model. In case of a custom primary key, the model has a @key directive without a name and at least 1 field
Declaration
Swift

var primaryKeyIndexFields: [ModelFieldName]? { get }