query

Documentation

Index

• Constants
• Variables
• type Field
• type Filter
• type Pagination
  • func (p *Pagination) GetValidPagination(total int) (startIndex, endIndex int)
• type Query
  • func New() *Query
  • func ParseQueryParameter(request *restful.Request) *Query
  • func (q *Query) Selector() labels.Selector
• type Value

Constants

const (
	FieldName                = "name"
	FieldAlias               = "alias"
	FieldNames               = "names"
	FieldUID                 = "uid"
	FieldCreationTimeStamp   = "creationTimestamp"
	FieldCreateTime          = "createTime"
	FieldLastUpdateTimestamp = "lastUpdateTimestamp"
	FieldUpdateTime          = "updateTime"
	FieldLabel               = "label"
	FieldAnnotation          = "annotation"
	FieldNamespace           = "namespace"
	FieldStatus              = "status"
	FieldOwnerReference      = "ownerReference"
	FieldOwnerKind           = "ownerKind"

	FieldType = "type"
)

const (
	ParameterName          = "name"
	ParameterLabelSelector = "labelSelector"
	ParameterFieldSelector = "fieldSelector"
	ParameterPage          = "page"
	ParameterLimit         = "limit"
	ParameterOrderBy       = "sortBy"
	ParameterAscending     = "ascending"
)

Variables

var ComparableFields = []Field{
	FieldName,
	FieldUID,
	FieldLabel,
	FieldAnnotation,
	FieldNamespace,
	FieldStatus,
	FieldOwnerReference,
	FieldOwnerKind,
}

Field contains all the query field that can be compared

var NoPagination = newPagination(-1, 0)

var SortableFields = []Field{
	FieldCreationTimeStamp,
	FieldCreateTime,
	FieldUpdateTime,
	FieldLastUpdateTimestamp,
	FieldName,
}

Types

type Field

type Field string

type Filter

type Filter struct {
	Field Field
	Value Value
}

type Pagination

type Pagination struct {
	// items per page
	Limit int

	// offset
	Offset int
}

func (*Pagination) GetValidPagination

func (p *Pagination) GetValidPagination(total int) (startIndex, endIndex int)

type Query

type Query struct {
	Pagination *Pagination

	// sort result in which field, default to FieldCreationTimeStamp
	SortBy Field

	// sort result in ascending or descending order, default to descending
	Ascending bool

	//
	Filters map[Field]Value

	LabelSelector string
}

Query represents api search terms

func New

func New() *Query

func ParseQueryParameter

func ParseQueryParameter(request *restful.Request) *Query

func (*Query) Selector

func (q *Query) Selector() labels.Selector

type Value

type Value string