{"ava":{"files":["tests/**/*"],"require":["ts-node/register"],"extensions":["ts"],"compileEnhancements":false},"dist":{"shasum":"80974a707f85af6b052be8e7d1934481aa4cbc75","tarball":"https://registry.npmjs.org/graphql-migrations/-/graphql-migrations-0.10.0-rc3.tgz","fileCount":213,"integrity":"sha512-yJuy9fIF8pN8lRrhSJcw63zgKODFrvZNlYU65KBhU6DBmFrO/aWC/HfO/APCydyQmJWNGfSvtPn8yv+kasiy3Q==","signatures":[{"sig":"MEYCIQCi2OH68+eYyq+MO55D+eC+paJTsAJ80d0l2CIKbavHZAIhAJKkx9Es8NSBVs95QcdcGuoiYv7+Aq6vQlg24Z4wV6X3","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":398391,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeAP4MCRA9TVsSAnZWagAAuUAP/RgO+fiSWm9xNWfEhz+3\nkvspj86MygPrv6/Ec8g3Uu1SK4ZT9f8t1WmxpBc2uVzX8+4FEl1AxjbKXu6/\nuxsbV345nnzWuPumBZPxC9S2mVEtoHc/M+//c+08sgk0enEv4kXQT7Qd31zt\ng4watX/Hfk1eDTjhtmphOaHE1VGuf5KKv5s3Pir7uEx1HZ/Ni3Cbr3/0EeGs\nYYDlajg3n4xt5t2LDr3JFen5uw18YoJIWMJDh2TmMfOBDbibx62UI/PTCQLX\nfdRAMneKr12Q2lgkfHSRZrKQ9Z4wugMWyQ/g0BxvQN26SkJG3/61sZwP4Rvh\nTHB2f+9/2ncp+Yw5VUWVuqNQrCLr/FC4zYWpub5/LXq2jqjhkwyL1Jz/uVtQ\nmwu7mEZ1+Jqr4e88AXop6W7ZppKM5pav9sFqlAXjYyAznJzeVZxoh82CVQVf\nPwsOpsQNOn0ZL48rf8jSB2DLXA/jiF9Akir6saYkNKWKKMCqySC7eTfoaa5c\nRcZJQokAkHznmkt3Iph+1XbguORvbAFAjJTJluqTXPOFXJT7rLqUvkWhFD9Y\nQQOjDcUyw4b0DDgvPBh7X6jgEs5DbQEgTexrYtnTZ/JDO8oq3av1UF/dykXG\nYijmqehD5Qgju06LVBaH+IsT2kzZbw8rA9NVufRvzdJzOKNA96q9eg94hyaB\nMhxx\r\n=+9hJ\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  - `transformTableName` (default: transform to `lowercase`): transform function for table names.\n  - `transformColumnName` (default: transform to `lowerCaseFirstCharacter`): transform function for column names.\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### Name transforms\n\nYou can customise how table and coumn names are transformed before applying to the database with `transformTableName` and `transformColumnName`.\n\n```ts\nmigrateDB(dbConfig, schema, {\n  transformTableName: (name, direction) => {\n    if (direction === 'to-db') {\n      return name.toLowerCase();\n    }\n    return name\n  },\n  transformColumnName: (name, direction) => {\n    if (direction === 'to-db') {\n      // set first character in name to lowercase\n      return `${name.charAt(0).toLowerCase()}${name.slice(1)}`\n    }\n    return name\n  }\n});\n```\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":"tslint -t stylish --project \"tsconfig.json\"","test":"ava","build":"tsc","clean":"rimraf coverage dist types","watch":"tsc -w","pretest":"npm run build"},"_npmUser":{"name":"aerogear-ci","email":"dara.s.hayes@gmail.com"},"typescript":{"definition":"types/index.d.ts"},"_npmVersion":"6.13.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.14.0","dependencies":{"case":"1.6.2","glob":"7.1.6","knex":"0.20.4","pino":"5.15.0","lodash":"4.17.15","lodash-es":"4.17.15","node-emoji":"1.10.0","@graphback/core":"^0.10.0-rc3","graphql-annotations":"0.0.3","@graphql-inspector/core":"1.26.0"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"pg":"7.15.0","ava":"2.4.0","rimraf":"3.0.0","tslint":"5.20.1","graphql":"^14.5.8","sqlite3":"4.1.1","ts-node":"8.5.4","tsutils":"3.17.1","typescript":"3.7.3","@types/jest":"24.0.24","@types/node":"12.12.21","@types/lodash":"4.14.149","graphql-tools":"4.0.6","@types/graphql":"14.2.3"},"peerDependencies":{"graphql":"^0.12.0 || ^0.13.0 || ^14.0.0"},"_npmOperationalInternal":{"tmp":"tmp/graphql-migrations_0.10.0-rc3_1577123339969_0.781568356815556","host":"s3://npm-registry-packages"},"_id":"graphql-migrations@0.10.0-rc3","version":"0.10.0-rc3"}