Skip to content

doc(influxdb): add doc to influxdb source #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 24, 2019
Merged

doc(influxdb): add doc to influxdb source #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 75 additions & 0 deletions src/5.2/en/source.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,10 @@
<entry>xtrabackup</entry>
<entry>Backup MySQL with the percona xtrabackup command line tool.</entry>
</row>
<row>
<entry>influxdump</entry>
<entry>Backup Influxdb with the influxd command line tool.</entry>
</row>
</tbody>
</tgroup>
</table>
Expand Down Expand Up @@ -1100,4 +1104,75 @@

</section>

<section id="source.influxdump">

<indexterm><primary>InfluxDB</primary></indexterm>
<indexterm><primary>influxdump</primary></indexterm>

<title>InfluxDB - influxdump</title>

<para>
Backup an InfluxDB database with influxdump.
</para>

<table id="source.tables.options.influxdump">
<title>influxdump-Options</title>
<tgroup cols="5" align="left" colsep="1" rowsep="1">
<thead>
<row>
<entry>Name</entry>
<entry>Value</entry>
<entry>Required</entry>
<entry>Default</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry>host</entry>
<entry>string</entry>
<entry>no</entry>
<entry>localhost:8088</entry>
<entry>Hostname and port of your InfluxDB-Server.</entry>
</row>
<row>
<entry>database</entry>
<entry>string</entry>
<entry>no</entry>
<entry>all</entry>
<entry>Name of database you want to backup, all by default.</entry>
</row>
<row>
<entry>pathToInfluxdump</entry>
<entry>string</entry>
<entry>no</entry>
<entry></entry>
<entry>Custom influxdump executable location.</entry>
</row>
</tbody>
</tgroup>
</table>

<example id="source.influxdump.example.xml">
<title>influxdump XML example</title>
<programlisting><![CDATA[<!-- source influxdump -->
<source type="influxdump">
<option name="host" value="localhost:8088"/>
<option name="database" value="myDatabase"/>
</source>]]></programlisting>
</example>

<example id="source.influxdump.example.json">
<title>influxdump JSON example</title>
<programlisting><![CDATA[{
"type": "influxdump",
"options": {
"host": "localhost:8088",
"database": "myDatabase"
}
}]]></programlisting>
</example>

</section>

</chapter>