Migrate to Netlify Today

Netlify announces the next evolution of Gatsby Cloud. Learn more

ContactSign Up
Community Plugin
View plugin on GitHub

gatsby-plugin-schema-export

Exports the current Gatsby schema to a *.graphql file.

Installation

Install

pnpm add gatsby-plugin-schema-export

Without options

The generated schema will be written to generated/schema.graphql.

// gatsby-config.js
  ...
  plugins: [
    'gatsby-plugin-schema-export',
     ...
  ],

With options

The generated schema will be written to schema/gatsbySchema.graphql.

// gatsby-config.js
  ...
  plugins: [
    {
      resolve: `gatsby-plugin-schema-export`,
      options: {
        dest: `schemas/gatsbySchema.graphql`,
      },
    },
     ...
  ],

Usage

The generated schema will be written to generated/schema.graphql unless the dest option is set.

© 2023 Gatsby, Inc.