option

Documentation

Index

• Constants
• type FieldsConfig
  • func (fieldsConfig FieldsConfig) Fields() []string
  • func (fieldsConfig FieldsConfig) OptionType() string
• type FirstRowConfig
  • func (firstRowConfig FirstRowConfig) OptionType() string
• type MaxRowsConfig
  • func (maxRowsConfig MaxRowsConfig) MaxRows() int64
  • func (maxRowsConfig MaxRowsConfig) OptionType() string
• type Option
  • func Fields(fields ...string) Option
  • func FirstRow() 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 TypeFields = "FIELDS"

TypeFields is the token that designates the fields to be returned

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 FieldsConfig

type FieldsConfig []string

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

func (FieldsConfig) Fields

func (fieldsConfig FieldsConfig) Fields() []string

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

func (FieldsConfig) OptionType

func (fieldsConfig FieldsConfig) OptionType() string

OptionType identifies this record as a query option

type FirstRowConfig

type FirstRowConfig struct{}

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

func (FirstRowConfig) OptionType

func (firstRowConfig FirstRowConfig) OptionType() string

OptionType identifies this record as a query option

type MaxRowsConfig

type MaxRowsConfig int64

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

func (MaxRowsConfig) MaxRows

func (maxRowsConfig MaxRowsConfig) MaxRows() int64

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 Fields

func Fields(fields ...string) Option

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

func FirstRow

func FirstRow() 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