graphqlapi

Documentation

Overview

                         _       _
*__      _____  __ ___   ___  __ _| |_ ___
*\ \ /\ / / _ \/ _` \ \ / / |/ _` | __/ _ \
* \ V  V /  __/ (_| |\ V /| | (_| | ||  __/
*  \_/\_/ \___|\__,_| \_/ |_|\__,_|\__\___|
*
* Copyright © 2016 - 2019 Weaviate. All rights reserved.
* LICENSE: https://github.com/creativesoftwarefdn/weaviate/blob/develop/LICENSE.md
* DESIGN & CONCEPT: Bob van Luijt (@bobvanluijt)
* CONTACT: hello@creativesoftwarefdn.org

Package graphqlapi provides the graphql endpoint for Weaviate

Index

• type ClosingResolver
• type ContextionaryProvider
• type DatabaseResolverProvider
• type GraphQL
  • func Build(dbSchema *schema.Schema, peers peers.Peers, resolverProvider ResolverProvider, ...) (GraphQL, error)
• type NetworkResolverProvider
• type Resolver
• type ResolverProvider

Types

type ClosingResolver

type ClosingResolver interface {
	local.Resolver

	// Close the handle of this resolver
	Close()
}

In practise, we need a read lock on the database to run GraphQL queries.

type ContextionaryProvider

type ContextionaryProvider interface {
	GetContextionary() fetch.Contextionary
}

type DatabaseResolverProvider

type DatabaseResolverProvider interface {
	GetResolver() (ClosingResolver, error)
}

type GraphQL

type GraphQL interface {
	// Resolve the GraphQL query in 'query'.
	Resolve(query string, operationName string, variables map[string]interface{}, context context.Context) *graphql.Result
}

The communication interface between the REST API and the GraphQL API.

func Build

func Build(dbSchema *schema.Schema, peers peers.Peers, resolverProvider ResolverProvider, logger *messages.Messaging) (GraphQL, error)

Construct a GraphQL API from the database schema, and resolver interface.

type NetworkResolverProvider

type NetworkResolverProvider interface {
	GetNetworkResolver() network.Resolver
}

type Resolver

type Resolver interface {
	local.Resolver
	network.Resolver
}

This type can resolve any GraphQL query. It is the aggregation of all resolver interfaces.

type ResolverProvider

type ResolverProvider interface {
	DatabaseResolverProvider
	NetworkResolverProvider
	ContextionaryProvider
}