Data Connector for Stripe (BETA)

This Data Connector allows you to import Stripe objects into Treasure Data. This feature is currently in beta, so any feedback would be appreciated.

Table of Contents

Prerequisites

  • Basic knowledge of Treasure Data
  • Basic knowledge of Stripe

Option 1: Use Web Console

Create a new connection

Please visit Treasure Data Connections and search and select Stripe. The dialog below will open. We support two Authentication Methods:

Method 1: Secret Key

Please enter Live Secret Key from Stripe —> Your Account —> Account Settings —> API Keys.



Method 2: OAuth — coming soon

Please select an existing OAuth connection for Stripe, or click the link under OAuth connection to create a new one.



Create a new OAuth connection

Please login to your Stripe account in popup window:



And grant access to Treasure Data app:



You will be redirected back to Treasure Data Connections. Please repeat the first step (Create a new connection) and choose your new OAuth connection.



Create a new transfer

Upon creating above connection, you will be automatically taken to My Connections tab. Look for the connection you created and click New Transfer. Please note incremental option is only supported for event object.



The dialog below will open. Please fill the details and click Next.



Next, you will see a Preview of your data similar to the dialog below. If you wish to change anything, please click on Advanced Settings or else click on Next.



Third step is to select the database and table where you want to transfer the data, as per the following dialog:



Finally, specify the schedule of the data transfer using the dialog below and click Start Transfer:



You will see the new data transfer in progress listed under the My Input Transfers tab and a corresponding job will be listed in the Jobs section.

Now, you are ready to start analyzing your data!

Option 2: Use Command Line

Step 0: Install ‘td’ command v0.11.9 or later

You can install the newest Treasure Data Toolbelt.

$ td --version
0.15.0

Step 1: Create Configuration File

Prepare configuration file (for eg: load.yml) like below, with your Stripe account access information.

in:
  type: stripe
  client_id: xxxxxxxxxxxxx
  client_secret: xxxxxxxxxxxxx
  refresh_token: xxxxxxxxxxxxx
  target: event
  incremental: true
  start_datetime: 2017-01-01T07:36:22.000Z
  formula: gt
out:
  mode: replace

This example dumps Stripe Event object:

  • client_id and client_secret: your Stripe app credentials
  • refresh_token: Stripe OAuth2 refresh_token, you need to grant access to your Stripe app, using an Stripe user account
  • target: Stripe object you want to import. Supported values: account, application_fee, balance_history, charge, coupon, customer, dispute, file_upload, event, invoice_item, invoice, order, plan, product, refund, subscription, transfer
  • start_datetime: import data from this date, format is: yyyy-MM-ddThh:mm:ss.000Z
  • formula: Formula to evaluate start_datetime. Supported values: gt(greater than), gte(greater than or equal), lt(less than), lte(less than or equal).
  • incremental: should data import be continuous or once, default as true. Incremental is only supported when target is event.

For more details on available out modes, see Appendix A

Step 2 (optional): Preview data to import

You can preview data to be imported using the command td connector:preview.

$ td connector:preview load.yml
+--------------------------------+---------------+--------------------+----
| id:string                      | object:string | api_version:string | ...
+--------------------------------+---------------+--------------------+----
| "evt_19cs52EC2hHOQuTd4SejXK0W" | "event"       | "2016-07-06"       |
| "evt_19cs52EC2hHOQuTdG7Qm4fS3" | "event"       | "2016-07-06"       |
| "evt_19cs4REC2hHOQuTdhZZD58uw" | "event"       | "2016-07-06"       |
| "evt_19cs4QEC2hHOQuTdjADeyQcC" | "event"       | "2016-07-06"       |
| "evt_19cs3oEC2hHOQuTdjZm6u0pB" | "event"       | "2016-07-06"       |
+--------------------------------+---------------+--------------------+----

Step 3: Execute Load Job

Finally, submit the load job. It may take a couple of hours depending on the data size. Users need to specify the database and table where their data are stored.

It is recommended to specify --time-column option, since Treasure Data’s storage is partitioned by time (see also architecture) If the option is not given, the Data Connector will choose the first long or timestamp column as the partitioning time. The type of the column specified by --time-column must be either of long and timestamp type.

If your data doesn’t have a time column you may add it using add_time filter option. More details at add_time filter plugin

$ td connector:issue load.yml --database td_sample_db --table td_sample_table --time-column updated_date

The above command assumes you have already created database(td_sample_db) and table(td_sample_table). If the database or the table do not exist in TD this command will not succeed, so create the database and table manually or use --auto-create-table option with td connector:issue command to auto create the database and table:

$ td connector:issue load.yml --database td_sample_db --table td_sample_table --time-column updated_date --auto-create-table
Untitled-3
You can assign Time Format column to the "Partitioning Key" by "--time-column" option.

Scheduled execution

You can schedule periodic Data Connector execution for periodic Stripe import. We take great care in distributing and operating our scheduler in order to achieve high availability. By using this feature, you no longer need a cron daemon on your local datacenter.

Create the schedule

A new schedule can be created using the td connector:create command. The name of the schedule, cron-style schedule, the database and table where their data will be stored, and the Data Connector configuration file are required.

$ td connector:create \
    daily_stripe_import \
    "10 0 * * *" \
    td_sample_db \
    td_sample_table \
    load.yml
Untitled-3
The `cron` parameter also accepts these three options: `@hourly`, `@daily` and `@monthly`.
Untitled-3
By default, schedule is setup in UTC timezone. You can set the schedule in a timezone using -t or --timezone option. Please note that `--timezone` option only supports extended timezone formats like 'Asia/Tokyo', 'America/Los_Angeles' etc. Timezone abbreviations like PST, CST are *not* supported and may lead to unexpected schedules.

List the Schedules

You can see the list of currently scheduled entries by td connector:list.

$ td connector:list
+-----------------------+--------------+----------+-------+--------------+-----------------+----------------------------+
| Name                  | Cron         | Timezone | Delay | Database     | Table           | Config                     |
+-----------------------+--------------+----------+-------+--------------+-----------------+----------------------------+
| daily_stripe_import   | 10 0 * * *   | UTC      | 0     | td_sample_db | td_sample_table | {"type"=>"stripe", ... }  |
+-----------------------+--------------+----------+-------+--------------+-----------------+----------------------------+

Show the Setting and History of Schedules

td connector:show shows the execution setting of a schedule entry.

% td connector:show daily_Stripe_import
Name     : daily_stripe_import
Cron     : 10 0 * * *
Timezone : UTC
Delay    : 0
Database : td_sample_db
Table    : td_sample_table

td connector:history shows the execution history of a schedule entry. To investigate the results of each individual execution, please use td job <jobid>.

% td connector:history daily_stripe_import
+--------+---------+---------+--------------+-----------------+----------+---------------------------+----------+
| JobID  | Status  | Records | Database     | Table           | Priority | Started                   | Duration |
+--------+---------+---------+--------------+-----------------+----------+---------------------------+----------+
| 578066 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-18 00:10:05 +0000 | 160      |
| 577968 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-17 00:10:07 +0000 | 161      |
| 577914 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-16 00:10:03 +0000 | 152      |
| 577872 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-15 00:10:04 +0000 | 163      |
| 577810 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-14 00:10:04 +0000 | 164      |
| 577766 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-13 00:10:04 +0000 | 155      |
| 577710 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-12 00:10:05 +0000 | 156      |
| 577610 | success | 10000   | td_sample_db | td_sample_table | 0        | 2015-04-11 00:10:04 +0000 | 157      |
+--------+---------+---------+--------------+-----------------+----------+---------------------------+----------+
8 rows in set

Delete the Schedule

td connector:delete will remove the schedule.

$ td connector:delete daily_stripe_import

Appendix

A) Modes for out plugin

You can specify file import mode in out section of load.yml.

append (default)

This is the default mode and records are appended to the target table.

in:
  ...
out:
  mode: append

replace (In td 0.11.10 and later)

This mode replaces data in the target table. Please note that any manual schema changes made to the target table will remain intact with this mode.

in:
  ...
out:
  mode: replace

Contact GitHub API Training Shop Blog About


Last modified: Jan 17 2017 22:47:04 UTC

If this article is incorrect or outdated, or omits critical information, please let us know. For all other issues, please see our support channels.