Documentation
¶
Index ¶
Constants ¶
View Source
const ( // M3DBServiceName is the service name for M3DB. M3DBServiceName = "m3db" // ServicesPathName is the services part of the API path. ServicesPathName = "services" // M3DBNodeNamespacesKey is the KV key that holds namespaces. M3DBNodeNamespacesKey = "m3db.node.namespaces" // NamespacePathName is the namespace part of the API path. NamespacePathName = "namespace" // SchemaPathName is the schema part of the API path. SchemaPathName = "schema" )
View Source
const ( // DeleteHTTPMethod is the HTTP method used with this resource. DeleteHTTPMethod = http.MethodDelete )
Variables ¶
View Source
var ( // DeprecatedM3DBAddURL is the old url for the namespace add handler, maintained // for backwards compatibility. DeprecatedM3DBAddURL = path.Join(handler.RoutePrefixV1, NamespacePathName) // M3DBAddURL is the url for the M3DB namespace add handler. M3DBAddURL = path.Join(handler.RoutePrefixV1, M3DBServiceNamespacePathName) // AddHTTPMethod is the HTTP method used with this resource. AddHTTPMethod = http.MethodPost )
View Source
var ( // M3DBServiceNamespacePathName is the M3DB service namespace API path. M3DBServiceNamespacePathName = path.Join(ServicesPathName, M3DBServiceName, NamespacePathName) // M3DBServiceSchemaPathName is the M3DB service schema API path. M3DBServiceSchemaPathName = path.Join(ServicesPathName, M3DBServiceName, SchemaPathName) )
View Source
var ( // DeprecatedM3DBDeleteURL is the deprecated url for the M3DB namespace delete handler. // Maintained for backwards compatibility. DeprecatedM3DBDeleteURL = fmt.Sprintf("%s/namespace/{%s}", handler.RoutePrefixV1, namespaceIDVar) // M3DBDeleteURL is the url for the M3DB namespace delete handler. M3DBDeleteURL = path.Join( handler.RoutePrefixV1, M3DBServiceNamespacePathName, fmt.Sprintf("{%s}", namespaceIDVar), ) )
View Source
var ( // DeprecatedM3DBGetURL is the deprecated url for the namespace get handler (with the GET method). // Maintained for backwards compatibility. DeprecatedM3DBGetURL = path.Join(handler.RoutePrefixV1, NamespacePathName) // M3DBGetURL is the url for the namespace get handler (with the GET method). M3DBGetURL = path.Join(handler.RoutePrefixV1, M3DBServiceNamespacePathName) // GetHTTPMethod is the HTTP method used with this resource. GetHTTPMethod = http.MethodGet )
View Source
var ( // M3DBSchemaURL is the url for the M3DB schema handler. M3DBSchemaURL = path.Join(handler.RoutePrefixV1, M3DBServiceSchemaPathName) // SchemaDeployHTTPMethod is the HTTP method used to append to this resource. SchemaDeployHTTPMethod = http.MethodPost )
Functions ¶
func RegisterRoutes ¶
func RegisterRoutes( r *mux.Router, client clusterclient.Client, defaults []handler.ServiceOptionsDefault, instrumentOpts instrument.Options, )
RegisterRoutes registers the namespace routes.
Types ¶
type AddHandler ¶
type AddHandler Handler
AddHandler is the handler for namespace adds.
func NewAddHandler ¶
func NewAddHandler( client clusterclient.Client, instrumentOpts instrument.Options, ) *AddHandler
NewAddHandler returns a new instance of AddHandler.
func (*AddHandler) Add ¶
func (h *AddHandler) Add( addReq *admin.NamespaceAddRequest, opts handler.ServiceOptions, ) (nsproto.Registry, error)
Add adds a namespace.
func (*AddHandler) ServeHTTP ¶
func (h *AddHandler) ServeHTTP( svc handler.ServiceNameAndDefaults, w http.ResponseWriter, r *http.Request, )
type DeleteHandler ¶
type DeleteHandler Handler
DeleteHandler is the handler for namespace deletes.
func NewDeleteHandler ¶
func NewDeleteHandler( client clusterclient.Client, instrumentOpts instrument.Options, ) *DeleteHandler
NewDeleteHandler returns a new instance of DeleteHandler.
func (*DeleteHandler) Delete ¶
func (h *DeleteHandler) Delete(id string) error
Delete deletes a namespace.
func (*DeleteHandler) ServeHTTP ¶
func (h *DeleteHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
type GetHandler ¶
type GetHandler Handler
GetHandler is the handler for namespace gets.
func NewGetHandler ¶
func NewGetHandler( client clusterclient.Client, instrumentOpts instrument.Options, ) *GetHandler
NewGetHandler returns a new instance of GetHandler.
func (*GetHandler) Get ¶
func (h *GetHandler) Get() (nsproto.Registry, error)
Get gets the namespaces.
func (*GetHandler) ServeHTTP ¶
func (h *GetHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)
type Handler ¶
type Handler struct {
// contains filtered or unexported fields
}
Handler represents a generic handler for namespace endpoints.
type SchemaHandler ¶ added in v0.9.5
type SchemaHandler Handler
SchemaHandler is the handler for namespace schema upserts.
func NewSchemaHandler ¶ added in v0.9.5
func NewSchemaHandler( client clusterclient.Client, instrumentOpts instrument.Options, ) *SchemaHandler
NewSchemaHandler returns a new instance of SchemaHandler.
func (*SchemaHandler) Add ¶ added in v0.9.5
func (h *SchemaHandler) Add( addReq *admin.NamespaceSchemaAddRequest, opts handler.ServiceOptions, ) (admin.NamespaceSchemaAddResponse, error)
Add adds schema to an existing namespace.
func (*SchemaHandler) ServeHTTP ¶ added in v0.9.5
func (h *SchemaHandler) ServeHTTP( svc handler.ServiceNameAndDefaults, w http.ResponseWriter, r *http.Request, )
type SchemaResetHandler ¶ added in v0.9.6
type SchemaResetHandler Handler
SchemaResetHandler is the handler for namespace schema reset.
func NewSchemaResetHandler ¶ added in v0.9.6
func NewSchemaResetHandler( client clusterclient.Client, instrumentOpts instrument.Options, ) *SchemaResetHandler
NewSchemaResetHandler returns a new instance of SchemaHandler.
func (*SchemaResetHandler) Reset ¶ added in v0.9.6
func (h *SchemaResetHandler) Reset( addReq *admin.NamespaceSchemaResetRequest, opts handler.ServiceOptions, ) (*admin.NamespaceSchemaResetResponse, error)
Reset resets schema for an existing namespace.
func (*SchemaResetHandler) ServeHTTP ¶ added in v0.9.6
func (h *SchemaResetHandler) ServeHTTP( svc handler.ServiceNameAndDefaults, w http.ResponseWriter, r *http.Request, )
Source Files
Click to show internal directories.
Click to hide internal directories.