Homepage

ModelSchema

Last edit: Oct 13, 2026

Model schema, the former name of a table (app/schema). Deprecated, use Table instead

type ModelSchema implements AdminPropertiesInterface, AdminSharedAttributesInterface {
  created_at: JSONDate!
  fields: [Property!]!
  id: ID!
  manually_managed: Boolean
  metadata: HashObject
  name: String!
  parameterized_name: String!
  physical_file_path: String
  properties: [Property!]!
  updated_at: JSONDate!
}

Fields

created_at (JSONDate)

Timestamp of when the object was created, set automatically by the system

fields (Property)

Deprecated, use properties instead

id (ID)

Unique identifier of the object

manually_managed (Boolean)

When true, the resource is managed outside of files: pos-cli deploy and sync never overwrite or delete it

metadata (HashObject)

Free-form data attached to the resource with the metadata key of its file (or the metadata argument of an admin mutation)

name (String)

Name of the model schema, as given in its file

parameterized_name (String)

Name used to refer to the model schema in queries and mutations: the name in
lower case with spaces replaced by underscores, prefixed with modules/<module
name>/ for a module

physical_file_path (String)

Path of the file the resource comes from, relative to the app directory, for
example views/pages/index.liquid or
modules/my_module/public/views/partials/header.liquid. Identifies the resource
in deploy, sync and admin mutations

properties (Property)

Properties defined in the schema, sorted by name

updated_at (JSONDate)

Timestamp of when the object was last updated, set automatically by the system

Interfaces

AdminPropertiesInterface

Schema that defines properties

AdminSharedAttributesInterface

Attributes shared by resources that can be deployed from files with pos-cli
(pages, partials, layouts, notifications, authorization policies, schemas, assets etc.)

Questions?

We are always happy to help with any questions you may have.

contact us