query

Documentation

Index

• Constants
• type AuthenticatorService
• type BaseService
  • func NewBaseService() *BaseService
  • func (service *BaseService) Authenticators() []auth.Authenticator
  • func (service *BaseService) Coordinator() coordinator.Coordinator
  • func (service *BaseService) OnMessageReceived(msg coordinator.Message)
  • func (service *BaseService) PostCollectionCreateMessage(database string, collection string) error
  • func (service *BaseService) PostCollectionDropMessage(database string, collection string) error
  • func (service *BaseService) PostCollectionUpdateMessage(database string, collection string) error
  • func (service *BaseService) PostDatabaseCreateMessage(database string) error
  • func (service *BaseService) PostDatabaseDropMessage(database string) error
  • func (service *BaseService) PostDatabaseUpdateMessage(database string) error
  • func (service *BaseService) ServiceType() plugins.ServiceType
  • func (service *BaseService) SetAuthManager(mgr auth.AuthManager)
  • func (service *BaseService) SetCoordinator(coordinator coordinator.Coordinator)
  • func (service *BaseService) SetStore(store store.Store)
  • func (service *BaseService) SetTLSConfig(tlsConfig *tls.Config)
  • func (service *BaseService) Store() store.Store
  • func (service *BaseService) TLSConfig() (*tls.Config, bool)
• type CollectionMessageObject
• type CoordinatorService
• type DatabaseMessageObject
• type Service
• type StoreService

Constants

const (
	ConfigTLS = "tls"
)

Types

type AuthenticatorService

type AuthenticatorService interface {
	// SetAuthManager sets the auth manager.
	SetAuthManager(mgr auth.AuthManager)
	// Authenticators returns all authenticators.
	Authenticators() []auth.Authenticator
}

AuthenticatorService represents an authenticator interface for query service.

type BaseService

type BaseService struct {
	plugins.Config

	auth.AuthManager
	// contains filtered or unexported fields
}

BaseService represent a query base service.

func NewBaseService

func NewBaseService() *BaseService

NewBaseService returns a new query base service.

func (*BaseService) Authenticators

func (service *BaseService) Authenticators() []auth.Authenticator

Authenticators returns all authenticators.

func (*BaseService) Coordinator

func (service *BaseService) Coordinator() coordinator.Coordinator

Coordinator returns the coordinator.

func (*BaseService) OnMessageReceived

func (service *BaseService) OnMessageReceived(msg coordinator.Message)

OnMessageReceived is called when a message is received from the coordinator.

func (*BaseService) PostCollectionCreateMessage

func (service *BaseService) PostCollectionCreateMessage(database string, collection string) error

PostCollectionCreateMessage posts a create collection message to the coordinator.

func (*BaseService) PostCollectionDropMessage

func (service *BaseService) PostCollectionDropMessage(database string, collection string) error

PostCollectionDropMessage posts a drop collection message to the coordinator.

func (*BaseService) PostCollectionUpdateMessage

func (service *BaseService) PostCollectionUpdateMessage(database string, collection string) error

PostCollectionDeleteMessage posts a update collection message to the coordinator.

func (*BaseService) PostDatabaseCreateMessage

func (service *BaseService) PostDatabaseCreateMessage(database string) error

PostDatabaseCreateMessage posts a create database message to the coordinator.

func (*BaseService) PostDatabaseDropMessage

func (service *BaseService) PostDatabaseDropMessage(database string) error

PostDatabaseDropMessage posts a drop database message to the coordinator.

func (*BaseService) PostDatabaseUpdateMessage

func (service *BaseService) PostDatabaseUpdateMessage(database string) error

PostDatabaseDeleteMessage posts a update database message to the coordinator.

func (*BaseService) ServiceType

func (service *BaseService) ServiceType() plugins.ServiceType

ServiceType returns the plug-in service type.

func (*BaseService) SetAuthManager

func (service *BaseService) SetAuthManager(mgr auth.AuthManager)

SetAuthManager sets the auth manager.

func (*BaseService) SetCoordinator

func (service *BaseService) SetCoordinator(coordinator coordinator.Coordinator)

SetCoordinator sets the coordinator.

func (*BaseService) SetStore

func (service *BaseService) SetStore(store store.Store)

SetStore sets the store.

func (*BaseService) SetTLSConfig

func (service *BaseService) SetTLSConfig(tlsConfig *tls.Config)

SetTLSConfig sets the TLS configuration.

func (*BaseService) Store

func (service *BaseService) Store() store.Store

Store returns the store.

func (*BaseService) TLSConfig

func (service *BaseService) TLSConfig() (*tls.Config, bool)

TLSConfig returns the TLS configuration.

type CollectionMessageObject

type CollectionMessageObject struct {
	Database   string
	Collection string
}

type CoordinatorService

type CoordinatorService interface {
	// SetCoordinator sets the coordinator.
	SetCoordinator(coordinator coordinator.Coordinator)
	// Coordinator returns the coordinator.
	Coordinator() coordinator.Coordinator
	// Observer is an interface to receive a message from the coordinator.
	coordinator.Observer
	// PostDatabaseCreateMessage posts a create database message to the coordinator.
	PostDatabaseCreateMessage(database string) error
	// PostDatabaseDeleteMessage posts a update database message to the coordinator.
	PostDatabaseUpdateMessage(database string) error
	// PostDatabaseDropMessage posts a drop database message to the coordinator.
	PostDatabaseDropMessage(database string) error
	// PostCollectionCreateMessage posts a create collection message to the coordinator.
	PostCollectionCreateMessage(database string, collection string) error
	// PostCollectionDeleteMessage posts a update collection message to the coordinator.
	PostCollectionUpdateMessage(database string, collection string) error
	// PostCollectionDropMessage posts a drop collection message to the coordinator.
	PostCollectionDropMessage(database string, collection string) error
}

CoordinatorService represents a coordinator interface for query service.

type DatabaseMessageObject

type DatabaseMessageObject struct {
	Database string
}

type Service

type Service interface {
	plugins.Service
	CoordinatorService
	StoreService
	AuthenticatorService
	// SetTracer sets the tracing tracer.
	SetTracer(t tracer.Tracer)
	// SetPort sets the listen port.
	SetPort(port int)
	// SetTLSConfig sets the TLS configuration.
	SetTLSConfig(tlsConfig *tls.Config)
}

Service represents a query service.

type StoreService

type StoreService interface {
	// SetStore sets the store.
	SetStore(store store.Store)
	// Store returns the store.
	Store() store.Store
}

StoreService represents a store interface for query service.