Skip to main content
Last updated on

Ingest data from Square

Beta

This feature is in Beta. Workspace admins can control access to this feature from the Previews page. See Manage Databricks previews.

This page shows how to create a managed Square ingestion pipeline using Lakeflow Connect.

Requirements​

  • To create an ingestion pipeline, first meet the following requirements:

    • Your workspace must be enabled for Unity Catalog.

    • Serverless compute must be enabled for your workspace. See Serverless compute requirements.

    • If you plan to create a new connection: You must have CREATE CONNECTION privileges on the metastore. See Manage privileges in Unity Catalog.

      If the connector supports UI-based pipeline authoring, an admin can create the connection and the pipeline at the same time by completing the steps on this page. However, if the users who create pipelines use API-based pipeline authoring or are non-admin users, an admin must first create the connection in Catalog Explorer. See Connect to managed ingestion sources.

    • If you plan to use an existing connection: You must have USE CONNECTION privileges or ALL PRIVILEGES on the connection object.

    • You must have USE CATALOG privileges on the target catalog.

    • You must have USE SCHEMA and CREATE TABLE privileges on an existing schema or CREATE SCHEMA privileges on the target catalog.

  • To ingest from Square, first configure authentication from Databricks and create a connection. See Configure authentication to Square and Create a Square connection.

Create an ingestion pipeline​

For the list of supported source tables, see Supported source tables.

  1. In the sidebar of the Databricks workspace, click Data Ingestion.
  2. On the Add data page, under Databricks connectors, click Square.
  3. On the Connection page of the ingestion wizard, select the connection that stores your Square credentials. If you have the CREATE CONNECTION privilege on the metastore, click Plus icon. Create connection to create a connection with the credentials from Configure authentication to Square.
  4. Click Next.
  5. On the Ingestion setup page, enter a name for the pipeline.
  6. Select a catalog and a schema to write event logs to. If you have USE CATALOG and CREATE SCHEMA privileges on the catalog, click Plus icon. Create schema in the drop-down menu to create a schema.
  7. Click Create pipeline and continue.
  8. On the Source page, select the tables to ingest.
  9. Click Save and continue.
  10. On the Destination page, select a catalog and a schema to load data into. If you have USE CATALOG and CREATE SCHEMA privileges on the catalog, click Plus icon. Create schema in the drop-down menu to create a schema.
  11. Click Save and continue.
  12. (Optional) On the Schedules and notifications page, click Plus icon. Create schedule. Set the frequency to refresh the destination tables.
  13. (Optional) Click Plus icon. Add notification to set email notifications for pipeline operation success or failure, then click Save and run pipeline.

Examples​

The Square connector makes available 17 source tables in the default source schema. Ingest individual tables or the entire schema.

Ingest specific tables​

Use this option to ingest a specific subset of tables, or to customize destination naming per table.

The following pipeline definition file ingests individual Square tables:

YAML
resources:
  pipelines:
    square_pipeline:
      name: square_pipeline
      catalog: 'main'
      target: 'square_data'
      ingestion_definition:
        connection_name: square_connection
        objects:
          - table:
              source_schema: 'default'
              source_table: 'payments'
              destination_catalog: 'main'
              destination_schema: 'square_data'
              destination_table: 'payments'
          - table:
              source_schema: 'default'
              source_table: 'orders'
              destination_catalog: 'main'
              destination_schema: 'square_data'
              destination_table: 'orders'
          - table:
              source_schema: 'default'
              source_table: 'customers'
              destination_catalog: 'main'
              destination_schema: 'square_data'
              destination_table: 'customers'

Ingest the entire schema​

Use this option to ingest all Square source tables into a single destination schema with one declaration.

The following pipeline definition file ingests all supported Square tables into a destination schema:

YAML
resources:
  pipelines:
    square_pipeline:
      name: square_pipeline
      catalog: 'main'
      target: 'square_data'
      ingestion_definition:
        connection_name: square_connection
        objects:
          - schema:
              source_schema: 'default'
              destination_catalog: 'main'
              destination_schema: 'square_data'

Declarative Automation Bundles job definition file​

The following is an example job definition file for use with Declarative Automation Bundles. The job runs daily.

YAML
resources:
  jobs:
    square_job:
      name: square_job
      schedule:
        quartz_cron_expression: '0 0 0 * * ?'
        timezone_id: 'UTC'
      tasks:
        - task_key: square_ingestion
          pipeline_task:
            pipeline_id: ${resources.pipelines.square_pipeline.id}

Common patterns​

For advanced pipeline configurations, see Common patterns for managed ingestion pipelines.

Next steps​

Start, schedule, and set alerts on your pipeline. See Common pipeline maintenance tasks.

Additional resources​

On this page