Environment

Documentation

data Environment

The Environment contains the command name, operands, defaults, and the result of every option amongst other entries. It is set by main and otherwise to be used as a read-only Environment.

Constructors

Env

Fields

• command :: String

  Program name

• pwd :: String

  Present Working Directory (PWD)

• home :: String

  Home directory or /tmp

• history :: String

  History file for command

• protocol :: String

  Protoocl http or https

• certStore :: String

  Load and use certificate store

• insecure :: Bool

  Use "insecure" SSL/TLS, i.e., no cert validation

• scidbAuth :: Bool

  Use SciDB authentication

• digestAuth :: Bool

  Use basic digest access authentication

• digestHeaders :: RequestHeaders

  Digest request headers or nothing for the GET method

• defFetch :: Maybe Bool

  True fetch lines, false do not fetch lines

• defFormat :: String

  Format dcsv, csv, csv+, etc.

• defNumber :: String

  Number of lines to fetch, n=0 for all; default for bad number

• defReadingLines :: Maybe Bool

  True to read lines from shim otheriwise read bytes

• defPrefix :: String

  Prefix to execute before a query by shim

• host :: String

  Hostname or IP address

• port :: Maybe String

  Port number

• defPort :: String

  Default insecure or unencypted port number

• secPort :: String

  Default secure or encypted port number

• username :: String

  Username

• password :: String

  Password for username

• operands :: [String]

  List of queries

• file :: String

  File of queries

• help :: Bool

  -h, display help summary

• license :: Bool

  -l, display license terms

• manual :: Bool

  -m, display internal man page

• version :: Bool

  -v, display version

• synopsis :: Bool

  -y, display manual synopsis

• verbose :: Verbosity

  -V|-V[012], display verbose information to stderr

• sciDbVersion :: String

  Store SciDB version, e.g., 18.1.0

• versionSciDb :: Bool

  True to display SciDB version via shim

Instances

Show Environment

Defined in Environment

Methods

showsPrec :: Int -> Environment -> ShowS

show :: Environment -> String

showList :: [Environment] -> ShowS

defaultEnv :: Environment

The defualt values, otherwise updated from the flags supplied by the command line options. The default program name is hquery.

maybePort :: Environment -> String

Given an Environment, return a port or a default port.

data Verbosity

Constructors

Verbose0

Verbosity level 0, no information to stderr

VerboseDef

Default verbosity, only relevant HTTP exceptions to stderr

Verbose1

Verbosity level 1, additional HTTP exceptions and trace information to stderr

Verbose2

Verbosity level 2, additional URL information to stderr

Instances

Eq Verbosity

Defined in Environment

Methods

(==) :: Verbosity -> Verbosity -> Bool

(/=) :: Verbosity -> Verbosity -> Bool

Ord Verbosity

Defined in Environment

Methods

compare :: Verbosity -> Verbosity -> Ordering

(<) :: Verbosity -> Verbosity -> Bool

(<=) :: Verbosity -> Verbosity -> Bool

(>) :: Verbosity -> Verbosity -> Bool

(>=) :: Verbosity -> Verbosity -> Bool

max :: Verbosity -> Verbosity -> Verbosity

min :: Verbosity -> Verbosity -> Verbosity

Show Verbosity

Defined in Environment

Methods

showsPrec :: Int -> Verbosity -> ShowS

show :: Verbosity -> String

showList :: [Verbosity] -> ShowS