Documentation ¶
Overview ¶
Package flag holds CLI flags. Note that many CLI flags are defined via the options package, and are not listed here.
Index ¶
Constants ¶
View Source
const ( ActiveSrc = "src" ActiveSrcUsage = "Override active source for this query" ActiveSchema = "src.schema" ActiveSchemaUsage = "Override active schema (and/or catalog) for this query" ConfigSrc = "src" ConfigSrcUsage = "Config for source" CSV = "csv" CSVShort = "C" CSVUsage = "Output CSV" AddDriver = "driver" AddDriverShort = "d" AddDriverUsage = "Explicitly specify driver to use" IngestDriver = "ingest.driver" IngestDriverUsage = "Explicitly specify driver to use for ingesting data" HTML = "html" HTMLUsage = "Output HTML table" Header = "header" HeaderShort = "h" HeaderUsage = "Print header row" NoHeader = "no-header" NoHeaderShort = "H" NoHeaderUsage = "Don't print header row" Handle = "handle" HandleShort = "n" HandleUsage = "Handle for the source" ListGroup = "group" ListGroupShort = "g" ListGroupUsage = "List groups instead of sources" Help = "help" Insert = "insert" InsertUsage = "Insert query results into @HANDLE.TABLE; if not existing, TABLE will be created" JSON = "json" JSONShort = "j" JSONUsage = "Output JSON" JSONA = "jsona" JSONAShort = "A" JSONAUsage = "Output LF-delimited JSON arrays" JSONL = "jsonl" JSONLShort = "J" JSONLUsage = "Output LF-delimited JSON objects" Markdown = "markdown" MarkdownUsage = "Output Markdown" AddActive = "active" AddActiveShort = "a" AddActiveUsage = "Make this the active source" FileOutput = "output" FileOutputShort = "o" FileOutputUsage = "Write output to <file> instead of stdout" // Input sets Run.Stdin to the named file. At this time, this is used // mainly for debugging, so it's marked hidden by the CLI. I'm not // sure if this will ever be generally useful. Also, there's been no // testing done to see how this flag would interact with, say, // flag.PasswordPrompt, which also reads from stdin. Input = "input" InputShort = "i" InputUsage = "Read input from <file> instead of stdin" InspectOverview = "overview" InspectOverviewShort = "O" InspectOverviewUsage = "Show metadata only (no schema)" PasswordPrompt = "password" PasswordPromptShort = "p" PasswordPromptUsage = "Read password from stdin or prompt" CacheTreeSize = "size" CacheTreeSizeShort = "s" CacheTreeSizeUsage = "Show sizes in cache tree" Raw = "raw" RawShort = "r" RawUsage = "Output each record field in raw format without any encoding or delimiter" SQLExec = "exec" SQLExecUsage = "Execute the SQL as a statement (as opposed to query)" SQLQuery = "query" SQLQueryUsage = "Execute the SQL as a query (as opposed to statement)" TSV = "tsv" TSVUsage = "Output TSV" Text = "text" TextShort = "t" TextUsage = "Output text" TblData = "data" TblDataUsage = "Copy table data" Version = "version" VersionUsage = "Print version info" XLSX = "xlsx" XLSXShort = "x" XLSXUsage = "Output Excel XLSX" YAML = "yaml" YAMLShort = "y" YAMLUsage = "Output YAML" XML = "xml" XMLUsage = "Output XML" SkipVerify = "skip-verify" SkipVerifyUsage = "Don't ping source before adding it" Arg = "arg" ArgUsage = "Set a string value to a variable" Config = "config" ConfigUsage = "Load config from here" ConfigDelete = "delete" ConfigDeleteShort = "D" ConfigDeleteUsage = "Reset this option to default value" InspectDBProps = "dbprops" InspectDBPropsShort = "p" InspectDBPropsUsage = "Show DB properties only" InspectCatalogs = "catalogs" InspectCatalogsShort = "C" InspectCatalogsUsage = "List catalogs only" InspectSchemata = "schemata" InspectSchemataShort = "S" InspectSchemataUsage = "List schemas (in current catalog) only" DiffOverview = "overview" DiffOverviewShort = "O" DiffOverviewUsage = "Compare source overview" DiffSchema = "schema" DiffSchemaShort = "S" DiffSchemaUsage = "Compare schema structure" DiffDBProps = "dbprops" DiffDBPropsShort = "B" DiffDBPropsUsage = "Compare DB properties" DiffRowCount = "counts" DiffRowCountShort = "N" DiffRowCountUsage = "When comparing table schema structure, include row counts" DiffData = "data" DiffDataShort = "d" DiffDataUsage = "Compare values of each data row (caution: may be slow)" DiffAll = "all" DiffAllShort = "a" DiffAllUsage = "Compare everything (caution: may be slow)" DBDumpCatalog = "catalog" DBDumpCatalogUsage = "Dump the named catalog" DBDumpNoOwner = "no-owner" DBDumpNoOwnerUsage = "Don't set ownership or ACL" DBPrintToolCmd = "print" DBPrintToolCmdUsage = "Print the db-native tool command, but don't execute it" DBPrintLongToolCmd = "print-long" DBPrintLongToolCmdUsage = "Print the long-form db-native tool command, but don't execute it" DBRestoreFrom = "from" DBRestoreFromShort = "f" DBRestoreFromUsage = "Restore from dump file; if omitted, read from stdin" DBRestoreNoOwner = "no-owner" DBRestoreNoOwnerUsage = "Don't use ownership or ACL from dump" DBExecFile = "file" DBExecFileShort = "f" DBExecFileUsage = "Read SQL from <file> instead of stdin" DBExecCmd = "command" DBExecCmdShort = "c" DBExecCmdUsage = "Execute SQL command string" )
Variables ¶
View Source
var OutputFormatFlags = []string{ Text, JSON, JSONA, JSONL, CSV, TSV, HTML, Markdown, Raw, XLSX, XML, YAML, }
OutputFormatFlags is the set of flags that control output format.
Functions ¶
This section is empty.
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.