Graphql schema documentation
- schema {
- # The query root of Snowflake's GraphQL interface.
- Query :
- # The mutation root of Snowflake's GraphQL interface. Snowflake provides mutations
- # that implement Relay Input Object Mutations Specifications.
- Mutation :
- # The subscription root of Snowflake's GraphQL interface.
- #
- # Snowflake provides two types of definition in its framework queries:
- #
- # * `onVerbObject`
- #
- # * `onObjectVerb(UUID!)`
- #
- # `onVerbObject` subscriptions are global, and are broadcast whenever the
- # corresponding mutation occurs. These can be used to subscribe to mutations that
- # are triggered by the client.
- # `onObjectVerb(UUID!)` subscriptions are primarily used by scraping,
- # installation, and orchestration mutations. These are used to subscribe to events
- # happening on a specific long-existing object that may or may not be the result
- # of a client request.
- #
- # There is some subtlely in the different types of subscriptions that one should
- # be aware about.
- #
- # For example, `onStopEmulation` is broadcast when the `stopEmulation` mutation
- # responds to some client. However, `onEmulationStop` is broadcast when the
- # emulation process exits. Hence, `onStopEmulation` may never be broadcast, even
- # if `onEmulationStop` was.
- #
- # In most cases, it is more useful to subscribe to the `onObjectVerb` subscription
- # for an object whenever feasible.
- Subscription :
- }