rareddy/teiid-graphql

Teiid GraphQL Engine based GraphBack

Graphback Runtime Example

Template that showcases Graphback runtime generation capabilities using resolver layer generated in memory.

Example

To use runtime capabilities developers will need to create data provider. Currently 2 data providers are supported:

• KnexDBDataProvider
• PgKnexDBDataProvider

Then developers can create runtime instance:

    const client = new Knex(...);
    const graphbackOptions = {...}
    const modelString = `type Test ...`
    
    // Create backend
    const backend = new GraphQLBackendCreator(modelString, graphbackOptions);
    const dbClientProvider = new PgKnexDBDataProvider(client);
    const runtime = await backend.createRuntime(dbClientProvider);
    console.log(runtime.schema,  runtime.resolvers)

See ./runtime.ts for a fully functional example.

Running example using Postgres database

The project has been created using graphback. Run the project using the following steps.

• Start the database

docker-compose up -d

• Define your schema in the model/runtime.graphql file. Or use the default:

type User {
  id: ID!
  name: String
}

• Start the server

npm run develop

Or, if using yarn

yarn develop

Running example using SQLite database

The project has been created using graphback. Run the project using the following steps.

• Modify the db json object in the graphback.json config file. For an in-memory database, use the below config as-is, alternatively replace :in-memory: with the desired filename.

"db": {
  "dbConfig": {
    "filename": ":in-memory:"
  },
  "database": "sqlite3"
},

• Next modify the runtime.ts file and change the PGKnexDataProvider to KnexDBDataProvider.

...

import {
  ...
  KnexDBDataProvider
} from 'graphback'

...

const dbClientProvider = new KnexDBDataProvider(client);

...

• Define your schema in the model/runtime.graphql file. Or use the default:

type User {
  id: ID!
  name: String
}

• Start the server (for the first time)

npm run develop

Or, if using yarn

yarn develop

If the server is being re-run, modify the src/runtime.ts and comment out the migrateDb function, since it will not be possible to re-migrate the database with SQLite3.

Enjoy the runtime app