Skip to main content

Global Flags

Global flags specify runtime program behavior for the StackQL application, these flags are set at the command line when the StackQL application is launched (in either the interactive/shell mode or non-interactive exec mode) or are sourced from the StackQL initialization (.stackqlrc) file. Flags include:

FlagData TypeDescriptionDefault
--acidstringJSON / YAML string representing ACID config{}
--apirequesttimeoutintegerAPI request timeout in seconds, 0 for no timeout45
--approotstringApplication config and cache root path{cwd}/.stackql
--approotfilemodeuint32Application config and cache file mode493
--authstringauth context keyvals in json form
--cachekeycountintegerCache initial key count100
--configfilestringConfig file full path{cwd}/.stackqlrc
--cpuprofilestringcpuprofile file, none if emptynull
--dataflow.dependency.maxintMaximum dataflow dependency depth for a given query50
--dataflow.components.maxintMaximum dataflow weakly connected components for a given query50
--dbInternalstringJSON / YAML string to configure DBMS housekeeping query handling{}
-d, --delimiterstringDelimiter for csv output. Single char only.  Ignored for all non-csv output,
--dryrunflagdryrun flag; run preprocessor only, templated output will be returnedfalse
--execution.concurrency.limitintConcurrency limit for query execution1
--export.aliasstringExport alias prefix (namespace or schema)
--gcstringJSON / YAML string representing GC config{}
-H, --hideheadersflagDisables column headers, valid only with --output csv or --output textfalse
--http.log.enabledflagDisplay http request info in terminalfalse
--http.proxy.hoststringProxy host (leave blank for no proxy)null
--http.proxy.passwordstringProxy passwordnull
--http.proxy.portintegerProxy port, any number <=0 will result in the default port for a given scheme (e.g. http -> 80)-1
--http.proxy.schemestringProxy scheme, {http or https}http
--http.proxy.userstringProxy usernull
--http.response.maxResultsintegerMaximum results per http request, any number <=0 results in no limitation-1
--http.response.pageLimitintegerMaximum pages of results that will be returned per resource, any number <=0 results in no limitation20
--indirect.depth.maxintegerMaximum depth for indirect queries: views and subqueries5
-i, --infilestringInput file (IQL file) from which queries are read{stdin}
-q, --iqldatastringContext (data) file for templating (json or jsonnet file)
--loglevelstringLog level, must be one of {infowarndebug, fatal}fatal
--metadatattlintegerTTL for cached metadata documents, in seconds3600
--namespacesstringJSON / YAML string representing namespaces for caching, views etc{}
--offlineflagWork offline, using cached datafalse
-f, --outfilestringOutput file into which results are written{stdout}
-o, --outputstringOutput format, must be one of {jsontablecsv, text}table
--querycachesizeintegerSize in number of entries of LRU cache for query plans10000
--registrystringopenapi registry context keyvals in json form
--sessionstringJSON / YAML string representing session config{}
--sqlBackendstringJSON / YAML string representing SQL Backend System Config{}
--store.txnstringJSON / YAML string representing Txn store config{}
--tls.CABundlestringPath to CA bundle, if not specified then system defaults used
--tls.allowInsecureflagAllow trust of insecure certificates (not recommended)
--varstringExternal variables provided as key/value pairs for sourcing into StackQL queries through jsonnet data files
-v, --verboseflagVerbose outputfalse
-h, --helpContext specific help for stackql
--versionDisplays the version of the StackQL program