db_utils

Documentation

Index

• Constants
• func AbsoluteDateStringQuery(absolute string) (string, error)
• func CheckAbsoluteRegex(regex string, value string) bool
• func ParseAbsoluteQuery(absoluteQuery string, location *time.Location) (startDate, endDate time.Time, err error)
• func PullAbsoluteValue(value string) int64
• func ValidateDateFilters(params any, dateFiltersToValidate ...string) error
• type CorruptIndex
• type Index
• type IndexError
• type IndexHealthIssues
• type LowIndexScanTable
• type PageAndOrderParams
• type PageParams
  • func (params *PageParams) EnforceLimit()
  • func (params *PageParams) Validate() error
• type ProblemIndex
  • func FindCommonNeverUsedIndexes(list1, list2 []ProblemIndex) []ProblemIndex

Constants

const (
	TableIndexScanPercentageCheckHealthy    = "healthy"
	TableIndexScanPercentageCheckProblem    = "problem"
	TableIndexScanPercentageCheckEmptyTable = "empty_table"
)

const (
	IndexProblemReasonNeverUsedIndex              = "Never-used index"
	IndexProblemReasonLowScanHighWrite            = "Low scan, high write"
	IndexProblemReasonSeldomUsedLargeIndex        = "Seldom-used large index"
	IndexProblemReasonHighWriteLargeNonBTreeIndex = "High write, large non-BTree index"
)

const (
	LastXHours string = "^last \\d+ hour(s)?$"
	LastDay    string = "^last day$"
	LastXDays  string = "^last \\d+ day(s)?$"
	LastMonth  string = "^last month$"
	Yesterday  string = "^yesterday$"
)

Special query cases

const CorruptIndexQuery = `` /* 772-byte string literal not displayed */

const ExistingIndexQuery = `` /* 569-byte string literal not displayed */

const ProblemIndexQuery = `` /* 3289-byte string literal not displayed */

const TableIndexStatusQuery = `` /* 576-byte string literal not displayed */

Functions

func AbsoluteDateStringQuery

func AbsoluteDateStringQuery(absolute string) (string, error)

func CheckAbsoluteRegex

func CheckAbsoluteRegex(regex string, value string) bool

func ParseAbsoluteQuery

func ParseAbsoluteQuery(absoluteQuery string, location *time.Location) (startDate, endDate time.Time, err error)

func PullAbsoluteValue

func PullAbsoluteValue(value string) int64

func ValidateDateFilters

func ValidateDateFilters(params any, dateFiltersToValidate ...string) error

Types

type CorruptIndex

type CorruptIndex struct {
	CheckResult  string `json:"check_result"` // If there are no errors, this should be empty.
	RelationName string `json:"relation_name"`
	RelationSize int64  `json:"relation_size"` // This size in measured in pages.
}

type Index

type Index struct {
	IndexName string `json:"index_name"`
	TableName string `json:"table_name"`
}

type IndexError

type IndexError struct {
	TableName string `json:"table_name"`
	IndexName string `json:"index_name"`
	Reason    string `json:"reason"`
}

type IndexHealthIssues

type IndexHealthIssues struct {
	CorruptIndexes     []CorruptIndex      `json:"corrupt_indexes"`
	LowIndexScanTables []LowIndexScanTable `json:"low_index_scan_tables"`
	ProblemIndexes     []ProblemIndex      `json:"problem_indexes"`
}

type LowIndexScanTable

type LowIndexScanTable struct {
	TableName    string `json:"table_name"`
	Status       string `json:"index_name"`
	PercentUsage int64  `json:"percent_usage"`
	RowsInTable  int64  `json:"rows_in_table"`
}

type PageAndOrderParams

type PageAndOrderParams struct {
	PageParams
	OrderBy string `json:"order_by,omitempty"`
	Order   string `json:"order,omitempty"`
}

type PageParams

type PageParams struct {
	Limit  int64 `json:"limit,omitempty"`  // Limit number of items returned in list (default: 0 (no limit))
	Offset int64 `json:"offset,omitempty"` // Offset in list (default: 0 (no offset))
}

func (*PageParams) EnforceLimit

func (params *PageParams) EnforceLimit()

func (*PageParams) Validate

func (params *PageParams) Validate() error

type ProblemIndex

type ProblemIndex struct {
	TableName           string  `json:"table_name"`
	IndexName           string  `json:"index_name"`
	Reason              string  `json:"reason"`
	IndexScanPercentage float64 `json:"index_scan_percentage"`
	IndexSize           string  `json:"index_size"`
	TableSize           string  `json:"table_size"`
}

func FindCommonNeverUsedIndexes

func FindCommonNeverUsedIndexes(list1, list2 []ProblemIndex) []ProblemIndex