Canvas Catalog Reader

#   _____           _              _____        __      
#  |  __ \         (_)            |_   _|      / _|     
#  | |__) |___  ___ _ _ __   ___    | |  _ __ | |_ ___  
#  |  _  // _ \/ __| | '_ \ / _ \   | | | '_ \|  _/ _ \ 
#  | | \ \  __/ (__| | |_) |  __/  _| |_| | | | || (_) |
#  |_|  \_\___|\___|_| .__/ \___| |_____|_| |_|_| \___/ 
#                    | |                                
#                    |_|

# Project Name - Canvas Catalog Reader

# Recipe URL - https://app.lingk.io/a/10932/tf/18554

# Description -  This recipe shows how to read data from a Canvas Catalog endpoint. Simply replace the root URL to read in your data.

# Systems - Canvas
# Connectors - Canvas
# Data Flows - Single Direction
# Connection Type - API

# Add Recipe notes / Change log information here!

#    _____                            _                 
#   / ____|                          | |                
#  | |     ___  _ __  _ __   ___  ___| |_ ___  _ __ ___ 
#  | |    / _ \| '_ \| '_ \ / _ \/ __| __/ _ \| '__/ __|
#  | |___| (_) | | | | | | |  __/ (__| || (_) | |  \__ \
#   \_____\___/|_| |_|_| |_|\___|\___|\__\___/|_|  |___/
#

# CONNECTORS specify what data will be pulled into the in-memory database during processing

connectors:

# Configure Canvas connector in your Environment before running this recipe
  # Canvas Setup - https://help.lingk.io/en/articles/263-canvas-setup-guide

# Replace the 'rootUrl' value below to read the data needed
  - name: canvasCatalogReader
    type: canvasCatalogReader
    properties:
      accessToken: 
      path: /api/v1/user_registrations
      rootUrl: https://learn.rm.edu

schema:
      fields:
      - name: user_registrations
        type: Array
        items:
          name: arrayElement
          type: Object
          objectSchema:
            name: objectSchemaSchema
            fields:
              - name: custom_fields
                type: Object
                objectSchema:
                  name: objectSchemaSchema
                  fields:
                    - name: ship
                      type: String

#    _____ _        _                            _       
#   / ____| |      | |                          | |      
#  | (___ | |_ __ _| |_ ___ _ __ ___   ___ _ __ | |_ ___ 
#   \___ \| __/ _` | __/ _ \ '_ ` _ \ / _ \ '_ \| __/ __|
#   ____) | || (_| | ||  __/ | | | | |  __/ | | | |_\__ \
#  |_____/ \__\__,_|\__\___|_| |_| |_|\___|_| |_|\__|___/

# STATEMENTS specify how the data should be processed while in memory

statements:

- statement: (test) => select * from canvasCatalogReader
  - statement: print test
  - statement: (count) => select count(*) from canvasCatalogReader
  - statement: print count

# Add more statements to convert, join, aggregrate, transform, and integrate your data