Skip to content

Commit

Permalink
chore(docs): [skip-ci] docs for queries, pagination, sorting (#4) (#374)
Browse files Browse the repository at this point in the history
* docs(docs): pagination, queries, sorting

* docs(docs): update announcing-hydra-v3.md

Co-authored-by: Metin Demir <metmirr@users.noreply.github.com>
  • Loading branch information
dzhelezov and metmirr authored May 3, 2021
1 parent fedd416 commit c27bdc5
Show file tree
Hide file tree
Showing 10 changed files with 495 additions and 164 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ and answer the prompts. It will generate a sample project and README with setup

The monorepo contains the following sub-packages:

* [Hydra CLI](packages/hydra-cli/README.md): Codegen tools to set up and run a Hydra pipeline
* [Hydra Indexer](packages/hydra-indexer/README.md): Hydra indexer for ingesting raw events and extrinsics
* [Hydra Indexer Gateway](packages/hydra-indexer-gateway/README.md): GraphQL interface for the Indexer
* [Hydra Processor](packages/hydra-processor/README.md): Processing part of the pipeline for transforming events into rich business-level objects
* [Hydra Typegen](packages/hydra-typegen/README.md): A tool for generating typesafe typescript classes for events and extrinsics from the runtime metadata. No more manual deserialization of the event data.
* [Sample Project](packages/sample/README.md): A quickstart Hydra project set up against a publicly available Kusama indexer. Good starting point.
* [Docs](https://app.gitbook.com/@dzhelezov/s/hydra/): In-depth documentation covering the Hydra pipeline and API features, such as full-text search, pagination, extensive filtering and a rich GraphQL dialect defining your schema!
* [Hydra CLI](./packages/hydra-cli/README.md): Codegen tools to set up and run a Hydra pipeline
* [Hydra Indexer](./packages/hydra-indexer/README.md): Hydra indexer for ingesting raw events and extrinsics
* [Hydra Indexer Gateway](./packages/hydra-indexer-gateway/README.md): GraphQL interface for the Indexer
* [Hydra Processor](./packages/hydra-processor/README.md): Processing part of the pipeline for transforming events into rich business-level objects
* [Hydra Typegen](./packages/hydra-typegen/README.md): A tool for generating typesafe typescript classes for events and extrinsics from the runtime metadata. No more manual deserialization of the event data.
* [Sample Project](./packages/sample/README.md): A quickstart Hydra project set up against a publicly available Kusama indexer. Good starting point.
* [Docs](./docs/README.md): In-depth documentation covering the Hydra pipeline and API features, such as full-text search, pagination, extensive filtering and a rich GraphQL dialect defining your schema!

13 changes: 10 additions & 3 deletions SUMMARY.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,16 @@
# Table of contents

* [Hydra](README.md)
* [Hydra CLI](packages/hydra-cli/README.md)
* [Hydra Indexer](packages/hydra-indexer/README.md)
* [Hydra Indexer Gateway](packages/hydra-indexer-gateway/README.md)
* [Hydra Processor](packages/hydra-processor/README.md)
* [Hydra Typegen](packages/hydra-typegen/README.md)
* [Overview](docs/README.md)
* [Query Node Manifest](docs/manifest-spec.md)
* [Query Node Queries](docs/queries.md)
* [Pagination](docs/paginate-query-results.md)
* [Sorting](docs/sort-query-results.md)
* [Mappings](docs/mappings/README.md)
* [DatabaseManager](docs/mappings/databasemanager.md)
* [SubstrateEvent](docs/mappings/substrateevent.md)
Expand All @@ -15,10 +23,9 @@
* [Full-text queries](docs/schema-spec/full-text-queries.md)
* [Entity Relationships](docs/schema-spec/entity-relationship.md)
* [Install Hydra](docs/install-hydra.md)
* [Query Node schema](docs/query-node-schema.md)
* [Tutorial](docs/quick-start.md)
* [GraphQL Entity Relationships](docs/entity-relationship.md)
* [GraphQL Entity Relationships](docs/graphql-entity-relationships.md)
* [Architecture](docs/architecture.md)
* [Migration to Hydra v2](migration-to-hydra-v2.md)
* [Announcing Hydra v3](announcing-hydra-v3.md)
* [What's new in Hydra v3](announcing-hydra-v3.md)

16 changes: 8 additions & 8 deletions announcing-hydra-v3.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
# Announcing Hydra v3
# What's new in Hydra v3

Hydra v3 is already in the works. Here are the main features planned:

* Support for filtering by relations
* Define block ranges for any mapping, i.e. specify that your mapping X should be run only from block 5 to block 7
* Import all model files from a single library. Instead of the cumbersome
* Support for adding relations to variant types
* Ordering by multiple fields
* Multiple filters in the same query \(`AND` and `OR`\)
* Filters for mapping handlers: specify heights and runtime spec version range
* Import all model files from a single library. Instead of the cumbersome

```typescript
import { MyEntity1 } from '../generated/graphql-server/my-entity2/my-entity2.model'
import { MyEntity2 } from '../generated/graphql-server/my-entity2/my-entity2.model'

import { MyEntity1 } from '../generated/graphql-server/my-entity2/my-entity2.model'
import { MyEntity2 } from '../generated/graphql-server/my-entity2/my-entity2.model'
```

write
Expand All @@ -18,5 +20,3 @@ write
import { MyEntity1, MyEntity2 } from '../generated/graphql-server/model'
```



140 changes: 0 additions & 140 deletions docs/entity-relationship.md

This file was deleted.

2 changes: 2 additions & 0 deletions docs/graphql-entity-relationships.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
# GraphQL Entity Relationships

2 changes: 1 addition & 1 deletion docs/mappings/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ mappings:
handler: timestampCall(DatabaseManager, Timestamp.SetCall)
```
Each handler may have an arbitrary number of arguments, and at most one argument of type `DatabaseManager` and `SubstrateEvent`
Each handler may have an arbitrary number of arguments, and at most one argument of type `DatabaseManager` and `SubstrateEvent`

Let us look at the sample mapping generated by the scaffolder

Expand Down
Loading

0 comments on commit c27bdc5

Please sign in to comment.