treewindow

Documentation

Overview

Package treewindow contains some constants describing window-function specific options.

Index

• func WindowModeName(mode WindowFrameMode) string
• type WindowFrameBoundType
  • func (ft WindowFrameBoundType) IsOffset() bool
  • func (ft WindowFrameBoundType) Name() string
  • func (ft WindowFrameBoundType) String() string
• type WindowFrameExclusion
  • func (node WindowFrameExclusion) Name() string
  • func (node WindowFrameExclusion) String() string
• type WindowFrameMode
  • func (m WindowFrameMode) Name() string
  • func (m WindowFrameMode) String() string

Functions

func WindowModeName

func WindowModeName(mode WindowFrameMode) string

WindowModeName returns the name of the window frame mode.

Types

type WindowFrameBoundType

type WindowFrameBoundType int

WindowFrameBoundType indicates which type of boundary is used.

const (
	// UnboundedPreceding represents UNBOUNDED PRECEDING type of boundary.
	UnboundedPreceding WindowFrameBoundType = iota
	// OffsetPreceding represents 'value' PRECEDING type of boundary.
	OffsetPreceding
	// CurrentRow represents CURRENT ROW type of boundary.
	CurrentRow
	// OffsetFollowing represents 'value' FOLLOWING type of boundary.
	OffsetFollowing
	// UnboundedFollowing represents UNBOUNDED FOLLOWING type of boundary.
	UnboundedFollowing
)

func (WindowFrameBoundType) IsOffset

func (ft WindowFrameBoundType) IsOffset() bool

IsOffset returns true if the WindowFrameBoundType is an offset.

func (WindowFrameBoundType) Name

func (ft WindowFrameBoundType) Name() string

Name returns a string representation of the bound type to be used in struct names for generated code.

func (WindowFrameBoundType) String

func (ft WindowFrameBoundType) String() string

type WindowFrameExclusion

type WindowFrameExclusion int

WindowFrameExclusion indicates which mode of exclusion is used.

const (
	// NoExclusion represents an omitted frame exclusion clause.
	NoExclusion WindowFrameExclusion = iota
	// ExcludeCurrentRow represents EXCLUDE CURRENT ROW mode of frame exclusion.
	ExcludeCurrentRow
	// ExcludeGroup represents EXCLUDE GROUP mode of frame exclusion.
	ExcludeGroup
	// ExcludeTies represents EXCLUDE TIES mode of frame exclusion.
	ExcludeTies
)

func (WindowFrameExclusion) Name

func (node WindowFrameExclusion) Name() string

Name returns a string representation of the exclusion type to be used in struct names for generated code.

func (WindowFrameExclusion) String

func (node WindowFrameExclusion) String() string

type WindowFrameMode

type WindowFrameMode int

WindowFrameMode indicates which mode of framing is used.

const (
	// RANGE is the mode of specifying frame in terms of logical range (e.g. 100 units cheaper).
	RANGE WindowFrameMode = iota
	// ROWS is the mode of specifying frame in terms of physical offsets (e.g. 1 row before etc).
	ROWS
	// GROUPS is the mode of specifying frame in terms of peer groups.
	GROUPS
)

func (WindowFrameMode) Name

func (m WindowFrameMode) Name() string

Name returns a string representation of the window frame mode to be used in struct names for generated code.

func (WindowFrameMode) String

func (m WindowFrameMode) String() string