args

Documentation

Overview

Package args contains the argument list, defined as a struct, along with a method that validates passed-in args

Index

• type ArgumentList
  • func (al ArgumentList) Validate() error

Types

type ArgumentList

type ArgumentList struct {
	sdkArgs.DefaultArgumentList
	Username                     string `default:"" help:"The Microsoft SQL Server connection user name"`
	Password                     string `default:"" help:"The Microsoft SQL Server connection password"`
	Instance                     string `default:"" help:"The Microsoft SQL Server instance to connect to"`
	Hostname                     string `default:"127.0.0.1" help:"The Microsoft SQL Server connection host name"`
	Port                         string `default:"" help:"The Microsoft SQL Server port to connect to. Only needed when instance not specified"`
	EnableSSL                    bool   `default:"false" help:"If true will use SSL encryption, false will not use encryption"`
	TrustServerCertificate       bool   `` /* 141-byte string literal not displayed */
	CertificateLocation          string `default:"" help:"Certificate file to verify SSL encryption against"`
	EnableBufferMetrics          bool   `default:"true" help:"Enable collection of buffer space metrics."`
	EnableDatabaseReserveMetrics bool   `default:"true" help:"Enable collection of database reserve space metrics."`
	Timeout                      string `default:"30" help:"Timeout in seconds for a single SQL Query. Set 0 for no timeout"`
	CustomMetricsQuery           string `` /* 141-byte string literal not displayed */
	CustomMetricsConfig          string `default:"" help:"YAML configuration with one or more SQL queries to collect custom metrics"`
	ShowVersion                  bool   `default:"false" help:"Print build information and exit"`
	ExtraConnectionURLArgs       string `default:"" help:"Appends additional parameters to connection url. Ex. 'applicationintent=readonly&foo=bar'"`
}

ArgumentList struct that holds all MSSQL arguments

func (ArgumentList) Validate

func (al ArgumentList) Validate() error

Validate validates SQL specific arguments