Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

The bulk exporter can extract the content of a Squirro project and export it to a CSV file. The bulk exporter is part of the Squirro Toolbox.

Table of Contents

Basic Usage

The bulk export is called on the command line with an output file. The simplest invocation is as follows:

squirro_bulk_exporter ^
    --token ... ^
    --cluster https://next.squirro.net  ^
    --project-id ... ^
    --out-file data.csv

Note that the lines have been wrapped with the circumflex (^) at the end of each line. On Mac and Linux you will need to use backslash (\) instead.

Arguments

The following table lists all the arguments.

ArgumentMandatoryDescription
General Options
-h Show a help message and exit.
--version Output the tool version and exit.
--verbose, -v 

Increase log verbosity.

  • Not specified: the tool outputs all warnings and errors.
  • Specified once or more: informational messages are also output.
  • Specified twice or more: debugging messages are shown.
      • Specified three times or more: more information is included in all messages.
--log-file FILE Path to a log file on disk, where the log output is to be stored. If this is not specified, the log messages are shown on the console.
Connection Options (see Connecting to Squirro for finding these values)
--token TOKEN
-t TOKEN		YesThe Authentication Token with which to authenticate.
If the token value starts with a dash, you need to use an equal sign to specify the value like this: --token="-12345…"

--cluster URL
-c URL

 The Squirro cluster from which to export the data.
--project-id PROJECT_IDYesThe Project identifier from which to export the data.
Export Options

--out-file FILE
-o FILE

YesOutput file where the CSV data will be stored.
--query QUERY The query for which to export the results. Defaults to an empty query - which returns all the items in the project.
--batch-size BATCH_SIZE Number of items that are requested from the server in one request. Increasing this from the default of 100 can improve export performance at the cost of affecting the overall system performance.
--keyword-delimiter DELIMITER The separator to use between multiple item keywords. Default is a comma.
  • No labels