Homepage

GraphqlInputType

Last edit: Oct 13, 2026

Attributes of a stored GraphQL query or mutation, the same ones as a graphql/*.graphql file

type GraphqlInputType {
  body: String!
  manually_managed: Boolean
  metadata: HashObject
  physical_file_path: String!
}

Fields

body (String)

GraphQL document of the query or mutation; it must be valid against the schema

manually_managed (Boolean)

When true, pos-cli deploy and sync never overwrite or delete it and pos-cli
pull skips it. When omitted, defaults to the track_manually_managed setting of
the instance (false unless enabled in app/config.yml)

metadata (HashObject)

Arbitrary JSON data stored with the query

physical_file_path (String)

Path of the file the query is stored as, used by pos-cli pull and deploy. Must
be under graphql/ (or legacy graph_queries/), optionally prefixed with
modules/<module_name>/public/ or modules/<module_name>/private/, for
example graphql/users/search.graphql. The query name used by the graphql tag
is derived from it, for example users/search

Questions?

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

contact us