filecustomrule

Documentation

Overview

Package filecustomrule implements static custom rule from a config file

Index

• Constants
• func ActivateFileCustomRules(qsc tabletserver.Controller)
• func ParseRules(path string) (*rules.Rules, error)
• type FileCustomRule
  • func NewFileCustomRule() (fcr *FileCustomRule)
  • func (fcr *FileCustomRule) GetRules() (qrs *rules.Rules, version int64, err error)
  • func (fcr *FileCustomRule) Open(qsc tabletserver.Controller, rulePath string) error

Constants

const FileCustomRuleSource string = "FILE_CUSTOM_RULE"

FileCustomRuleSource is the name of the file based custom rule source

Functions

func ActivateFileCustomRules

func ActivateFileCustomRules(qsc tabletserver.Controller)

ActivateFileCustomRules activates this static file based custom rule mechanism

func ParseRules

func ParseRules(path string) (*rules.Rules, error)

ParseRules will construct a Rules object based on a file path. In the case of error it returns nil and that error. A log will be printed to capture the stage at which parsing failed.

Types

type FileCustomRule

type FileCustomRule struct {
	// contains filtered or unexported fields
}

FileCustomRule is an implementation of CustomRuleManager, it reads custom query rules from local file for once and push it to vttablet

func NewFileCustomRule

func NewFileCustomRule() (fcr *FileCustomRule)

NewFileCustomRule returns pointer to new FileCustomRule structure

func (*FileCustomRule) GetRules

func (fcr *FileCustomRule) GetRules() (qrs *rules.Rules, version int64, err error)

GetRules returns query rules built from local file

func (*FileCustomRule) Open

func (fcr *FileCustomRule) Open(qsc tabletserver.Controller, rulePath string) error

Open try to build query rules from local file and push the rules to vttablet