option

Documentation

Index

• Constants
• type FirstRowConfig
  • func (firstRowConfig FirstRowConfig) FirstRow() int
  • func (firstRowConfig FirstRowConfig) OptionType() string
• type MaxRowsConfig
  • func (maxRowsConfig MaxRowsConfig) MaxRows() int
  • func (maxRowsConfig MaxRowsConfig) OptionType() string
• type Option
  • func FirstRow(firstRow int64) Option
  • func MaxRows(maxRows int64) Option
  • func SortAsc(fieldName string) Option
  • func SortDesc(fieldName string) Option
• type SortConfig
  • func (sortConfig SortConfig) OptionType() string

Constants

const SortDirectionAscending = "ASC"

SortDirectionAscending is the token that designates that records should be sorted lowest to highest

const SortDirectionDescending = "DESC"

SortDirectionDescending is the token that designates that records should be sorted highest to lowest

const TypeFirstRow = "FIRSTROW"

TypeFirstRow is the token that designates the "row number" to begin results.

const TypeMaxRows = "MAXROWS"

TypeMaxRows is the token that designates the maximum number of records to be returned

const TypeSort = "SORT"

TypeSort is the token that designates a Sort order

Types

type FirstRowConfig

type FirstRowConfig int

FirstRowConfig is a query option that sets the first row to be returned in a dataset

func (FirstRowConfig) FirstRow

func (firstRowConfig FirstRowConfig) FirstRow() int

FirstRow returns the first row of the dataset to return

func (FirstRowConfig) OptionType

func (firstRowConfig FirstRowConfig) OptionType() string

OptionType identifies this record as a query option

type MaxRowsConfig

type MaxRowsConfig int

MaxRowsConfig is a query option that limits the number of rows to be included in a dataset

func (MaxRowsConfig) MaxRows

func (maxRowsConfig MaxRowsConfig) MaxRows() int

MaxRows returns the maximum number of rows to include in a dataset

func (MaxRowsConfig) OptionType

func (maxRowsConfig MaxRowsConfig) OptionType() string

OptionType identifies this record as a query option

type Option

type Option interface {
	OptionType() string
}

Option is an interface that wraps all of the query options that can be used to modify a database query.

func FirstRow

func FirstRow(firstRow int64) Option

FirstRow returns a query option that will limit the query results to a certain number of rows

func MaxRows

func MaxRows(maxRows int64) Option

MaxRows returns a query option that will limit the query results to a certain number of rows

func SortAsc

func SortAsc(fieldName string) Option

SortAsc returns a query option that will sort the query results in ASCENDING order

func SortDesc

func SortDesc(fieldName string) Option

SortDesc returns a query option that will sort the query results in DESCENDING order

type SortConfig

type SortConfig struct {
	FieldName string
	Direction string
}

SortConfig identifies the field and direction to use when sorting a dataset

func (SortConfig) OptionType

func (sortConfig SortConfig) OptionType() string

OptionType identifies this record as a query option