Skip to content
This repository has been archived by the owner on Dec 3, 2024. It is now read-only.

Latest commit

 

History

History
108 lines (77 loc) · 5.25 KB

README.md

File metadata and controls

108 lines (77 loc) · 5.25 KB
Raw

CloudQuery Plaid Source Plugin

DEPRECATED - FOR THE LATEST VERSION OF THIS PLUGIN PLEASE VISIT https://hub.cloudquery.io/plugins/source/cloudquery/plaid/latest/docs

test Go Report Card

A Plaid source plugin for CloudQuery that loads data from the Plaid API to any database, data warehouse or data lake supported by CloudQuery, such as PostgreSQL, BigQuery, Athena, and many more.

Supported Resources

For a full list of supported resources, see the tables documentation.

Configuration

The following source configuration file will sync supported data points to a PostgreSQL database. See the CloudQuery Quickstart for more information on how to configure the source and destination.

kind: source
spec:
  name: "plaid"
  path: "cloudquery/plaid"
  version: "v1.1.0"
  destinations: [postgresql]
  spec:
    # plugin spec section
    client_id: ${PLAID_CLIENT_ID}
    secret: ${PLAID_SECRET}
    access_token: ${PLAID_ACCESS_TOKEN}
    environment: sandbox

Plugin Spec

  • client_id (string, required):

    A Plaid client ID from your dashboard. See the Plaid docs for more information

  • secret (string, required):

    A Plaid secret from your dashboard. See the Plaid docs for more information

  • access_token (string, required):

    A Plaid access token obtained by following the link authorization flow. We provide an example application to generate a token for testing purposes only. For production usage you should set up a hosted frontend application and backend server that saves access tokens from link authentication flows initiated by your users. See the Plaid docs for more information

  • environment (string, optional):

    The Plaid environment to use. Defaults to sandbox. See the Plaid docs for more information. Should match the Plaid secret you are using

Example Queries

List recent transactions

select name, category, amount, iso_currency_code, date, merchant_name, payment_channel from plaid_transactions
order by
  date desc
limit
  10

Example result:

                 name                  |                   category                   | amount | iso_currency_code |    date    |   merchant_name   | payment_channel 
---------------------------------------+----------------------------------------------+--------+-------------------+------------+-------------------+-----------------
 Uber 063015 SF**POOL**                | {Travel,Taxi}                                |    5.4 | "USD"             | 2023-01-30 | "Uber"            | online
 CREDIT CARD 3333 PAYMENT *//          | {Payment,"Credit Card"}                      |     25 | "USD"             | 2023-01-30 | null              | other
 ACH Electronic CreditGUSTO PAY 123456 | {Transfer,Debit}                             |   5850 | "USD"             | 2023-01-29 | null              | online
 CD DEPOSIT .INITIAL.                  | {Transfer,Deposit}                           |   1000 | "USD"             | 2023-01-29 | null              | other
 United Airlines                       | {Travel,"Airlines and Aviation Services"}    |   -500 | "USD"             | 2023-01-28 | "United Airlines" | in store
 Touchstone Climbing                   | {Recreation,"Gyms and Fitness Centers"}      |   78.5 | "USD"             | 2023-01-28 | null              | in store
 Starbucks                             | {"Food and Drink",Restaurants,"Coffee Shop"} |   4.33 | "USD"             | 2023-01-27 | "Starbucks"       | in store
 McDonald's                            | {"Food and Drink",Restaurants,"Fast Food"}   |     12 | "USD"             | 2023-01-27 | "McDonald's"      | in store
 SparkFun                              | {"Food and Drink",Restaurants}               |   89.4 | "USD"             | 2023-01-26 | null              | in store
 INTRST PYMNT                          | {Transfer,Credit}                            |  -4.22 | "USD"             | 2023-01-25 | null              | other
(10 rows)

Development

Run tests

make test

Run linter

make lint

Generate docs

make gen-docs

Release a new version

  1. Run git tag v1.0.0 to create a new tag for the release (replace v1.0.0 with the new version number)
  2. Run git push origin v1.0.0 to push the tag to GitHub

Once the tag is pushed, a new GitHub Actions workflow will be triggered to build the release binaries and create the new release on GitHub. To customize the release notes, see the Go releaser changelog configuration docs.