clickhouse

Documentation

Index

• Constants
• type Action
  • func (q *Action) IsSafeMode() bool
  • func (q *Action) SetRawQueryAndContext(rawTemplate map[string]interface{}) error
• type Connector
  • func (c *Connector) GetMetaInfo(resourceOptions map[string]interface{}) (common.MetaInfoResult, error)
  • func (c *Connector) Run(resourceOptions map[string]interface{}, actionOptions map[string]interface{}, ...) (common.RuntimeResult, error)
  • func (c *Connector) TestConnection(resourceOptions map[string]interface{}) (common.ConnectionResult, error)
  • func (c *Connector) ValidateActionTemplate(actionOptions map[string]interface{}) (common.ValidateResult, error)
  • func (c *Connector) ValidateResourceOptions(resourceOptions map[string]interface{}) (common.ValidateResult, error)
• type Resource
• type SSLOptions

Constants

const (
	FIELD_CONTEXT = "context"
	FIELD_QUERY   = "query"
)

Types

type Action

type Action struct {
	Query    string
	Mode     string `validate:"required,oneof=gui sql sql-safe"`
	RawQuery string
	Context  map[string]interface{}
}

func (*Action) IsSafeMode

func (q *Action) IsSafeMode() bool

func (*Action) SetRawQueryAndContext

func (q *Action) SetRawQueryAndContext(rawTemplate map[string]interface{}) error

type Connector

type Connector struct {
	ResourceOpts Resource
	ActionOpts   Action
}

func (*Connector) GetMetaInfo

func (c *Connector) GetMetaInfo(resourceOptions map[string]interface{}) (common.MetaInfoResult, error)

func (*Connector) Run

func (c *Connector) Run(resourceOptions map[string]interface{}, actionOptions map[string]interface{}, rawActionOptions map[string]interface{}) (common.RuntimeResult, error)

func (*Connector) TestConnection

func (c *Connector) TestConnection(resourceOptions map[string]interface{}) (common.ConnectionResult, error)

func (*Connector) ValidateActionTemplate

func (c *Connector) ValidateActionTemplate(actionOptions map[string]interface{}) (common.ValidateResult, error)

func (*Connector) ValidateResourceOptions

func (c *Connector) ValidateResourceOptions(resourceOptions map[string]interface{}) (common.ValidateResult, error)

type Resource

type Resource struct {
	Host         string `validate:"required"`
	Port         int    `validate:"gt=0"`
	DatabaseName string `validate:"required"`
	Username     string
	Password     string
	SSL          SSLOptions
}

type SSLOptions

type SSLOptions struct {
	SSL        bool
	SelfSigned bool
	CACert     string `validate:"required_unless=SelfSigned false"`
	PrivateKey string
	ClientCert string
}