neo4j-graphql / graphql-cli-load Goto Github PK

View Code? Open in Web Editor NEW

65.0 4.0 7.0 11 KB

A graphql-cli data import plugin to call mutations with data from JSON/CSV files

Home Page: https://www.npmjs.com/package/graphql-cli-load

License: Other

TypeScript 100.00%

graphql graphql-cli mutations import data-import graphql-schema csv-import json-data

graphql-cli-load's Introduction

graphql-cli-load

Data import plugin for graphql-cli.

Installation

npm i -g graphql-cli graphql-cli-load

Configuration

Configure the plugin via the .graphqlconfig or command line.

The schema will be obtained from the schemaPath key, you can fetch it via graphql get-schema

All other options such as csv, json, mutation or mapping can be placed in the extensions.load key or provided via commandline.

Here is an example:

.graphqlconfig

{
  "schemaPath": "schema.graphql",
  "includes": [
    "src/**/*.graphql",
    "src/**/*.gql",
  ],
  "extensions": { 
    "load": { // this section is optional
      "csv" : "reviews.txt",
      "mutation": "createReview",
      "mapping": { "text" : "review", "rating" : "stars"}
    }
  }
}

Usage

You can now run:

graphql load

graphql load --csv reviews.txt --mutation createReview2 --mapping '{ "text" : "commentary", "rating" : "stars"}'

Using endpoint starwars: http://localhost:7474/graphql/
Using mutation "createReview2".

Done parsing CSV-file /Users/mh/d/js/graphql-cli-load/example/reviews.txt rows: 3
 meta: {"delimiter":"\t","linebreak":"\n","aborted":false,"truncated":false,"cursor":566,"fields":["episode","text","rating"]}

Using mapping: {"text":"commentary","rating":"stars"}

Sending query:
mutation { 
_0 : createReview2 ( episode: NEWHOPE,commentary: "A legendarily expansive and ambitious start to the sci-fi saga, George Lucas opened our eyes to the possibilities of blockbuster filmmaki...

✔ Call succeeded:
{"_0":"Nodes created: 1\nProperties set: 3\nLabels added: 1\n","_1":"Nodes created: 1\nProperties set: 3\nLabels added: 1\n","_2":"Nodes created: 1\nProperties set: 3\nLabels added: 1\n"}...

Options

/usr/local/bin/graphql load [--json] [--csv] [--endpoint] [--mutation] [--mapping] [--delim]

Optionen:
  --help          Hilfe anzeigen                                       [boolean]
  --mapping, -p   name mapping of input to mutation (json)
  --mutation, -m  mutation to call
  --endpoint, -e  endpoint name to use
  --json, -j      json file to load
  --csv, -c       csv file to load
  --delim, -d     delimiter for arrays

Which will take each line of the csv or json file and call the mutation on the endpoint with the data (optionally mapping columns). Non-absolute files are resolved relative to the directory containing .graphqlconfig.

Test with Neo4j-GraphQL Extension

To test this with the neo4j-graphql extension:

npm install -g neo4j-graphql-cli
git clone https://github.com/neo4j-graphql/graphql-cli-load && cd example
neo4j-graphql example-schema.graphql (remember the auth header)
npm install -g graphql-cli graphql-cli-load
Run graphql to install the endpoint, and manually add the auth-header to .graphqlconfig, like here:

"endpoints": {
  "starwars": {"url":"http://localhost:7474/graphql/","headers":{"Authorization": "Basic bmVvNGo6dGVzdA=="}}
},

Run graphql load --csv reviews.txt or graphql load --csv reviews.json

graphql-cli-load's People

Contributors

Stargazers

Watchers

Forkers

krivega nicolassmit alaptseu laayis carlosern jbelke halcyondude

graphql-cli-load's Issues

test with graphcool

graphcool
apollo-launchpad
scaphold
reindex

just output summary of sent mutations and response

support data type conversion

also support input objects

Gave it a (unsuccessful) try

macOS Sierra

Node 9.

i ran graphql init and to get .graphqlconfig:

$ graphql init
? Local schema file path: schema.graphql
? Endpoint URL (Enter to skip): https://api.graph.cool/relay
/v1/cj9o4se940gsu0148s5a4helr
? Name of this endpoint, for e.g. default, dev, prod: server


? Subscription URL (Enter to skip):
? Do you want to add other endpoints? No
? What format do you want to save your config in? JSON

About to write to /Users/shingdev/code/GRAPHCOOL/react-graphql/quickstart-with-relay-modern/.graphqlconfig:

{
  "schemaPath": "schema.graphql",
  "extensions": {
    "endpoints": {
      "server": "https://api.graph.cool/relay/v1/cj9o4se940gsu0148s5a4helr"
    }
  }
}

? Is this ok? Yes```

then ran graphql get-schema, which saw no changes with the previously existing schema.graphql file which seemed correct.

$ graphql get-schema
Downloading introspection from https://api.graph.cool/relay/v1/cj9o4se940gsu0148s5a4helr
No changes


I then ran graphql load which failed with this json file [https://gist.github.com/idkjs/06d10b7a02edb8e6a2b10cb4608bdaa4] :

$ graphql load -m createCompany --json companies.json
Using endpoint server: undefined
Using mutation "createCompany": "".
Done parsing JSON-file /Users/shingdev/code/GRAPHCOOL/react-graphql/quickstart-with-relay-modern/companies.json rows: 90
Sending query:
mutation {

}...

Parameter "url" must be a string, not undefined

I changed the endpoint in graphconfig to this:

{
"schemaPath": "schema.graphql",
"extensions": {
"endpoints": {
"server": {"url":"https://api.graph.cool/relay/v1/cj9o4se940gsu0148s5a4helr"}
}
}
}


Which produced this error:

```sh
GraphQL Error (Code: 200): {"response":{"error":"Syntax error while parsing GraphQL query. Invalid input \"mutation { \\n\\n}\", expected OperationDefinition, FragmentDefinition or TypeSystemDefinition (line 1, column 1):\nmutation { \n^","status":200},"request":{"query":"mutation { \n\n}","variables":{}}}

This is my graphcool playground mutation def:

This is what the mutation looks like in DevTools if I do one manually

-mutation & variables

mutation CreateCompanyMutation(
  $input: CreateCompanyInput!
) {
  createCompany(input: $input) {
    company {
      id
      description
      logo
    }
  }
}

variables

{
    "input": {
        "description": "testatt",
        "logo": "https://d25e16a427ed3ce77d27-76b466cd72f6b3a6e7219a8a02851d8e.ssl.cf1.rackcdn.com/files/59382428ff3935425ca91516/size_5_1001pharmaciesjpg.jpg",
        "clientMutationId": ""
    }
}

Any ideas? Thank you.

add support for urls

Unknown argument: load

Hi,

When i run graphql load i am facing the following error Unknown argument: load

Syntax Error: Expected Name, found }

Hello jexp, first thanks for the project, it looks very useful.

I'm having a problem when running the grapqhl load that maybe you would know what it would mean.

Using endpoint local: {"url":"http://localhost:4000"}
Using mutation "post": "".
Done parsing CSV-file /Users/Me/Desktop/devtest/hackernews-node/reviews.txt rows: 3
 meta: {"delimiter":"\t","linebreak":"\n","aborted":false,"truncated":false,"cursor":571,"fields":["episode","commentary","stars"]}
Using mapping: {"description":"commentary","url":"stars"}
Sending query:
mutation { 

}...
✖ 
Syntax Error: Expected Name, found }: {"response":{"errors":[{"message":"Syntax Error: Expected Name, found }","locations":[{"line":3,"column":1}]}],"status":400},"request":{"query":"mutation { \n\n}","variables":{}}}

I'm running the database API with prisma, and I have uploaded my whole minimum viable test project to get this functionality working in this repository: https://github.com/daquintero/testGraphqlCLILoad/tree/master

I'm not sure if this is enough information for the question, but please tell me if you need anything else. I appreciate very much the help!

add support for graphql parameters

Loading json data

I'm trying to load data from a json file, when executing the graphql load command I get the following complains:


Sending query:
mutation {
_0 : createBlabla ( blabla1: 123,blabla2: "blabla2", blabla3: "blabla3 ) { blabla }
_1 : ...
}...
Field "blabla" of type "BlablaType" must have a sub selection.:

If I execute the same mutation from that output in graphql, blabla will expand to blabla { id } and data is successfully added.

P.S. I got the server schema via graphql get-schema

The "path" argument must be of type string

Hi,

When I run graphql load -m createShipRate --json rates.json

I get:

✖
The "path" argument must be of type string