Back to plugin list
square
Official

Square

This plugin is in preview.

The CloudQuery Square plugin pulls data from Square and loads it into any supported CloudQuery destination

Publisher

cloudquery

Repositorygithub.com
Latest version

v1.3.0

Type

Source

Platforms
Date Published

Price

Free

Set up process


brew install cloudquery/tap/cloudquery

1. Download CLI and login

See installation options

2. Create source and destination configs

Plugin configuration

cloudquery sync square.yml postgresql.yml

3. Run the sync

CloudQuery sync

Overview

The CloudQuery Square plugin pulls data from Square and loads it into any supported CloudQuery destination (e.g. PostgreSQL, BigQuery, Snowflake, and more).
See tables for a list of resources supported.

Example Configuration

This example syncs from Square to a Postgres destination. The (top level) source spec section is described in the Source Spec Reference.
kind: source
# Common source-plugin configuration
spec:
  name: square
  registry: docker
  path: docker.cloudquery.io/cloudquery/source-square:v1.2.0
  tables: ["*"]
  destinations: ["postgresql"]
  # Square-specific configuration
  spec:
    # required
    access_token: "${SQUARE_ACCESS_TOKEN}"
    # required
    environment: "sandbox" # sandbox or production
    # optional, default: 100
    # concurrency: 100
    # optional, default: 10000
    # queue_size: 10000

Authentication

In order to fetch information from Square, cloudquery needs to authenticate using an access token.

Configuration Reference

This is the (nested) spec used by the Square source plugin:
  • access_token (string) (required):
    Your access token from Square.
  • environment (string) (required):
    The environment to use. Can be production or sandbox.
  • concurrency (integer) (optional) (default: 100):
    Maximum number of requests to perform concurrently.
  • queue_size (integer) (optional) (default: 10000):
    Maximum number of items to have in the queue before waiting for an unfinished request to complete.


Subscribe to product updates

Be the first to know about new features.