@graphcms/migration

migration

GraphCMS Migration SDK.

Usage

// import migration library
const { newMigration, FieldType } = require("@graphcms/migration")

// create a new migration for an environment
// using auth token and environment endpoint url.
const migration = newMigration({authToken, endpoint})

// create model
const author = migration.createModel({
  apiId: "Author",
  apiIdPlural: "Authors",
  displayName: "Author"
})

// add fields
author.addSimpleField({
  apiId: "firstName",
  displayName: "First Name",
  type: FieldType.String
})
author.addSimpleField({
  apiId: "lastName",
  displayName: "Last Name",
  type: FieldType.String
});

// run migration
migration.run()

Docs

SDK docs is available at https://grapchms.com/docs/sdk.

The SDK is fully typed with Typescript and IDE intellisense is expected to work as desired.