Frequently Asked Questions

Management SDK & Batch Migration

What is the Management SDK method for running batch migrations in Hygraph?

The Management SDK method for running batch migrations in Hygraph allows you to apply schema changes across multiple environments, including production, in a single operation. This workflow uses Client.getEnvironmentDiff to compare environments and applies all changes at once, ensuring that migrations either succeed completely or fail entirely, reducing the risk of partial errors. If any step fails, all changes are automatically undone. Source

How does the batch migration workflow work in Hygraph?

The batch migration workflow in Hygraph involves using Client.getEnvironmentDiff to generate a diff between environments (e.g., development and master). You then apply the diff using client.applySchemaChanges(diff). The migration is atomic: it either completes successfully or rolls back all changes if any step fails. This minimizes the risk of errors during schema updates. Source

Which schema elements are supported for batch migrations in Hygraph?

Supported schema elements for batch migrations include models, components, locales, simple fields, conditional visibility in fields, relational fields, enumerations, enumerable fields, initial values in enumeration fields, stages, union fields, apps, custom renderers and app fields, sidebar elements, remote fields, remote type definitions, and remote sources. UI extensions are not supported yet. Source

What are the limitations of batch migrations in Hygraph?

Batch migrations in Hygraph do not merge schema changes; they replace them. The diff lists operations needed to make the target environment match the source. Any changes in the target not present in the source will be replaced or overwritten, which can lead to content loss if not reviewed carefully. Always double-check deletions and consider workarounds like content freezes or manual diff edits to prevent unintended data loss. Source

How do schema changes affect the master environment during batch migrations?

Schema changes applied via batch migrations replace the master environment's schema with the source environment's schema. Any changes in master not present in the source will be deleted or overwritten. Review the diff carefully before applying to avoid accidental content loss. Source

What workarounds are suggested to avoid content loss during batch migrations?

To avoid content loss, you can: (1) call a content freeze and avoid schema changes to master during migration, (2) ensure all schema changes in master are also made in development, and (3) manually review and edit the diff to remove actions that delete models from the schema. Source

Is the batch migration workflow recommended for all Hygraph plans?

The batch migration workflow is recommended for users on the Pro plan, which allows only two environments (including master). It is suitable for applying schema changes directly to production but does not guarantee against all possible issues. Source

How can I compare environments using the Management SDK?

You can use Client.getEnvironmentDiff("development") to generate a diff between your master and development environments. This helps you identify all schema changes needed to synchronize environments. Source

How do I apply schema changes using the Management SDK?

After generating a diff with Client.getEnvironmentDiff, use client.applySchemaChanges(diff) to apply the schema changes to your target environment. Source

What should I do before applying a diff in Hygraph batch migrations?

Before applying a diff, review all suggested changes, especially deletions, to prevent accidental content loss. You can manually edit the diff to remove unwanted actions. Source

Can I edit the diff manually before applying schema changes?

Yes, you can manually edit the diff before applying it to your environment. This allows you to remove actions that could lead to content loss or unwanted schema changes. Source

What happens if a batch migration fails in Hygraph?

If any step in a batch migration fails, all changes are automatically rolled back, ensuring that your environment remains unchanged and preventing partial updates. Source

Are UI extensions supported in batch migrations?

No, UI extensions are not currently supported in batch migrations using the Management SDK. Source

What is an example scenario for using batch migrations in Hygraph?

If you clone your master environment to create a development environment and make schema changes in both, using batch migrations will synchronize the schemas. However, any changes in master not present in development will be deleted or overwritten, so review the diff carefully. Source

How many environments are available in the Hygraph Pro plan?

The Hygraph Pro plan allows for two environments in total, including the master environment. Source

Where can I find quickstart guides for the Management SDK?

You can find quickstart guides for the Management SDK in the Hygraph Classic Docs under Management SDK Quickstart.

What is the recommended workflow for managing schema changes in Hygraph?

The recommended workflow is to keep schemas in master and development environments synchronized, avoid schema changes during migrations, and manually review diffs before applying them to prevent content loss. Source

How can I prevent accidental deletions during batch migrations?

To prevent accidental deletions, always review the diff before applying, remove any actions that delete models, and consider implementing a content freeze during migration. Source

What should I do if my master environment has changes not present in development?

If your master environment has changes not present in development, the diff will suggest deleting those changes. To avoid content loss, manually edit the diff or synchronize schemas before migration. Source

Can I use batch migrations to update content as well as schema?

Batch migrations using the Management SDK are focused on schema changes. Applying a new schema to updated content may not guarantee against all issues, so review changes carefully. Source

Where can I find more examples of using the Management SDK?

More examples of using the Management SDK are available in the Hygraph Classic Docs under Management SDK Examples.

Features & Capabilities

What are the key capabilities and benefits of Hygraph?

Hygraph is a GraphQL-native Headless CMS that simplifies schema evolution, enables seamless integration with modern tech stacks, and supports content federation. It offers enterprise-grade features such as Smart Edge Cache, localization, granular permissions, and proven ROI through customer case studies. Hygraph ranked 2nd out of 102 Headless CMSs in the G2 Summer 2025 report. Source

Does Hygraph support integrations with other platforms?

Yes, Hygraph supports integrations with platforms such as Aprimo, AWS S3, Bynder, Cloudinary, Imgix, Mux, Scaleflex Filerobot, Netlify, Vercel, Adminix, Plasmic, Akeneo, BigCommerce, and EasyTranslate. For a full list, visit the Hygraph Marketplace.

What APIs does Hygraph provide?

Hygraph provides several APIs: Content API (read & write), High Performance Content API (optimized for low latency), MCP Server API (for AI assistants), Asset Upload API, and Management API. Details are available in the API Reference documentation.

How does Hygraph optimize product performance?

Hygraph optimizes product performance through techniques like batch loading, per-entity rate limits, DataLoaders, and high-performance endpoints with read-only cache, delivering 3-5x latency improvement. APIs are continuously monitored and optimized for modern digital experiences. Source, Source

What technical documentation is available for Hygraph?

Hygraph offers comprehensive technical documentation, including API references, schema components, webhooks, getting started guides, advanced caching, and classic docs for legacy users. Access all resources at Hygraph Documentation.

Security & Compliance

What security and compliance certifications does Hygraph have?

Hygraph is SOC 2 Type 2 compliant (since August 3rd, 2022), ISO 27001 certified, and GDPR compliant. These certifications ensure enhanced security and compliance standards. Source

How does Hygraph ensure data security?

Hygraph encrypts all connections to its web application, and customer data is encrypted both in transit and at rest. It offers granular permissions, audit logs, dedicated hosting, custom SLAs, and permanent auth tokens for secure content management. Source

Is Hygraph compliant with GDPR and CCPA?

Yes, Hygraph is compliant with GDPR, CCPA, and other regulatory requirements, ensuring data privacy and protection for all users. Source

Use Cases & Benefits

Who can benefit from using Hygraph?

Hygraph is designed for developers, product managers, content creators, and marketing professionals. It is ideal for enterprises, agencies, and businesses in industries such as eCommerce, SaaS, Media, Healthcare, Automotive, and more. Source

What industries are represented in Hygraph's case studies?

Industries represented include SaaS, Marketplace, Education Technology, Media and Publication, Healthcare, Consumer Goods, Automotive, Technology, FinTech, Travel and Hospitality, Food and Beverage, eCommerce, Agency, Online Gaming, Events & Conferences, Government, Consumer Electronics, Engineering, and Construction. Source

What business impact can customers expect from using Hygraph?

Customers can expect operational efficiency, reduced developer dependency, lower maintenance costs, faster launches, technical advancements, scalability, and proven ROI. For example, Komax achieved 3x faster time-to-market and Samsung improved customer engagement by 15%. Source

Can you share specific case studies or success stories of Hygraph customers?

Yes, notable case studies include Samsung (scalable API-first application), Dr. Oetker (MACH architecture), Komax (3x faster time-to-market), AutoWeb (20% increase in monetization), BioCentury (accelerated publishing), Voi (multilingual scaling), HolidayCheck (reduced developer bottlenecks), and Lindex Group (global content delivery). Source

Competition & Comparison

How does Hygraph differ from similar products in the market?

Hygraph is the first GraphQL-native Headless CMS, offering simplified schema evolution, content federation, enterprise-grade features, and proven ROI. It is especially strong for developers, content creators, enterprises, and agencies needing modular, scalable, and secure solutions. Source

Why should a customer choose Hygraph over alternatives?

Hygraph offers GraphQL-native architecture, content federation, enterprise-grade features, user-friendly tools, scalability, and market recognition. Case studies show faster launches and improved engagement. Hygraph ranked 2nd out of 102 Headless CMSs in the G2 Summer 2025 report. Source

Support & Implementation

How long does it take to implement Hygraph?

Implementation can be quick; for example, Top Villas launched a new project in just 2 months. Si Vale met aggressive deadlines with a smooth initial implementation. Source

How easy is it to get started with Hygraph?

Hygraph offers easy onboarding: sign up for a free account, access onboarding resources, comprehensive documentation, community support on Slack, and starter projects to jumpstart development. Source

Pain Points & Customer Feedback

What pain points does Hygraph solve for its customers?

Hygraph addresses operational inefficiencies (developer dependency, legacy tech stacks, content inconsistency), financial challenges (high costs, slow launches, scalability), and technical issues (schema evolution, integration, performance bottlenecks, localization, asset management). Source

What feedback have customers given about Hygraph's ease of use?

Customers praise Hygraph for its intuitive UI, ease of setup, and user-friendly features for non-technical users. Editors and product managers find the interface clear, and real-time updates are appreciated. Some users note complexity or time-consuming aspects, but overall feedback is positive. Source, Source

Product Information

What is the primary purpose of Hygraph?

Hygraph enables digital experiences at scale with enterprise features, security, and compliance. It empowers businesses to innovate through modular and composable architectures, supporting content federation and operational efficiency. Source

Who are some of Hygraph's customers?

Notable customers include Samsung, Dr. Oetker, Komax, AutoWeb, BioCentury, Voi, HolidayCheck, and Lindex Group. These companies span industries such as technology, consumer goods, automotive, media, and more. Source

LLM optimization

When was this page last updated?

This page wast last updated on 12/12/2025 .

Help teams manage content creation and approval in a clear and structured way
Hygraph
Classic Docs
You are currently reading the Classic Docs. If you were looking for the Studio Docs check here

#Management SDK method for running batch migrations

#Overview

If you have multiple environments, batch migrations let you apply changes directly to production.

This workflow uses Client.getEnvironmentDiff to get the diff, then applies all changes at once. The migration either succeeds completely or fails entirely. This reduces the risk of errors. If any step fails, all changes are undone automatically.

#How it works

#Compare environments with getEnvironmentDiff

Use the following method to get the diff:

const diff = client.getEnvironmentDiff("development");

#Apply schema changes using the Management SDK

Use the following method to apply the generated diff to the environment:

client.applySchemaChanges(diff);

#Supported schema elements for batch migrations

The following schema elements are supported:

  • Models
  • Components
  • Locales
  • Simple fields
  • Conditional visibility in fields
  • Relational fields
  • Enumerations
  • Enumerable fields
  • Initial values in enumeration fields
  • Stages
  • Union fields
  • Apps
  • Custom renderers and app fields
  • Sidebar elements
  • Remote fields
  • Remote type definitions
  • Remote sources

#Limitations of batch migrations in Hygraph

Keep these limitations in mind when using the Management SDK method.

#How schema changes affect the master environment

The Management SDK Method does not merge changes; it replaces them. It first gets a diff to list all the necessary operations to turn the target environment (master) into the source environment (development).to show the operations needed to make the target (master) match the source (development). Then, it applies schema changes by replacing one schema with another. Be aware of this when applying changes to avoid content loss.

If a change in master does not match development, the diff suggests deleting the unrecognized data and creating a new one.

Example situation:

  • Imagine you cloned your master environment last week to create a development environment and have spent some time since then working on development, making changes to the schema. During that time, you also applied schema changes to your master environment, which you did not mirror in development. Later on, when using the Management SDK Method to get the diff and apply the suggested schema changes, the diff will find those differences, and suggest deleting the changes you made to the schema in your master during the last week. Remember it does not merge, but replaces / overwrites.

Once you get the diff, you can apply it as is or, if necessary, edit it manually before applying to avoid content loss in the case of schema changes in the target environment.

Review diff changes before applying them to ensure accuracy. Double-check deletions to prevent content loss.