{"dist":{"shasum":"f48843bf918334d9b3993878e61288e77464dfb6","tarball":"https://registry.npmjs.org/graphql-migrations/-/graphql-migrations-0.14.0-alpha5.tgz","fileCount":125,"integrity":"sha512-DKyb+pq8bjxJSGIDAiCEjBYjsEpyY18T2WIrd+bT1q4vEPo1L+wKx28dv/xd8YUA7hndZjU8yzPGY0RJ+pdLnw==","signatures":[{"sig":"MEUCIG38jIAa7fAZetKGUMcnctHiZqL5fikcRyN2/w8GW92YAiEAhg7ujVzouM6Vn20z1GrmVk8CKk2c+4VNv7EZb5suKOE=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":282013,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJe6/XKCRA9TVsSAnZWagAAcFcP/jD2ra339od/b9IsHYLd\n7wRHC5sHAr4yl/LL27oIPeYU6u5HIGNYJ/6lP8f5OlZkES/zbtVBZNSE3BFJ\nu7xsZ2FpVBVtWwUJdby2pmlbWOPs4fBmK92c5DVTboPByg62Cn/X77TfVxpr\nt4q/y+khLziwFWGViwF1PslyfHOxz3QM0hZy+vmhacjuXYd9jzd+w3UGiipf\nuwfMiliQO2yyJI4y3xlZgINVO8dXYDvYl74sg20TbbOzzGAUyg4HeUEQFOOy\nHh5pO7EJ6Hfnwzs3d3NJc3mGD8nSLdiQs0GnY16qXlP5D0VqskMLUI5I+DMO\njfXmjut1AUyO1oblwGQxA8Xx/HfD105obqLlq7sS0Y4nxUKnZt+NaigzHlwg\n8W/b2WtE8XaBYPG+QZ9XzPDgYPZR8Xey7I1i1qzsE+AJUcVr7HFUbstzKj2M\nE1OzZUaX+hTKdlh/kniE2Kc/ZxLUc0ym4/zdEWLJ7s4F4h60eQAlgti2udXX\nPr/ZigKxx87aDFfoXAaZc5DqEb8HlnQaSYLm7ON5sXWESXnv+VZ7cHJ7Rp55\nHIF7KLXXFWrrZUa5z2iMnI9K7Flx3GsOKgv/bYW/P0u5M+Azw7WaUvh5OKHl\nFFtmx/7Wua01D4NLIyncU2fY+xQH8GhtGDh9KbxkJFjUuKNZeVDw4aA5WY5f\nY4w2\r\n=I7My\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  db.default: '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.4","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.0","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.0","lodash-es":"4.17.15","node-emoji":"1.10.0","@types/jest":"26.0.0","@graphback/core":"0.14.0-alpha5","graphql-metadata":"0.6.3","@graphql-inspector/core":"2.1.0"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"pg":"8.2.1","jest":"26.0.1","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.155","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-alpha5_1592522186360_0.8581447777279934","host":"s3://npm-registry-packages"},"_id":"graphql-migrations@0.14.0-alpha5","version":"0.14.0-alpha5"}