server

Documentation

Overview

Package server provides HTTP server functionality for sql-http-proxy.

Index

• func NewServeMux(db *sqlx.DB, cfg config.Config, configDir string) (http.Handler, error)
• type Executor
• type MutationHandler
  • func NewMutationHandler(db *sqlx.DB, mutation config.Mutation) (*MutationHandler, error)
• type QueryHandler
  • func NewQueryHandler(db *sqlx.DB, query config.Query) (*QueryHandler, error)
• type ResultProcessor

Functions

func NewServeMux

func NewServeMux(db *sqlx.DB, cfg config.Config, configDir string) (http.Handler, error)

NewServeMux creates a new chi Router with all configured handlers. db can be nil if all endpoints use mock. configDir is the directory of the config file for resolving relative paths.

Types

type Executor

type Executor[R any] interface {
	Execute(ctx context.Context, params map[string]any, opts executor.Options) (*R, error)
}

Executor is the interface for query/mutation executors.

type MutationHandler

type MutationHandler = baseHandler[executor.MutationResult]

MutationHandler handles HTTP requests for mutations.

func NewMutationHandler

func NewMutationHandler(db *sqlx.DB, mutation config.Mutation) (*MutationHandler, error)

NewMutationHandler creates a new MutationHandler. db can be nil if mock is configured.

type QueryHandler

type QueryHandler = baseHandler[executor.ExecuteResult]

QueryHandler handles HTTP requests for queries.

func NewQueryHandler

func NewQueryHandler(db *sqlx.DB, query config.Query) (*QueryHandler, error)

NewQueryHandler creates a new QueryHandler. db can be nil if mock is configured.

type ResultProcessor

type ResultProcessor[R any] interface {
	// BuildResponse returns (status, output, responseHeader) from the result.
	BuildResponse(result *R) (status int, output any, headers http.Header)
}

ResultProcessor handles result-specific response building.