{"dist":{"shasum":"75b9d636e18e5d59bd8e659349e70f7a3e529af8","tarball":"https://registry.npmjs.org/graphql-migrations/-/graphql-migrations-0.14.0-dev1.tgz","fileCount":125,"integrity":"sha512-af2i5mT+S0eBytDQa/UZtY9fywMlSMpV4KH0HRA7txjstxgGA1P0G+j3CGp1Egn0wNPzu1FW/0ztZ2GHH3EvUQ==","signatures":[{"sig":"MEUCIB7Arh5yxt+7e/6/2/0savalbRqeHeisFtLr3WdsEXLYAiEA7ohWyReFSAm5flCnPaDaktz0mAnA0XxfjFiKBx7q73g=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":271486,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJetVb4CRA9TVsSAnZWagAAZJYP/2Yt1ADi9579CEwDPSL4\nB6VRJnzvC2zxHtqr6s5+AvuHl7B9BPByh3zyNJLTjzIEEESso4Tf8DW9/mFv\ns0wt5ydNT53QC0vrxpg39mNFgQsxjyeKeeiMq9aUIQ2G/BXh4VdxYcq49pl3\n5f/FPPFSutnnvcfHjJ5ibLMmBK8RNK31/U0xRw4b9cFpRd7CzcXQ2SBPpN7J\nEjeSLS5Vwynekc7oUh9eGlHBgIqlIcr39EypbVzWw0lxon2YNby4qoryvPfO\nYq87jW3G7f/lSKTVez1bEWnCIxQR6dbUBi1zmvrnRTZikN7neaBklOfeX/SB\nUEC7axEjtRdVA1xTJjUBcDSy4G13T/TGDoAvUoIEkEofbZprL0Q4JDnTpNaX\ng7FwEcoVfgGREKMH+1dfcyh5PLRQqZ30ofrEBCfErGCRlTyl8Yrn4nbSmulK\n1Tfibg6qnAMehd4ofoqR45+EpJ65d+5Tvs9lSjCFlpXWzoWiR/WaU7MGqRSW\nwURaUQPA4wc1gu9vl9a7BftAbrzS36d2lkcgZDgXj5BY0+V9H5Uxg5e0mpZs\n567uy5tMBNTcUEyYTxb55HgZCdiogeCdaCp3V/Ymzs5ZVzaCpHdc6Bh1rNuH\nhb0iMiWthPj3lHj3NDlM4GULNNO4jJcTnPOlDv09njkfE5CM28Y7k/2E1Emd\nNuS2\r\n=dpy9\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://github.com/aerogear/graphback/raw/master/website/static/img/graphback.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":"ephelan","email":"ephelan@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.16.1","dependencies":{"case":"1.6.3","glob":"7.1.6","knex":"0.21.1","pino":"6.2.1","chalk":"3.0.0","lodash":"4.17.15","ts-jest":"25.4.0","lodash-es":"4.17.15","node-emoji":"1.10.0","@types/jest":"25.2.1","@graphback/core":"0.14.0-dev1","graphql-metadata":"0.5.0","@graphql-inspector/core":"1.30.4"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"pg":"8.0.3","jest":"26.0.1","rimraf":"3.0.2","graphql":"14.6.0","sqlite3":"4.2.0","ts-node":"8.9.1","tsutils":"3.17.1","typescript":"3.8.3","@types/jest":"25.2.1","@types/node":"12.12.37","@types/lodash":"4.14.150","graphql-tools":"5.0.0","graphql-compose":"7.14.4"},"peerDependencies":{"graphql":"^0.12.0 || ^0.13.0 || ^14.0.0"},"_npmOperationalInternal":{"tmp":"tmp/graphql-migrations_0.14.0-dev1_1588942583732_0.8456143728254415","host":"s3://npm-registry-packages"},"_id":"graphql-migrations@0.14.0-dev1","version":"0.14.0-dev1"}