option

Documentation

Index

• Constants
• type CaseSensitiveOption
  • func (option CaseSensitiveOption) CaseSensitive() bool
  • func (option CaseSensitiveOption) OptionType() string
• type FieldsOption
  • func (option FieldsOption) Fields() []string
  • func (option FieldsOption) OptionType() string
• type FirstRowOption
  • func (option FirstRowOption) OptionType() string
• type MaxRowsOption
  • func (option MaxRowsOption) MaxRows() int64
  • func (option MaxRowsOption) OptionType() string
• type Option
  • func CaseSensitive(caseSensitive bool) 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 SortOption
  • func (sortConfig SortOption) 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 TypeCaseSensitive = "CASESENSITIVE"

TypeCaseSensitive is the token that designates case sensitivity of search results

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 CaseSensitiveOption

type CaseSensitiveOption bool

CaseSensitiveOption is a query option that designates case sensitivity of search results.

func (CaseSensitiveOption) CaseSensitive

func (option CaseSensitiveOption) CaseSensitive() bool

CaseSensitive returns TRUE if the results should consider letter case

func (CaseSensitiveOption) OptionType

func (option CaseSensitiveOption) OptionType() string

OptionType identifies this object as a query option

type FieldsOption

type FieldsOption []string

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

func (FieldsOption) Fields

func (option FieldsOption) Fields() []string

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

func (FieldsOption) OptionType

func (option FieldsOption) OptionType() string

OptionType identifies this object as a query option

type FirstRowOption

type FirstRowOption struct{}

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

func (FirstRowOption) OptionType

func (option FirstRowOption) OptionType() string

OptionType identifies this object as a query option

type MaxRowsOption

type MaxRowsOption int64

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

func (MaxRowsOption) MaxRows

func (option MaxRowsOption) MaxRows() int64

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

func (MaxRowsOption) OptionType

func (option MaxRowsOption) OptionType() string

OptionType identifies this object 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 CaseSensitive

func CaseSensitive(caseSensitive bool) Option

CaseSensitive returns a query option that will designate the case sensitivity of search results

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 SortOption

type SortOption struct {
	FieldName string
	Direction string
}

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

func (SortOption) OptionType

func (sortConfig SortOption) OptionType() string

OptionType identifies this object as a query option