Apache Hop
Download
User manual 2.20.0 (pre-release)

Development Documentation

Edit this page

Google Drive VFS

Scheme

The scheme you can use to access your files in Google Drive is

googledrive://

Configuration

You need to generate a credentials file to make it work. Follow the Google documentation to see how that is done. You also need to specify a folder in which security tokens are going to be saved. You can specify both in the Hop system configuration options. This can be done in the Hop GUI: go to the "Google Drive" tab in the Options dialog (from the Tools menu). You can also use the hop-conf script with the following options:

      -gdc, --google-drive-credentials-file=<credentialsFile>
                            Configure the path to a Google Drive credentials JSON
                              file
      -gdt, --google-drive-tokens-folder=<tokensFolder>
                            Configure the path to a Google Drive tokens folder

Once done you will see a googleDrive entry in the central hop-config.json file:

json
{
  "googleDrive" : {
    "credentialsFile" : "/path/to/google-drive-credentials.json",
    "tokensFolder" : "/path/to/tokens"
  }
}

When you try to run the first time you’ll see a message on the console where you executed Hop GUI or Hop Run saying something like:

Please open the following address in your browser:
  https://accounts.google.com/o/oauth2/auth?access_type=offline&client_id=yourClientId&redirect_uri=http://localhost:8888/Callback&response_type=code&scope=https://www.googleapis.com/auth/drive

Open that URL in a browser and authenticate the given client ID. You’ll then get a token in the configured tokens folder with which you can work.

Running Hop in Docker? See Cloud storage credentials to pass these settings to the container.

Options

The options below are the ones in the Plugins section of the configuration perspective. Each is also settable with hop-conf.

These options are stored under googleDrive in hop-config.json.

Option Description Default

Path to a Google Drive credentials JSON file

Please note that this is a global configuration option and while you can specify variables that these will be not include project specific settings. Accepts variables.

Path to a tokens folder for credential caching

Pick a safe folder to store these tokens. Accepts variables.

Usage and testing

To test if the configuration works you can simply put a small CSV file in Google Drive and then use File/Open in Hop GUI. Then you type in googledrive:// as a file location and hit enter (or click the refresh button). Browse to the CSV file you uploaded and open it. If all is configured correctly you should be able to see the content in the Hop GUI.