Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

rest

package

Go to main page

Versions in this module

v1

v1.4.0

Apr 5, 2024

v1.3.16

Feb 22, 2024

v1.3.15

Feb 16, 2024

v1.3.14

Feb 13, 2024

v1.3.13

Feb 9, 2024

v1.3.12

Feb 8, 2024

v1.3.11

Feb 3, 2024

v1.3.10

Dec 12, 2023

v1.3.9

Dec 8, 2023

v1.3.8

Oct 30, 2023

v1.3.7

Oct 4, 2023

v1.3.6

Oct 4, 2023

v1.3.5

Sep 11, 2023

v1.3.4

May 26, 2023

v1.3.3

May 26, 2023

v1.3.2

Apr 13, 2023

v1.3.1

Jan 11, 2023

v1.3.0

Dec 6, 2022

v1.2.5

Oct 21, 2022

v1.2.4

Aug 5, 2022

v1.2.3

Aug 5, 2022

v1.2.2

Jul 19, 2022

v1.2.1

Mar 1, 2022

v1.2.0

Feb 14, 2022

v1.1.0

Jun 21, 2021

Changes in this version

+ const SLOW_QUERY_LOG_TIMEOUT_SECS

+ var RequestProxyStubFunc func() bool

+ func BucketNameLookup(req *http.Request) string

+ type PartitionStatsWriter interface

+ IndexDef func() *cbgt.IndexDef

+ SourcePartitionSeqs func() map[string]cbgt.UUIDSeq

+ VbStats func() bool

+ Verbose func() bool

+ Write func([]byte) (n int, err error)

type RESTPathStats

+ func (s *RESTPathStats) ResetFocusStats(focusVal string)

+ type TaskRequestHandler struct

+ func NewTaskRequestHandler(mgr *cbgt.Manager) *TaskRequestHandler

+ func (h *TaskRequestHandler) RESTOpts(opts map[string]string)

+ func (h *TaskRequestHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

v1.0.0

Jan 9, 2020

Changes in this version

+ const CLUSTER_ACTION

+ var ErrorAlreadyPropagated = errors.New("response already propagated")

+ var ErrorQueryReqRejected = errors.New("query request rejected")

+ var RESTMethodOrds = map[string]string

+ var RequestVariableLookup func(req *http.Request, name string) string = MuxVariableLookup

+ var RetryAfter = "30"

+ var StartTime = time.Now()

+ func Asset(name string) ([]byte, error)

+ func AssetDir(name string) ([]string, error)

+ func AssetFS() *assetfs.AssetFS

+ func AssetInfo(name string) (os.FileInfo, error)

+ func AssetNames() []string

+ func DiagGetPProf(w http.ResponseWriter, profile string, debug int)

+ func DocIDFromBody(req *http.Request) string

+ func DocIDLookup(req *http.Request) string

+ func ExtractSourceTypeName(req *http.Request, indexDef *cbgt.IndexDef, indexName string) (string, string)

+ func IndexNameLookup(req *http.Request) string

+ func InitRESTRouter(r *mux.Router, versionMain string, mgr *cbgt.Manager, ...) (*mux.Router, map[string]RESTMeta, error)

+ func InitRESTRouterEx(r *mux.Router, versionMain string, mgr *cbgt.Manager, ...) (*mux.Router, map[string]RESTMeta, error)

+ func InitStaticRouter(r *mux.Router, staticDir, staticETag string, pages []string, ...) *mux.Router

+ func InitStaticRouterEx(r *mux.Router, staticDir, staticETag string, pages []string, ...) *mux.Router

+ func MustAsset(name string) []byte

+ func MustEncode(w io.Writer, i interface{})

+ func MuxVariableLookup(req *http.Request, name string) string

+ func NewRESTRouter(versionMain string, mgr *cbgt.Manager, staticDir, staticETag string, ...) (*mux.Router, map[string]RESTMeta, error)

+ func PIndexNameLookup(req *http.Request) string

+ func PIndexTypesInitRouter(r *mux.Router, phase string, mgr *cbgt.Manager)

+ func PathFocusName(path string) string

+ func PropagateError(w http.ResponseWriter, requestBody []byte, msg string, code int)

+ func RESTGetRuntimeArgs(w http.ResponseWriter, r *http.Request)

+ func RESTGetRuntimeStats(w http.ResponseWriter, r *http.Request)

+ func RESTGetRuntimeStatsMem(w http.ResponseWriter, r *http.Request)

+ func RESTPostRuntimeGC(w http.ResponseWriter, r *http.Request)

+ func RESTProfileCPU(w http.ResponseWriter, r *http.Request)

+ func RESTProfileMemory(w http.ResponseWriter, r *http.Request)

+ func RestoreAsset(dir, name string) error

+ func RestoreAssets(dir, name string) error

+ func RewriteURL(to string, h http.Handler) http.Handler

+ func RuntimeTrace(w http.ResponseWriter, r *http.Request)

+ func ShowError(w http.ResponseWriter, req *http.Request, msg string, code int)

+ func ShowErrorBody(w http.ResponseWriter, requestBody []byte, msg string, code int)

+ func WriteManagerStatsJSON(mgr *cbgt.Manager, w io.Writer, indexName string) error

+ type CfgGetHandler struct

+ func NewCfgGetHandler(mgr *cbgt.Manager) *CfgGetHandler

+ func (h *CfgGetHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type CfgNodeDefsHandler struct

+ func NewCfgNodeDefsHandler(mgr *cbgt.Manager) *CfgNodeDefsHandler

+ func (h *CfgNodeDefsHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type CfgPlanPIndexesHandler struct

+ func NewCfgPlanPIndexesHandler(mgr *cbgt.Manager) *CfgPlanPIndexesHandler

+ func (h *CfgPlanPIndexesHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type CfgRefreshHandler struct

+ func NewCfgRefreshHandler(mgr *cbgt.Manager) *CfgRefreshHandler

+ func (h *CfgRefreshHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type CountHandler struct

+ func NewCountHandler(mgr *cbgt.Manager) *CountHandler

+ func (h *CountHandler) RESTOpts(opts map[string]string)

+ func (h *CountHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type CountPIndexHandler struct

+ func NewCountPIndexHandler(mgr *cbgt.Manager) *CountPIndexHandler

+ func (h *CountPIndexHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type CountResponseWriter struct

+ ResponseWriter http.ResponseWriter

+ TotBytesWritten uint64

+ Wrote bool

+ func (cw *CountResponseWriter) CloseNotify() <-chan bool

+ func (cw *CountResponseWriter) Header() http.Header

+ func (cw *CountResponseWriter) Write(p []byte) (n int, err error)

+ func (cw *CountResponseWriter) WriteHeader(n int)

+ type CreateIndexHandler struct

+ func NewCreateIndexHandler(mgr *cbgt.Manager) *CreateIndexHandler

+ func (h *CreateIndexHandler) RESTOpts(opts map[string]string)

+ func (h *CreateIndexHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type DeleteIndexHandler struct

+ func NewDeleteIndexHandler(mgr *cbgt.Manager) *DeleteIndexHandler

+ func (h *DeleteIndexHandler) RESTOpts(opts map[string]string)

+ func (h *DeleteIndexHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type DiagGetHandler struct

+ func NewDiagGetHandler(versionMain string, mgr *cbgt.Manager, mr *cbgt.MsgRing, ...) *DiagGetHandler

+ func (h *DiagGetHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type ETagFileHandler struct

+ func (mfh ETagFileHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type GetIndexHandler struct

+ func NewGetIndexHandler(mgr *cbgt.Manager) *GetIndexHandler

+ func (h *GetIndexHandler) RESTOpts(opts map[string]string)

+ func (h *GetIndexHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type GetPIndexHandler struct

+ func NewGetPIndexHandler(mgr *cbgt.Manager) *GetPIndexHandler

+ func (h *GetPIndexHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type HandlerWithRESTMeta struct

+ RESTMeta *RESTMeta

+ func NewHandlerWithRESTMeta(h http.Handler, restMeta *RESTMeta, pathStats *RESTPathStats, focusName string) *HandlerWithRESTMeta

+ func (h *HandlerWithRESTMeta) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type IndexControlHandler struct

+ func NewIndexControlHandler(mgr *cbgt.Manager, control string, allowedOps map[string]bool) *IndexControlHandler

+ func (h *IndexControlHandler) RESTOpts(opts map[string]string)

+ func (h *IndexControlHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type ListIndexHandler struct

+ func NewListIndexHandler(mgr *cbgt.Manager) *ListIndexHandler

+ func (h *ListIndexHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type ListPIndexHandler struct

+ func NewListPIndexHandler(mgr *cbgt.Manager) *ListPIndexHandler

+ func (h *ListPIndexHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type LogGetHandler struct

+ func NewLogGetHandler(mgr *cbgt.Manager, mr *cbgt.MsgRing) *LogGetHandler

+ func (h *LogGetHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type ManagerHandler struct

+ func NewManagerHandler(mgr *cbgt.Manager) *ManagerHandler

+ func (h *ManagerHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type ManagerKickHandler struct

+ func NewManagerKickHandler(mgr *cbgt.Manager) *ManagerKickHandler

+ func (h *ManagerKickHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type ManagerMetaHandler struct

+ func NewManagerMetaHandler(mgr *cbgt.Manager, meta map[string]RESTMeta) *ManagerMetaHandler

+ func (h *ManagerMetaHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type ManagerOptions struct

+ Validate func(opt map[string]string) (map[string]string, error)

+ func NewManagerOptions(mgr *cbgt.Manager) *ManagerOptions

+ func (h *ManagerOptions) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type MetaDesc struct

+ Description string

+ StartSample interface{}

+ StartSampleDocs map[string]string

+ type MetaDescIndex struct

+ CanCount bool

+ CanQuery bool

+ QueryHelp string

+ QuerySamples interface{}

+ UI map[string]string

+ type MetaDescSource MetaDesc

+ type NoopHandler struct

+ func (h *NoopHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type PIndexLookUpHandler struct

+ func NewPIndexLookUpHandler(mgr *cbgt.Manager) *PIndexLookUpHandler

+ func (h *PIndexLookUpHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type QueryHandler struct

+ func NewQueryHandler(mgr *cbgt.Manager, pathStats *RESTPathStats) *QueryHandler

+ func (h *QueryHandler) RESTOpts(opts map[string]string)

+ func (h *QueryHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type QueryPIndexHandler struct

+ func NewQueryPIndexHandler(mgr *cbgt.Manager) *QueryPIndexHandler

+ func (h *QueryPIndexHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type RESTCfg struct

+ IndexDefs *cbgt.IndexDefs

+ IndexDefsCAS uint64

+ IndexDefsErr error

+ NodeDefsKnown *cbgt.NodeDefs

+ NodeDefsKnownCAS uint64

+ NodeDefsKnownErr error

+ NodeDefsWanted *cbgt.NodeDefs

+ NodeDefsWantedCAS uint64

+ NodeDefsWantedErr error

+ PlanPIndexes *cbgt.PlanPIndexes

+ PlanPIndexesCAS uint64

+ PlanPIndexesErr error

+ Status string

+ type RESTFocusStats struct

+ TotClientRequest uint64

+ TotClientRequestTimeNS uint64

+ TotInternalRequest uint64

+ TotInternalRequestTimeNS uint64

+ TotRequest uint64

+ TotRequestErr uint64

+ TotRequestSlow uint64

+ TotRequestTimeNS uint64

+ TotRequestTimeout uint64

+ TotResponseBytes uint64

+ func (s *RESTFocusStats) AtomicCopyTo(r *RESTFocusStats)

+ type RESTMeta struct

+ Method string

+ Opts map[string]string

+ Path string

+ type RESTOpts interface

+ RESTOpts func(map[string]string)

+ type RESTPathStats struct

+ func (s *RESTPathStats) FocusStats(focusVal string) *RESTFocusStats

+ func (s *RESTPathStats) FocusValues() (rv []string)

+ type RuntimeGetHandler struct

+ func NewRuntimeGetHandler(versionMain string, mgr *cbgt.Manager) *RuntimeGetHandler

+ func (h *RuntimeGetHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type SourcePartitionSeqsHandler struct

+ func NewSourcePartitionSeqsHandler(mgr *cbgt.Manager) *SourcePartitionSeqsHandler

+ func (h *SourcePartitionSeqsHandler) RESTOpts(opts map[string]string)

+ func (h *SourcePartitionSeqsHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type SourceStatsHandler struct

+ func NewSourceStatsHandler(mgr *cbgt.Manager) *SourceStatsHandler

+ func (h *SourceStatsHandler) RESTOpts(opts map[string]string)

+ func (h *SourceStatsHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type StatsHandler struct

+ func NewStatsHandler(mgr *cbgt.Manager) *StatsHandler

+ func (h *StatsHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)