# dgraph-koa

> Generate graphql schema for dgraph.

Latest version **0.0.3** (published 2019-02-05) · BSD-2-Clause license · 0 weekly downloads

## Install

```sh
npm install dgraph-koa
pnpm add dgraph-koa
yarn add dgraph-koa
bun add dgraph-koa
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2019-02-05 |
| First published | 2019-02-05 |
| Weekly downloads | 0 |
| License | BSD-2-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 10 |
| Unpacked size | 73.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Ashok Vishwakarma |
| Maintainers | ashokvishwakarma |

## Links

- npm: https://www.npmjs.com/package/dgraph-koa
- Repository: https://github.com/ashokvishwakarma/dgraph-koa
- Issues: https://github.com/ashokvishwakarma/dgraph-koa/issues
- npm.io page: https://npm.io/package/dgraph-koa

## Dependencies (10)

- [koa](https://npm.io/package/koa.md) ^2.7.0
- [grpc](https://npm.io/package/grpc.md) ^1.18.0
- [graphql](https://npm.io/package/graphql.md) ^0.12.0
- [dgraph-js](https://npm.io/package/dgraph-js.md) ^1.0.0
- [invariant](https://npm.io/package/invariant.md) ^2.2.2
- [koa-mount](https://npm.io/package/koa-mount.md) ^4.0.0
- [pluralize](https://npm.io/package/pluralize.md) ^5.0.0
- [koa-graphql](https://npm.io/package/koa-graphql.md) ^0.8.0
- [babel-runtime](https://npm.io/package/babel-runtime.md) ^6.26.0
- [graphql-tools](https://npm.io/package/graphql-tools.md) ^2.14.0

## Recent versions

- 0.0.3 (latest) — 2019-02-05
- 0.0.2 — 2019-02-05
- 0.0.1 — 2019-02-05

## README

# DgraphKoa
Build a GraphQL application using Dgraph and Koa


## Introduction

Dgraph is a distributed, highly available graph database that uses a language
similar to GraphQL to query and mutate data. Unlike GraphQL, Dgraph only defines
schema for predicates (properties) within the graph; there is no concept of
complex types or groups of properties. Because of this it is straight forward to
store any GraphQL schema in Dgraph provided a few restrictions are met.

Given a GraphQL schema, DgraphKoa can do four things:

1. Generate a GraphQL-JS schema that maps GraphQL queries to Dgraph queries
2. Transform Dgraph responses into GraphQL responses (including support for the
   relay connection specification)
3. Generate defaults for create/update/delete/query operations (with filtering,
   ordering and nested create/update mutations)
4. Configure Dgraph's schema with types and indexes each property.


## Getting Started

The [example](https://github.com/ashokvishwakarma/dgraph-koa/tree/master/example) describes
basic usage. First, install dependencies:

```sh
npm install
```

## Using DgraphKoa

Install DgraphQL from npm


```sh
npm install dgraph-koa
```

The entry point to the library is `Server`

```javascript
import { Server } from 'dgraph-koa'

const schema = `
type Person {
  id: ID!
  name: String @filter(types: [EQUALITY])
  children: [Person!]! @reverse(name: "parents")
  parents: [Person!]! @reverse(name: "children")
}`

(async () => {
  const server = new Server({
    debug: true,
    relay: false,
    graphiql: true, // enable Graphiql UI
    graphiqlUrl: '/graphql', // URL for graphql middleware
    dgraph: {
      uri: 'localhost:9080' // Dgraph database uri
    }
  });

  server.updateSchema(schema);

  server.listen(4000, '0.0.0.0', () => {
    console.log("Server started at http://0.0.0.0:4000")
  });
})();
```

### config
DgraphKoa config passed in `Server constructor`

```
debug: boolean // default true
relay: boolean // default false
graphiql: boolean // default true
graphiqlUrl: string // degault /graphql
dgraph: {
  url: string // default localhost:9080,
  credentials: grpc // default grpc.credentials.createInsecure()
}
```

### Adding other routes
The DgraphKoa allow you to add more middlewares and routing rules into the Koa application

```javascript
const server = new Server(...config);

// server.app actual Koa app

server.app.use(
  // middleware
);

server.use(
  // routing rules
);

server.listen(
  // port
  // host
  // callback
)
```

### Special Thanks
[David Peek](https://github.com/dpeek) for his [dgaphql](https://github.com/dpeek/dgraphql) github repo.

---
_Source: https://npm.io/package/dgraph-koa · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._