{"dist":{"shasum":"615dbb367e889afb21001e8dae80a2418d0e62c7","tarball":"https://registry.npmjs.org/graphql-migrations/-/graphql-migrations-0.14.0-alpha8.tgz","fileCount":129,"integrity":"sha512-lmsxrMVxWBl2+vGnIsaAjy5DW120SvWbUdiG/b4vvGvt7Op1JXtSiHYghgv8zQemWEAEIGcm1nXzUml0FPkZfA==","signatures":[{"sig":"MEYCIQCKikKvTYbbWYoBweJ3lVTr35egscFmT6sdIAmffFh9MQIhAPjerTPbbcNZlSsHrYxyaDpmycBiIvfH7t3dtsc2pVYd","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":285822,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe80+yCRA9TVsSAnZWagAA9GMP/0NbtxlnLWjwUM8htbct\nJynVSA3qtiTUpLkuLzqD03sVBrO0+JYlBQ4XYEIBSVrf0XhnTM5//yctozYz\nCPCUyqniT8pkAfU+lcdU+ETHl1Higyx6yQbTaT+GfrfIp+QD58GSuMepRKmZ\nkuFp/xsEz29nQHpAJuzeQdxNLhORcP6Vo9862AhST3zrw6YQEhpuDlcKr0nh\nbCrIfPZIW4t8Q4iEqWc9vPUv7nArRUEHDmlltWVAMGipWZ9jNAlzJBm6COmm\nqKnlPFWLLf8+hsygl2kRkoBlbQXvCoj3zVG+r0hc2Q1SppgtqEDREx581qhk\n+gfzUm0KB3/rFs8PMsBlEcf1sQxjKrEUJ/CEdCDLtUUo6zTmM4ieMNv26zZL\nfavyeWn04wwVWQ4SYEvM5zS4vsH5tzRGsVyXekq92WoAehcT8FBaDlhdm5eV\nDpB1bCdi+kC9e2E3i6wms2Edzz/Z57f/W+6s8XvG/xQawCXxAGYVMQaEPKM9\nmm9ebSQkx+Bf57PYcqGi+Lh1GGcH+OZnPxpAia2nNBodL6EfhwVUz/crFc3C\nmxgbOjWovZifJzcul4lMtCSc5yhDBy++Z4omPP73KvjDjEU9DjgrAJDgTait\nvbgopTAh3nxRSuYKAnKLn/lsxlGFguJODV6c3ntVCJ3WB7xc0MtOhNUvIDj/\nlDAp\r\n=6ZQn\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","name":"graphql-migrations","types":"types/index.d.ts","readme":"## Graphback\n\n<p align=\"center\">\n  <img width=\"400\" src=\"https://raw.githubusercontent.com/aerogear/graphback/master/website/static/img/logo.png\">\n  <br/>\n  Auto generate database structure, <br/>\n  GraphQL Resolvers and Queries from GraphQL types 🚀\n</p>\n\n**Documentation**: https://graphback.dev\n**Repository**: https://github.com/aerogear/graphback/\n\n## graphql-migrations\n\nAutomatically create and update your database tables from a GraphQL schema.\n\n### Usage\n\nThe `migrateDB` method creates and updates your tables and columns to match your GraphQL schema.\n\nAll the database operations are wrapped in a single transaction, so your database will be fully rolled back to its initial state if an error occurs.\n\n```ts\nimport { migrateDB } from 'graphql-migrations';\n\nconst dbConfig = {\n  client: 'pg',\n  connection: {\n    host: 'localhost',\n    user: 'your-user',\n    password: 'secret-password',\n    database: 'note-db',\n  },\n};\n\nconst schema = `\ntype Note {\n  id: ID!\n  title: String!\n  description: String\n  comments: [Comment]!\n}\n\ntype Comment {\n  id: ID!\n  description: String\n  note: Note!\n}\n`;\n\nmigrateDB(dbConfig, schema, {\n  // Additional options\n}).then(() => {\n  console.log('Database updated');\n});\n```\n\n### Migration Options\n\n- `config`: database configuration options.\n- `schema`: a GraphQL schema object.\n- `options`:\n  - `dbSchemaName` (default: `'public'`): table schema: `<schemaName>.<tableName>`.\n  - `dbTablePrefix` (default: ''): table name prefix: `<prefix><tableName>`.\n  - `dbColumnPrefix` (default: `''`): column name prefix: `<prefix><columnName>`.\n  - `updateComments`: overwrite comments on table and columns.\n  - `scalarMap` (default: `null`): Custom scalar mapping..\n  - `mapListToJson` (default: `true`): Map scalar lists to JSON column type by default.\n  - `plugins` (default: `[]`): List of graphql-migrations plugins.\n  - `debug` (default: `false`): display debugging information and SQL queries.\n\n### Model Definition\n\n```gql\n\"\"\"\nNotes table\n\"\"\"\ntype Note {\n  \"\"\"\n  Primary key\n  \"\"\"\n  id: ID!\n  \"\"\"\n  The note title\n  \"\"\"\n  title: String!\n}\n```\n\n### Skip table or field\n\n```gql\n\"\"\"\n@db.skip\n\"\"\"\ntype Error {\n  code: Int!\n  message: String!\n}\n\ntype Note {\n  id: ID!\n  title: String\n  \"\"\"\n  @db.skip: true\n  \"\"\"\n  computedField: Boolean\n}\n```\n\n### Rename\n\n```gql\n@db.oldNames: ['task']\ntype Note {\n  id: ID!\n  \"\"\"\n  @db.oldNames: ['text']\n  \"\"\"\n  title: String!\n}\n```\n\n### Nullable and non-nullable field\n\n```gql\ntype Note {\n  id: ID!\n  title: String! # not null\n}\n```\n\n```gql\ntype Note {\n  id: ID!\n  title: String # nullable\n}\n```\n\n### Default value\n\n```gql\ntype Note {\n  id: ID!\n  \"\"\"\n  default(value: 'Note title')\n  \"\"\"\n  title: String\n}\n```\n\n### Primary key\n\nEach type must have a primary key. The primary key field must be `id` and the type must be `ID`.\n\n```gql\ntype Note {\n  id: ID!\n  title: String!\n}\n```\n\n### Foreign key\n\nTo set a foreign key, set a field reference to the related type.\n\n```gql\ntype Comment {\n  id: ID!\n  note: Note! # this creates a `noteId` column in the `comment` table.\n}\n\ntype Note {\n  id: ID!\n  title: String!\n}\n```\n\n### Many-to-many\n\n```gql\ntype User {\n  id: ID!\n  \"\"\"\n  @db.manyToMany: 'users'\n  \"\"\"\n  messages: [Message]\n}\n\ntype Message {\n  id: ID!\n  \"\"\"\n  @db.manyToMany: 'messages'\n  \"\"\"\n  users: [User]\n}\n```\n\n### Many-to-many on same type\n\n```gql\ntype User {\n  id: ID!\n  friends: [User]\n}\n```\n\n### Simple index\n\n```gql\ntype User {\n  id: ID!\n  \"\"\"\n  @db.index\n  \"\"\"\n  email: String!\n}\n```\n\n### Multiple index\n\n```gql\ntype User {\n  \"\"\"\n  @db.index\n  \"\"\"\n  id: String!\n\n  \"\"\"\n  @db.index\n  \"\"\"\n  email: String!\n}\n```\n\n### Named index\n\n```gql\ntype User {\n  \"\"\"\n  @db.index: 'myIndex'\n  \"\"\"\n  email: String!\n\n  \"\"\"\n  @db.index: 'myIndex'\n  \"\"\"\n  name: String!\n}\n```\n\nYou can specify the index type on PostgreSQL.\n\n```gql\ntype User {\n  \"\"\"\n  @db.index: { name: 'myIndex', type: 'hash' }\n  \"\"\"\n  email: String!\n\n  \"\"\"\n  You don't need to specify the type again.\n  @db.index: 'myIndex'\n  \"\"\"\n  name: String!\n}\n```\n\n### Unique constraint\n\n```gql\ntype User {\n  id: ID!\n  \"\"\"\n  @db.unique\n  \"\"\"\n  email: String!\n}\n```\n\n### Custom name\n\n```gql\n\"\"\"\n@db.name: 'people'\n\"\"\"\ntype Note {\n  id: ID!\n  \"\"\"\n  @db.name: 'noteTitle'\n  \"\"\"\n  title: String!\n}\n```\n\n### Custom column type\n\n```gql\ntype Note {\n  id: ID!\n  \"\"\"\n  @db.type: 'string'\n  @db.length: 100\n  \"\"\"\n  title: String!\n}\n```\n\n### List\n\n```gql\ntype Note {\n  id: ID!\n  title: String!\n  \"\"\"\n  @db.types: 'json'\n  \"\"\"\n  comments: [String]\n}\n```\n\nYou can also set `mapListToJson` to `true` in the migrate options to automatically map scalar and enum lists to JSON.\n","engines":{"node":">=10.15.3"},"scripts":{"lint":"eslint -t stylish --project \"tsconfig.json\"","test":"jest","build":"tsc","clean":"rimraf coverage dist types","watch":"tsc -w"},"_npmUser":{"name":"aerogear-ci","email":"mziccard@redhat.com"},"typescript":{"definition":"types/index.d.ts"},"_npmVersion":"6.14.5","description":"Create & migrate Databases from GraphQL Schema","directories":{},"maintainers":[{"name":"aerogear-ci","email":"dara.s.hayes@gmail.com"},{"name":"ephelan","email":"ephelan@redhat.com"},{"name":"wtrocki","email":"wtrocki@redhat.com"}],"_nodeVersion":"12.18.1","dependencies":{"case":"1.6.3","glob":"7.1.6","knex":"0.21.1","pino":"6.3.2","chalk":"3.0.0","lodash":"4.17.15","ts-jest":"26.1.1","lodash-es":"4.17.15","node-emoji":"1.10.0","@types/jest":"26.0.0","@graphback/core":"0.14.0-alpha8","graphql-metadata":"0.7.0","@graphql-inspector/core":"2.1.0"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"pg":"8.2.1","jest":"26.1.0","rimraf":"3.0.2","graphql":"15.1.0","sqlite3":"4.2.0","ts-node":"8.10.2","tsutils":"3.17.1","typescript":"3.9.5","@types/jest":"26.0.0","@types/node":"12.12.47","@types/lodash":"4.14.156","graphql-tools":"6.0.10","graphql-compose":"7.18.1"},"peerDependencies":{"graphql":"^14.0.0 || ^15.0.0"},"_npmOperationalInternal":{"tmp":"tmp/graphql-migrations_0.14.0-alpha8_1593003953785_0.3431322746710148","host":"s3://npm-registry-packages"},"_id":"graphql-migrations@0.14.0-alpha8","version":"0.14.0-alpha8"}