====== Tabli - Help ======



===== About =====
''help'' on a [[docs:tabli:module|module]] or on a [[docs:tabli:command|action]] can be found:
  * at the command line with the ''%%--help%%'' or ''%%-h%%'' [[docs:tabli:flag|flag]]
  * or on this website


===== Example =====
''help'' on the [[docs:tabli:data:transfer|transfer of a data resource]].

<unit>
<code dos table_transfer_help.cmd>
tabli data transfer --help
</code>
<console>
Tabli data transfer
===================

Transfer one or more data resources.



Examples
--------

 1 - To download the table `time` from the data store `sqlite` into the file `time.csv`, you would execute


        tabli data transfer time@sqlite time.csv


 2 - To download all the table that starts with `dim` from the data store `oracle` into the directory `dim`, you would execute


        tabli data transfer dim*@oracle dim


 3 - To download the data of the query defined in the file `QueryToDownload.sql` and executed against the data store `sqlite` into the file `QueryData.csv`, you would execute the following command:


        tabli data transfer (QueryToDownload.sql)@sqlite QueryData.csv


 4 - To download the data of all query defined in all `sql` files of the current directory, execute them against the data store `sqlite` and save the results into the directory `result`, you would execute the following command:


        tabli data transfer (*.sql)@sqlite result


 5 - Transfer the result of the query `top10product` from sqlite to the table `top10product` of sql server


        tabli data transfer (top10product.sql)@sqlite @sqlserver




Syntax
------


    tabli data transfer [options|flags] <source-selector> <target-data-uri>


where:


  Arguments:

    <source-selector>                                       A data selector that select the data resources to transfer

    <target-data-uri>                                       A target data URI that defines the destination (Example: [table]@connection). If the target data uri has no name, the name will be the name of the source.


  Cross Data Transfer Options:

    -bs,--buffer-size <bufferSize>                          defines the size of the memory buffer between the source and target threads

    -mdu,--metrics-data-uri <metricsDataUri>                defines a target data uri where the data metrics should be exported

    -sfs,--source-fetch-size <fetchSize>                    defines the fetch size against the source connection

    -tbs,--target-batch-size <batchSize>                    defines the batch size against the target data resource

    -tcf,--target-commit-frequency <commitFrequency>        defines the commit frequency in number of batches against the target data resource

    -tw,--target-worker <targetWorkerCount>                 defines the target number of thread against the target connection

    -wbv,--with-bind-variables                              defines if bind variables are used in the SQL statement


  Data Definition Options:

    -sa,--source-attribute <attributeName=value>            Set a source data resource attribute

    -ta,--target-attribute <attributeName=value>            Set a target data resource attribute


  Transfer Operation Options:

    -so,--source-operation <value>                          defines the data operation (drop or truncate) on the source after transfer. Note: A `move` operation will drop the source.

    -to,--target-operation <targetDataOperation>            defines the data operations (replace, truncate) on the existing target before transfer.

    -op,--transfer-operation <transferOperation>            defines the transfer operation (insert, update, delete, upsert, merge, move, copy). Default to `copy` for a file system and `insert` for a database.


  Selection Options:

    -wd,--with-dependencies                                 If set, the dependencies will be also selected


  Global Options:

    -cf,--conf <path>                                       The path to a configuration file

    -cv,--connection-vault <path>                           The path where the connection vault is located

    -h,--help                                               Print this help

    -l,--log-level <error|warning|tip|info|fine>            Set the log level

    -ns,--not-strict                                        A minor error will not stop the process.

    -odu,--output-data-uri <outputDataUri>                  defines the output data uri for the feedback data (default: console)

    -oo,--output-operation <dataOperation>                  defines the data operations (replace, truncate) on an existing output resource before transfer.

    -oop,--output-transfer-operation <transferOperation>    defines the output transfer operation (insert, update, merge, copy). Default to `copy` for a file system and `insert` for a database.

    -pp,--passphrase <passphrase>                           A passphrase (master password) to decrypt the encrypted values
</console>
</unit>