playground
  • DAP CLI
    • Getting Started
    • Security
    • Reference
      • dap snapshot
      • dap incremental
      • dap initdb
      • dap snycdb
      • dap dropdb
      • dap list
      • dap schema
  • Data Access Platform
  • Rate Limits & Policies
  • Code examples
  • OpenAPI
  • Datasets
  • Namespaces
  • Authentication
  • Status Codes
  • Page 1
  • Query API
  • Page
  • Key Concepts
  • Data Formats
Powered by GitBook
On this page
  • Requirements
  • Installation
  • Commands
  • Upgrading DAP CLI
  • Rate Limiting
  • Logging & Debugging
  • Where To Get Help

DAP CLI

Access your organization's Instructure data from the command line.

NextGetting Started

Last updated 6 months ago

The Data Access Platform (DAP) CLI is a command-line tool that enables efficient access to large volumes of educational data with high fidelity and low latency. It adheres to a canonical data model and integrates with various educational products.

Built on top of the , DAP CLI allows you to:

  • Fetch initial snapshots of data.

  • Track incremental changes.

  • Initialize and synchronize a supported database with .

Before using DAP CLI, it is recommended to familiarize yourself with the key concepts of DAP.

Requirements

  • Supported Operating Systems: Ubuntu 22, Windows 11, Windows Server 2022, macOS 1

  • Supported Database Integrations: PostgreSQL 16.1+, MySQL 8.2+

Installation

The DAP CLI is available as a Python package in the . To install, use the following command:

pip install instructure-dap-client

If you are synchronizing with a database, install the package with the following features:

pip install "instructure-dap-client[postgresql,mysql]"

Learn more details about the installation and setup in the guide.

Commands

The basic syntax is:

dap [arguments] [command] [flags]

Upgrading DAP CLI

To ensure optimal performance, always use the latest version of DAP CLI. Check your current version and available updates with:

dap --version

To upgrade to the latest version, run:

pip install --upgrade instructure-dap-client
pip install --upgrade "instructure-dap-client[postgresql,mysql]"

Rate Limiting

Logging & Debugging

The default log level is info, and messages are printed to the console. To change the log level or save logs to a file, use the following parameters:

dap --loglevel debug --logfile dap.log initdb --namespace canvas --table accounts

Where To Get Help

Refer to section in the sidebar for a list of available commands. Or, run the dap --help command to get this information right in your terminal.

DAP CLI follows the . Be aware of these limits when making requests.

Query API
DAP data
Python Package Index (PyPI)
Getting Started
Reference
rate limiting policies of DAP

DAP Community

Visit our forums to connect with the community and learn more about DAP.

Support

To report bugs or request new features, open a ticket for our Support Team.