engine

README

Engine

This package refers to the handling of the Prisma query engine. It handles the lifecycle of starting the engine, sending requests to it, and shutting it down.

The main implementation is the QueryEngine, which refers to the rust query engine. Alternative implementations are the data proxy, which is a remote query engine hosted by Prisma, and a mock engine used for testing.

Documentation

Index

• type Data
• type DataProxyEngine
  • func NewDataProxyEngine(schema, connectionURL string) *DataProxyEngine
  • func (e *DataProxyEngine) Batch(ctx context.Context, payload interface{}, into interface{}) error
  • func (e *DataProxyEngine) Connect() error
  • func (e *DataProxyEngine) Disconnect() error
  • func (e *DataProxyEngine) Do(ctx context.Context, payload interface{}, into interface{}) error
  • func (e *DataProxyEngine) Name() string
• type Engine
• type GQLBatchRequest
• type GQLBatchResponse
• type GQLError
• type GQLRequest
• type GQLResponse
• type QueryEngine
  • func NewQueryEngine(schema string, hasBinaryTargets bool) *QueryEngine
  • func (e *QueryEngine) Batch(ctx context.Context, payload interface{}, v interface{}) error
  • func (e *QueryEngine) Connect() error
  • func (e *QueryEngine) Disconnect() error
  • func (e *QueryEngine) Do(ctx context.Context, payload interface{}, v interface{}) error
  • func (e *QueryEngine) Name() string
  • func (e *QueryEngine) ReplaceSchema(replace func(schema string) string)
  • func (e *QueryEngine) Request(ctx context.Context, method string, path string, payload interface{}) ([]byte, error)

Types

type Data

type Data struct {
	Result json.RawMessage `json:"result"`
}

type DataProxyEngine

type DataProxyEngine struct {

	// Schema contains the prisma Schema
	Schema string
	// contains filtered or unexported fields
}

func NewDataProxyEngine

func NewDataProxyEngine(schema, connectionURL string) *DataProxyEngine

func (*DataProxyEngine) Batch

func (e *DataProxyEngine) Batch(ctx context.Context, payload interface{}, into interface{}) error

func (*DataProxyEngine) Connect

func (e *DataProxyEngine) Connect() error

func (*DataProxyEngine) Disconnect

func (e *DataProxyEngine) Disconnect() error

func (*DataProxyEngine) Do

func (e *DataProxyEngine) Do(ctx context.Context, payload interface{}, into interface{}) error

func (*DataProxyEngine) Name

func (e *DataProxyEngine) Name() string

type Engine

type Engine interface {
	Connect() error
	Disconnect() error
	Do(ctx context.Context, payload interface{}, into interface{}) error
	Batch(ctx context.Context, payload interface{}, into interface{}) error
	Name() string
}

type GQLBatchRequest

type GQLBatchRequest struct {
	Batch       []GQLRequest `json:"batch"`
	Transaction bool         `json:"transaction"`
}

GQLBatchRequest is the payload for GraphQL queries

type GQLBatchResponse

type GQLBatchResponse struct {
	Errors []GQLError    `json:"errors"`
	Result []GQLResponse `json:"batchResult"`
}

type GQLError

type GQLError struct {
	Message    string                 `json:"error"` // note: the query-engine uses 'error' instead of 'message'
	Path       []string               `json:"path"`
	Extensions map[string]interface{} `json:"query"`
}

GQLError is a GraphQL Error

type GQLRequest

type GQLRequest struct {
	Query     string                 `json:"query"`
	Variables map[string]interface{} `json:"variables"`
}

GQLRequest is the payload for GraphQL queries

type GQLResponse

type GQLResponse struct {
	Data       Data                   `json:"data"`
	Errors     []GQLError             `json:"errors"`
	Extensions map[string]interface{} `json:"extensions"`
}

GQLResponse is the default GraphQL response

type QueryEngine

type QueryEngine struct {

	// Schema contains the prisma Schema
	Schema string
	// contains filtered or unexported fields
}

func NewQueryEngine

func NewQueryEngine(schema string, hasBinaryTargets bool) *QueryEngine

func (*QueryEngine) Batch

func (e *QueryEngine) Batch(ctx context.Context, payload interface{}, v interface{}) error

Do sends the http Request to the query engine and unmarshals the response

func (*QueryEngine) Connect

func (e *QueryEngine) Connect() error

func (*QueryEngine) Disconnect

func (e *QueryEngine) Disconnect() error

func (*QueryEngine) Do

func (e *QueryEngine) Do(ctx context.Context, payload interface{}, v interface{}) error

Do sends the http Request to the query engine and unmarshals the response

func (*QueryEngine) Name

func (e *QueryEngine) Name() string

func (*QueryEngine) ReplaceSchema

func (e *QueryEngine) ReplaceSchema(replace func(schema string) string)

deprecated

func (*QueryEngine) Request

func (e *QueryEngine) Request(ctx context.Context, method string, path string, payload interface{}) ([]byte, error)