Square Plugin documentation

Report an issue

Back to source list

Official

Square

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

Publisher

cloudquery

Repository

github.com

Latest version

v1.3.18

Type

Source

Platforms

Date Published

Documentation Tables Changelog Destinations

Overview

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-integration configuration
spec:
  name: square
  registry: docker
  path: docker.cloudquery.io/cloudquery/source-square:v1.3.18
  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

The Square plugin is distributed as a Docker image. This requires a Docker runtime to be installed on the same machine as the CloudQuery CLI, and a CLI version that supports the docker registry type (v3.12.0 and higher).

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.

Running in a Containerized Environment #

To run the Square integration in a containerized environment, see the Using CloudQuery Docker Registry Integrations Inside a Containerized Environment guide.