Skip to content

Commit 4c6a5cd

Browse files
pmantica1obi1kenobi
authored andcommitted
Add Quick Overview to README.md (kensho-technologies#239)
* Nits * Add what I thought would be README.md improvements * Nits * Added pretty printing in the miscellaneous section * Hyphenate "pretty-print"
1 parent fc1f9dc commit 4c6a5cd

File tree

1 file changed

+23
-6
lines changed

1 file changed

+23
-6
lines changed

README.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,22 @@ Turn complex GraphQL queries into optimized database queries.
1414
pip install graphql-compiler
1515
```
1616

17+
## Quick Overview
18+
19+
Through the GraphQL compiler, users can write powerful queries that uncover
20+
deep relationships in the data while not having to worry about the underlying database query
21+
language. The GraphQL compiler turns read-only queries written in GraphQL syntax to different
22+
query languages.
23+
24+
Furthermore, the GraphQL compiler validates queries through the use of a GraphQL schema
25+
that specifies the underlying schema of the database. We can currently autogenerate a
26+
GraphQL schema by introspecting an OrientDB database, (see [Querying OrientDB with GraphQL](#querying-orientdb-with-graphql)).
27+
28+
In the near future, we plan to add schema autogeneration from SQLAlchemy metadata as well.
29+
1730
For a more detailed overview and getting started guide, please see
1831
[our blog post](https://blog.kensho.com/compiled-graphql-as-a-database-query-language-72e106844282).
1932

20-
To pretty-print GraphQL queries, use the included pretty-printer:
21-
```
22-
python -m graphql_compiler.tool <input_file.graphql >output_file.graphql
23-
```
24-
It's modeled after Python's `json.tool`, reading from stdin and writing to stdout.
25-
2633
## Table of contents
2734
* [Features](#features)
2835
* [Querying OrientDB with GraphQL](#querying-orientdb-with-graphql)
@@ -55,6 +62,7 @@ It's modeled after Python's `json.tool`, reading from stdin and writing to stdou
5562
* [End-To-End SQL Example](#end-to-end-sql-example)
5663
* [Configuring the SQL Database to Match the GraphQL Schema](#configuring-the-sql-database-to-match-the-graphql-schema)
5764
* [Miscellaneous](#miscellaneous)
65+
* [Pretty-Printing GraphQL Queries](#pretty-printing-graphql-queries)
5866
* [Expanding `@optional` vertex fields](#expanding-optional-vertex-fields)
5967
* [Optional `type_equivalence_hints` compilation parameter](#optional-type_equivalence_hints-parameter)
6068
* [FAQ](#faq)
@@ -1303,6 +1311,15 @@ At this point, the `animal` view can be used in the SQLAlchemy Table for the pur
13031311

13041312
## Miscellaneous
13051313

1314+
### Pretty-Printing GraphQL Queries
1315+
1316+
To pretty-print GraphQL queries, use the included pretty-printer:
1317+
```
1318+
python -m graphql_compiler.tool <input_file.graphql >output_file.graphql
1319+
```
1320+
It's modeled after Python's `json.tool`, reading from stdin and writing to stdout.
1321+
1322+
13061323
### Expanding [`@optional`](#optional) vertex fields
13071324
Including an optional statement in GraphQL has no performance issues on its own,
13081325
but if you continue expanding vertex fields within an optional scope,

0 commit comments

Comments
 (0)