graphql

Documentation

Index

• Variables
• func GinContextFrom(ctx context.Context) *gin.Context
• func NewExecutableSchema(cfg Config) graphql.ExecutableSchema
• func WithInGinCtx() gin.HandlerFunc
• type ComplexityRoot
• type Config
• type CreateTask
• type DeleteTask
• type DirectiveRoot
• type MutationResolver
• type Pair
• type PairInput
• type QueryResolver
• type Resolver
  • func (r *Resolver) Mutation() MutationResolver
  • func (r *Resolver) Query() QueryResolver
• type ResolverRoot
• type Server
  • func (s *Server) RegisterRouter(r *gin.Engine)
• type Staff
• type StaffInput
• type Storage
• type StorageInput
• type StorageType
  • func (e StorageType) IsValid() bool
  • func (e StorageType) MarshalGQL(w io.Writer)
  • func (e StorageType) String() string
  • func (e *StorageType) UnmarshalGQL(v interface{}) error
• type Task
• type TaskStatus
  • func (e TaskStatus) IsValid() bool
  • func (e TaskStatus) MarshalGQL(w io.Writer)
  • func (e TaskStatus) String() string
  • func (e *TaskStatus) UnmarshalGQL(v interface{}) error
• type TaskType
  • func (e TaskType) IsValid() bool
  • func (e TaskType) MarshalGQL(w io.Writer)
  • func (e TaskType) String() string
  • func (e *TaskType) UnmarshalGQL(v interface{}) error

Variables

var AllStorageType = []StorageType{
	StorageTypeFs,
	StorageTypeQingstor,
}

var AllTaskStatus = []TaskStatus{
	TaskStatusCreated,
	TaskStatusReady,
	TaskStatusRunning,
	TaskStatusFinished,
	TaskStatusStopped,
	TaskStatusError,
}

var AllTaskType = []TaskType{
	TaskTypeCopyDir,
}

Functions

func GinContextFrom

func GinContextFrom(ctx context.Context) *gin.Context

GinContextFrom retrieve gin.Context from request's context inspired from https://gqlgen.com/recipes/gin/#accessing-gincontext

func NewExecutableSchema

func NewExecutableSchema(cfg Config) graphql.ExecutableSchema

NewExecutableSchema creates an ExecutableSchema from the ResolverRoot interface.

func WithInGinCtx

func WithInGinCtx() gin.HandlerFunc

WithInGinCtx set gin context into request's context with key ginCtxKey inspired from https://gqlgen.com/recipes/gin/#accessing-gincontext

Types

type ComplexityRoot

type ComplexityRoot struct {
	Mutation struct {
		CreateTask func(childComplexity int, input *CreateTask) int
		DeleteTask func(childComplexity int, input *DeleteTask) int
		RunTask    func(childComplexity int, id string) int
	}

	Pair struct {
		Key   func(childComplexity int) int
		Value func(childComplexity int) int
	}

	Query struct {
		Task  func(childComplexity int, id string) int
		Tasks func(childComplexity int) int
	}

	Staff struct {
		ID func(childComplexity int) int
	}

	Storage struct {
		Options func(childComplexity int) int
		Type    func(childComplexity int) int
	}

	Task struct {
		CreatedAt func(childComplexity int) int
		ID        func(childComplexity int) int
		Name      func(childComplexity int) int
		Options   func(childComplexity int) int
		Staffs    func(childComplexity int) int
		Status    func(childComplexity int) int
		Storages  func(childComplexity int) int
		Type      func(childComplexity int) int
		UpdatedAt func(childComplexity int) int
	}
}

type Config

type Config struct {
	Resolvers  ResolverRoot
	Directives DirectiveRoot
	Complexity ComplexityRoot
}

type CreateTask

type CreateTask struct {
	Name     string          `json:"name"`
	Type     TaskType        `json:"type"`
	Storages []*StorageInput `json:"storages"`
	Options  []*PairInput    `json:"options"`
	Staffs   []*StaffInput   `json:"staffs"`
}

type DeleteTask

type DeleteTask struct {
	ID string `json:"id"`
}

type DirectiveRoot

type DirectiveRoot struct {
}

type MutationResolver

type MutationResolver interface {
	CreateTask(ctx context.Context, input *CreateTask) (*Task, error)
	DeleteTask(ctx context.Context, input *DeleteTask) (*Task, error)
	RunTask(ctx context.Context, id string) (*Task, error)
}

type Pair

type Pair struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

type PairInput

type PairInput struct {
	Key   string `json:"key"`
	Value string `json:"value"`
}

type QueryResolver

type QueryResolver interface {
	Task(ctx context.Context, id string) (*Task, error)
	Tasks(ctx context.Context) ([]*Task, error)
}

type Resolver

type Resolver struct {
	DB      *models.DB
	Manager *task.Manager
}

func (*Resolver) Mutation

func (r *Resolver) Mutation() MutationResolver

Mutation returns MutationResolver implementation.

func (*Resolver) Query

func (r *Resolver) Query() QueryResolver

Query returns QueryResolver implementation.

type ResolverRoot

type ResolverRoot interface {
	Mutation() MutationResolver
	Query() QueryResolver
}

type Server

type Server struct {
	Path  string
	Debug bool

	DB      *models.DB
	Manager *task.Manager
}

func (*Server) RegisterRouter

func (s *Server) RegisterRouter(r *gin.Engine)

type Staff

type Staff struct {
	ID string `json:"id"`
}

type StaffInput

type StaffInput struct {
	ID string `json:"id"`
}

type Storage

type Storage struct {
	Type    StorageType `json:"type"`
	Options []*Pair     `json:"options"`
}

type StorageInput

type StorageInput struct {
	Type    StorageType  `json:"type"`
	Options []*PairInput `json:"options"`
}

type StorageType

type StorageType string

const (
	StorageTypeFs       StorageType = "Fs"
	StorageTypeQingstor StorageType = "Qingstor"
)

func (StorageType) IsValid

func (e StorageType) IsValid() bool

func (StorageType) MarshalGQL

func (e StorageType) MarshalGQL(w io.Writer)

func (StorageType) String

func (e StorageType) String() string

func (*StorageType) UnmarshalGQL

func (e *StorageType) UnmarshalGQL(v interface{}) error

type Task

type Task struct {
	ID        string     `json:"id"`
	Name      string     `json:"name"`
	Type      TaskType   `json:"type"`
	Status    TaskStatus `json:"status"`
	CreatedAt time.Time  `json:"created_at"`
	UpdatedAt time.Time  `json:"updated_at"`
	Storages  []*Storage `json:"storages"`
	Options   []*Pair    `json:"options"`
	Staffs    []*Staff   `json:"staffs"`
}

type TaskStatus

type TaskStatus string

const (
	TaskStatusCreated  TaskStatus = "Created"
	TaskStatusReady    TaskStatus = "Ready"
	TaskStatusRunning  TaskStatus = "Running"
	TaskStatusFinished TaskStatus = "Finished"
	TaskStatusStopped  TaskStatus = "Stopped"
	TaskStatusError    TaskStatus = "Error"
)

func (TaskStatus) IsValid

func (e TaskStatus) IsValid() bool

func (TaskStatus) MarshalGQL

func (e TaskStatus) MarshalGQL(w io.Writer)

func (TaskStatus) String

func (e TaskStatus) String() string

func (*TaskStatus) UnmarshalGQL

func (e *TaskStatus) UnmarshalGQL(v interface{}) error

type TaskType

type TaskType string

const (
	TaskTypeCopyDir TaskType = "copyDir"
)

func (TaskType) IsValid

func (e TaskType) IsValid() bool

func (TaskType) MarshalGQL

func (e TaskType) MarshalGQL(w io.Writer)

func (TaskType) String

func (e TaskType) String() string

func (*TaskType) UnmarshalGQL

func (e *TaskType) UnmarshalGQL(v interface{}) error