Influxdata
/
influxdb
mirror of https://github.com/influxdata/influxdb.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
influxdb/man/influx.txt

98 lines
2.7 KiB
Plaintext
Raw Normal View History

Initial work creating man pages
2016-07-15 21:43:05 +00:00
influx(1)
=========
NAME
----
influx - InfluxDB client
SYNOPSIS
--------
[verse]
'influx' [options]
'influx' -execute <command> [options]
'influx' -import -path <path> (-compressed) [options]
'influx' -version
DESCRIPTION
-----------
'influx' is the command line program for interacting with an InfluxDB server.
In the first form, the program starts a CLI that can be used to write data or query the database. The command line is described in *COMMAND LINE*.
In the second form, this will execute a single command, usually a query. This is the equivalent of starting the command line, running one command, and then exiting.
In the third form, this imports a previously exported database to the database.
The fourth form outputs the version of the command line and then immediately exits.
OPTIONS
-------
-host <host>::
Host to connect to. Default is localhost.
-port <port>::
Port to use when connecting to the host. Default is 8086.
-database <database>::
Database to use when connecting to the database.
-username <username>::
Username to connect to the server.
-password <password>::
Password to connect to the server. If left blank, this will prompt for a password.
-ssl:
Use https for requests.
-unsafeSsl::
Set this with '-ssl' to allow unsafe connections.
-execute <command>::
Executes the command and exits.
-format <json|csv|column>::
Sets the format of the server responses. Default is column.
-precision <rfc3339|h|m|s|ms|u|ns>::
Specifies the format of the timestamp. Default is ns.
-consistency <any|one|quorum|all>::
Set the write consistency level. Default is one.
-pretty::
Turns on pretty print format for the JSON format.
Allow setting the node id in the influx cli program The string `node <n>` can be used to specify which data node the data should be retrieved from. This uses the `node_id=X` query parameter that is supported, but wasn't exposed anywhere in the client library. We use this feature enough internally when attempting to find inconsistencies or network errors that it is easier if this is just supported. Otherwise, I continue having to recompile the CLI program every time I need to do this. To clear a previously set node, you can use `node 0` or `node clear`.
2017-11-29 17:20:28 +00:00
-node <n>::
Specifies the data node that should be queried for data. This option is only valid on enterprise clusters.
Initial work creating man pages
2016-07-15 21:43:05 +00:00
-import::
Import a previous database export from a file. If specified, '-path <path>' must also be specified.
-path <path>::
Path to the database export file to import. Must be used with '-import'.
-pps <n>:
How many points per second the import will allow. By default, it is zero and will not throttle importing.
-compressed::
Set if the import file is compressed. Must be used with '-import'.
-version::
Outputs the version of the influx client.
Support proxy environment variables in the influx client This also adds support for both the v1 and v2 APIs to set the Proxy function on the underlying http.Transport. The functionality for proxy environment variables is provided by the [http.ProxyFromEnvironment](https://godoc.org/net/http#ProxyFromEnvironment).
2018-02-12 03:11:23 +00:00
ENVIRONMENT
-----------
The environment variables can be specified in lower case or upper case. The upper case version has precedence.
HTTP_PROXY [protocol://]<host>[:port]::
Sets the proxy server to use for HTTP.
HTTPS_PROXY [protocol://]<host>[:port]::
Sets the proxy server to use for HTTPS. Takes precedence over HTTP_PROXY for HTTPS.
NO_PROXY <comma-separated list of hosts>::
List of host names that shouldn't go through any proxy. If set to an asterisk \'*' only, it matches all hosts.
Initial work creating man pages
2016-07-15 21:43:05 +00:00
include::footer.txt[]