.. _`Archive files`:

.. _`org.sysess.sympathy.export.exportdatasources`:

Archive files
`````````````

.. image:: export_datasource.svg
   :width: 48


Compress/decompress files in multiple archive formats.




Documentation
:::::::::::::

This node handles compression/decompression of some common archive formats.

The following formats are supported:
* ZIP
* GZIP
* TAR

The ZIP format can compress and store multiple files in a single archive.
All input files will be put into an archive with the configured name.

GZIP however only compresses one file at a time. The compressed file will
have the same name as the original file, but with the added extension .gz.
Therefore you cannot configure the name.

To create an archive with multiple files, using GZIP, you have to use two
nodes in succession. In the first one you will use TAR, which creates one
file of all the input files, much like the ZIP option, but this file is not
yet compressed. So in the second node you will use GZIP to compress the TAR
archive. This results in a file iwth the extension .tar.gz.

To decompress you then do the same in reverse. First decompress with GZIP
then extract all files with TAR.


Definition
::::::::::


Input ports
...........

    **port0**  [datasource]
        Datasources to be exported

    **port1** 0 - 1,  [datasource]
        External filenames


Output ports
............

    **port0**  [datasource]
        Datasources of exported files




Configuration
.............

    **Exporter** (active_exporter)
        Select data format exporter. Each data format has its own exporter with its own special configuration, see exporter information. The selection of exporter do also suggest filename extension.

    **Output directory** (directory)
        Select the directory where to export the files.
    **Filename** (filename)
        Filename without extension.



Plugins
.......

* :ref:`plugin_datasourcearchivebase`






Examples
........

* :download:`InputOutputGenerate.syx </Examples/Sympathy/InputOutputGenerate/InputOutputGenerate.syx>`




Implementation
..............

.. automodule:: node_export_datasource
    :noindex:

.. class:: ExportDatasources
    :noindex: