The 'GraphQL Cheat Sheet' Lesson is part of the full, Introduction to GraphQL course featured in this preview video. Here's what you'd learn in this lesson: Scott references a resource to utilize when constructing a GraphQL Schema.
Below you can find documentation about the database structure and GraphQL.
GraphQL Cheat Sheet Overview. An alternative approach to RESTful APIs; Clients issue queries/mutations to read and update data; Clients can fetch only the entity fields that are required. The GraphQL spec says that a null result on a Non-Null type bubbles up to the next nullable parent. If this bubbling never stops because everything is of Non-Null type, then the root data field is null. The GraphQL spec says that a null result on a Non-Null type bubbles up to the next nullable parent. If this bubbling never stops because everything is of Non-Null type, then the root data field is null.
Database schema¶
An overview of the database schema is given in the figure below.
The database structure builds upon the ASE-database (https://wiki.fysik.dtu.dk/ase/ase/db/db.html) that uses the tables: systems, species, keys, text_key_values, number_key_values, information. These are used for storing atomic structures and calculational information.
On top is the tables reaction and publication which are used to store reaction energies and publication info for CatApp v2.0.
The tables reaction_system and publication_system links the ASE and CatApp parts together.
GraphQL Queries¶
Go to the backend interface at http://api.catalysis-hub.org/graphql to start using our graphQL browser.
Type your query in the left panel. In order to perform queries on the reactions table start with:
And type command + return to see the result on the right hand. This should return the id of the first two reactions in the database. Notice that the left hand side is updated as well.
See the tutorials at http://catalysis-hub.readthedocs.io/en/latest/tutorials to learn more.
GraphQL Cheat Sheet¶
Tables:
- reactions
- publications
- systems
- reactionSystems
Start your query with the table name followed by a query:
Query fields:
- Text fields:
- field=value: (field: “value”)
- field@>value: (field: “~value”)
- distinct field: (field: “~”, distinct: true)
- Integer / Float fields:
- field=value: (field: value)
- field>value: field:value, op: ”>”)
- Special fields:
- first, last : int
- distinct: true/false
- before, after : str id
- order: sort by column: (order: “field”) or (order: “-field”)
- op: [‘=’, ‘>’, ‘<’, ‘>=’, ‘<=’, ‘!=’]
- Output fields (systems table)
- InputFile(format: ”vasp”)
- Special attributes:
- totalCount: # entries
- pageInfo: pagination
Incude the special attributes like this:
Introduction
This document is meant to be an overview of all of the capabilitiesof GraphQLsheet and how you can best leverage those capabilities.We will also help you understand exactly how GraphQLsheet works,the limitations, the permissions we are requesting to access your Google accountand help you integrate the APIs you will create with your app.If you have any questions, please talk to us.
Getting Started
The API creation is super simple. We leverage Google APIs to log you in,ask for your permission to access Google Drive and then you can create the API forthe Google Spreadsheet you want.
Overview
GraphQLsheet creates a GraphQL API from your Google Spreadsheet.Google offers a REST API that users can use but it's a lot more effort to setup yourselfand of course, it's not GraphQL. GraphQL offers many advantages over REST such as a clean, self documented API(you can access GraphiQL for your GraphQLsheet APIs), multiple requests in one and youcan request only that data fields you want.
Spreadsheets
Important: The spreadsheet must have alphanumeric string values (that don't start with a number)on the first row.The second row and the rest must have actual values (strings, number, booleans) to define the GraphQL schema.
A typical spreadsheet has columns with values with the first row having the column names.That's the assumption that GraphQLsheet is based on. We use the first row data as keysto create the GraphQLsheet schema and then analyze the column values to find patterns.If a column has numeric values, we define the GraphQL schema based on that information.We understand numbers, booleans and strings.
The spreadsheet should not have empty rows. An error will be thrown when you try to createthe API in that case.
If a spreadsheet is very big (more than 50000 values) we will not analyze it and will accept all columns asif they contain strings. Also, because we will not analyze it, any empty rows at the end will not be removedand will exist as if they contain empty string values. Feel free to remove them manually.
To sum up,This is an example spreadsheet
Graphql Query Cheat Sheet
You can always make changes to the spreadsheet manually (through Google Drive)and re-create the API though the dashboard.
Pricing
We currently offer 2 different pricing options. In all available packages(Free, Plus, Pro), you can create as many GraphQLsheet APIs as you want.The main difference between the 2 packages is the number of requests that you can do.Please bare in mind that requests through GraphiQL are counted against your total available requests limit.
GraphQL API
If you ever used GraphQL, you know what it can do, and for sure you want touse it everywhere, and that's what GraphQLsheet is here to help with. We supportCreate Read Update and Delete operations, or Queries and Mutations as those are called in GraphQL.
Following is a complete example of a get request in JavaScript. You can use any language to do a simple POSTrequest and use the API.Make sure to replace:
- YOUR_API_TOKEN: with your token which you can find in your dashboard after you create your API.
- YOUR_API_URL: with your API url, also found in the dashboard
- YOUR_API_FIELDS: Values from the first row of your spreadhsheet
Queries
Queries are used to retrieve data. We support a single but powerful query called 'get'.
Get
It can be used to get specific rows from the spreadsheet based on the params you use.Available params:
- limit (Int): Max # of rows to read at once (default 10)
- offset (Int): Start reading from row # (default 0)
- query (Object): Search for specific rows
And it will return the matched rows of the spreadsheet.
For example
Query example
Mutations
Mutations is how we change data in the spreadsheet. We support 'add', 'update' and 'remove'.
Add
This mutation allows you to add new data in the spreadsheet. That data is addedat the end of the spreadsheet. The params of this mutation depend on the structure ofyour spreadsheet and will be determined on the API creationg phase. All params are mandatory.This mutation returns the created row.
For example
Update
This mutation allows you to update specific rows in the spreadsheet. The params ofthis mutation depend on the structure of your spreadsheet and will be determined on the APIcreationg phase. Use the query to find the rows to update and the rest of the paramsfor the values you want to update. This mutation returns an array with the updated rows.
For example
Remove
Graphql Rbac
This mutation allows you to remove data from the spreadsheet. The params ofthis mutation depend on the structure of your spreadsheet and will be determined onthe API creationg phase. Use the available params to find the rows to remove.This mutation returns an array with the deleted rows.
For example
Authentication
Graphql Operations
Each API has a unique API token that you need to send with your request to accessthe data. That API token secures that requests without it wont be able to read or write data to your spreadsheet.
Graphql Cheat Sheet Pdf
Privacy
The privacy and safety of your data is our top priority.We never store any data other than the first row of your spreadsheet that we use to create the GraphQL API schema.We request the minimum permissions from your Google account. Using the option to create an example spreadsheet,we request access only to that file and other files we will create for youand we can't access any other file from your account.We suggest that you use this option and then edit that example spreadsheet to paste your own data in it.Just don't forget to recreate the API (through your dashboard) after you change the spreadsheet data.
Limitations
We currently support access only to the first sheet of your spreadsheetIf you need access to a different sheet, the easiest solution right now is tocreate a new Google Spreasheet and move your data there, and create a GraphQLsheet APIfor it. Based on the user feedback we will consider adding the ability to accessmultiple sheets in the future.
HTTP Status Codes
We use stardard HTTP Status Codes to respond to your API requests
| Code | Description |
|---|---|
| 200 | OK |
| 400 | Bad Request |
| 401 | Unauthorized |
| 404 | Not Found |
| 429 | Rate limit exceeded |
Unauthorize GraphQLsheet
You can always revoke the GraphQLsheet's permission to access your Google Drive filesin the Google Account Permissions page.