Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neo4j-graphql/graphql-cli-load
A graphql-cli data import plugin to call mutations with data from JSON/CSV files
https://github.com/neo4j-graphql/graphql-cli-load
csv-import data-import graphql graphql-cli graphql-schema import json-data mutations
Last synced: about 1 month ago
JSON representation
A graphql-cli data import plugin to call mutations with data from JSON/CSV files
- Host: GitHub
- URL: https://github.com/neo4j-graphql/graphql-cli-load
- Owner: neo4j-graphql
- License: other
- Created: 2017-08-19T11:39:34.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-09-10T03:32:16.000Z (about 6 years ago)
- Last Synced: 2024-09-27T21:40:59.590Z (about 2 months ago)
- Topics: csv-import, data-import, graphql, graphql-cli, graphql-schema, import, json-data, mutations
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/graphql-cli-load
- Size: 10.7 KB
- Stars: 65
- Watchers: 4
- Forks: 7
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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`
```json
{
"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
```
or
```
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:
1. `npm install -g neo4j-graphql-cli`
2. `git clone https://github.com/neo4j-graphql/graphql-cli-load && cd example`
2. `neo4j-graphql example-schema.graphql` (remember the auth header)
4. `npm install -g graphql-cli graphql-cli-load`
5. 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=="}}
},
```
6. Run `graphql load --csv reviews.txt` or `graphql load --csv reviews.json`