On this page:

TriplyETL Getting Started

This page helps you to get started with TriplyETL. You can get started with TriplyETL in any of the following ways:

  1. TriplyETL Generator creates a new ETL project based on your answers to a set of question.
  2. TriplyETL Runner runs an existing ETL project.
  3. TriplyETL Library can be included as a dependency in your TypeScript project.

Prerequisites

In order to use TriplyETL, you must first install the following programs on your computer:

Install Git

  1. Go to this link and follow the instructions for your operating system (Windows, macOS, or Linux).

  2. Run the following commands to set your user name and email in Git:

    git config --global user.email "ada@triply.cc"
git config --global user.name "Ada Lovelace"

    This information will be used in the Git version history for the TriplyETL project. This allows your team to keep track of who made which change.

Install Node.js (simple approach)

Go to nodejs.org and click on option “18.x.y LTS (Recommended For Most Users)”. This will download the installer for your operating system. Run the installer on your computer.

On Windows, you must also select the number of bits on your computer: 32 or 64. The correct number of bits is 64 for almost all Windows computers.

Install Node.js (advanced approach)

For more advanced us, you can install the Node Version Manager (nvm). This allows you to install multiple versions of Node.js on the same computer. See the following links for more information:

On Windows
You can following the official instructions from Microsoft for installing NVM on Windows.
On macOS or Linux
You can follow the instructions for installing NVM on any operating system (including macOS and Linux).
Find a terminal application

You must use a terminal application in order to run commands from the TriplyETL CLI. Here are some examples of terminal applications on different operating systems:

On Windows
Most Windows versions come with some version of PowerShell preinstalled. You can also follow these instructions by Microsoft to update to the latest version of PowerShell.
On macOS
Most macOS version come with a Terminal application preinstalled.
On Linux
Most Linux versions come with a preinstalled terminal application. For example, on Ubuntu the GNOME Terminal application is preinstalled.

Minimum versions

TriplyETL requires the following minimum versions for the prerequisites:

  • NPM v10.2.1
  • Node.js v18

Update the prerequisites

Update NPM

If you have NPM installed, you can run npm -v to see your current version. If you want to upgrade to a different version (for example 10.2.1), you can run the following command:

npm install -g npm@10.2.1

For more information see NPM's "try latest stable version of npm" documentation.

Update Node.js

If you have Node.js installed, you can run node -v to see your current version. If you want to upgrade to a different version you need to use a Node package manager (e.g. nvm, n etc.). For more information visit Installing Node.js via package manager.

Update Git

If you have Git installed, you can run git -v to see your current version, if you want to upgrade to latest version you can:

Linux

Run command sudo apt-get update && sudo apt-get install git

Windows

What you need to do depends on your current Git version:

Older than 2.14.1

Uninstall Git from your system and reinstall Git for Windows.

Between 2.14.2 and 2.16.1

Run command git update

Greater than or equal to 2.16.1

Run command git update-git-for-windows

MacOS (with Homebrew)

  1. Install Homebrew

  2. Run command brew update && brew install git && brew upgrade git

TriplyETL Generator

The TriplyETL Generator allows you to create new ETL projects in your terminal application. If a TriplyETL project already exists, use the TriplyETL Runner instead.

In order to use TriplyETL Generator, you must have:

  1. Satisfied the prerequisites.

  2. A TriplyETL License Key. Contact info@triply.cc to obtain a License Key for your organization.

  3. A user account on a TriplyDB server. Contact info@triply.cc to set up a TriplyDB server for your organization, or create a free account on https://triplydb.com.

Run the following command to use the TriplyETL Generator:

npx @triply/etl-generator

If you use TriplyETL Generator for the first time, this command automatically downloads and installs the latest version on your computer. If you have used TriplyETL Generator in the past, this command automatically updates your installation to the latest version, if one is available.

TriplyETL Generator will ask the following questions (the exact sequence of questions depends on the answers given):

  a. TriplyETL License Key

  b. Project name

  c. Target folder

  d. Dataset name

  e. TriplyDB API Token

  f. TriplyDB URL

  g. TriplyDB email

  h. TriplyDB password

Here is an example of a possible run:

? TriplyETL License Key: [hidden]
? Project name: my-etl
? Target folder: my-etl
? Dataset name: my-etl
? Create a new TriplyDB API Token? Yes
? Your TriplyDB URL: my-org.triply.cc
? Your TriplyDB email: my-account@my-organization.com
? Your TriplyDB password: [hidden]
🏁 Your project my-etl is ready for use in my-etl.

Go to the target folder that you have specified:

cd my-etl

You can now use the TriplyETL Runner to run the ETL:

npx etl

TriplyETL Runner

The TriplyETL Runner allows you to run a local TriplyETL project in your terminal application.

In order to use TriplyETL Runner, you must have:

  1. Satisfied the prerequisites.

  2. A user account on a TriplyDB server. Contact info@triply.cc to set up a TriplyDB server for your organization, or create a free account on https://triplydb.com.

Perform the following steps to use the TriplyETL Runner:

Create a local copy of an existing ETL project.

If you do not have access to an existing TriplyETL project yet, use the TriplyETL Generator to create a new one.

If you have access to an existing TriplyETL project, use the following command to make a local copy with Git:

git clone ssh://git@git.triply.cc:10072/customers/my-org/my-project.git

Once you have created a local copy of an existing ETL project, go into the corresponding directory:

cd my-project

Install the dependencies:

npm i

Transpile the TypeScript files into JavaScript:

npm run build

You can now use the TriplyETL Runner:

npx etl

At this point, you should see a first TriplyETL process in your terminal application. If this is not the case, please contact support@triply.cc to help you out.

Visit the TriplyETL CLI documentation to learn more about how you can use the TriplyETL Runner. Visit the TriplyETL CI/CD documentation to learn more about how you can automate TriplyETL runs.

TriplyETL Library

If you are a software developer that is building a software application in TypeScript, you can include the TriplyETL Library in your project.

In order to use the TriplyETL Library, you must have:

  1. Satisfied the prerequisites.

  2. A TriplyETL License Key. Contact info@triply.cc to obtain a License Key for your organization.

  3. A user account on a TriplyDB server. Contact info@triply.cc to set up a TriplyDB server for your organization, or create a free account on https://triplydb.com.

Perform the following steps to use the TriplyETL Library:

Open the file .npmrc in your text editor, or create the file if it does not yet exist. Add the following content:

@triplydb:registry=https://git.triply.cc/api/v4/packages/npm/
@triplyetl:registry=https://git.triply.cc/api/v4/packages/npm/
//git.triply.cc/api/v4/packages/npm/:_authToken={LICENSE_KEY}

Replace {LICENSE_KEY} with your TriplyETL License Key. Contact support@triply.cc if you do not have such a license key yet.

Run the following command to add the TriplyETL dependency to your package.json file:

npm i @triplyetl/etl

Open one of the TypeScript files in your software project. When you add the following line to the top of your file, it should be recognized by your TypeScript editor:

import { sdo } from '@triplyetl/vocabularies'