DAP CLI Beta is Coming to an End: Upgrade to the Latest Version Today!

sgergely
Instructure
Instructure
0
392

Canvas.png

We are announcing the end of the beta for the older versions (0.x) of the DAP CLI as we fully transition to the latest and most advanced version, v1.1.0. This move ensures that all users are leveraging the improved performance, stability, and expanded features of our Generally Available (GA)-supported CLI and Client Library.

Why Upgrade to DAP CLI v1.1.0?

The latest version of the DAP CLI, v1.1.0, offers several significant improvements over its predecessors. Here’s why you should make the switch:

  1. Improved Performance: Version 1.1.0 builds on the complete rewrite introduced in version 1.0, offering better performance and reliability. For example, it includes optimized data retrieval processes that reduce latency and improve efficiency.
  2. Stable Release: Unlike the earlier beta versions (0.x series), v1.1.0 is a stable release that has undergone rigorous testing and refinement. This ensures it meets the highest standards of quality and stability, addressing issues such as SQL syntax errors and proper cleanup of temporary directories.
  3. New Features: The latest version introduces several new features, enhancing its functionality. Notably, it now supports MySQL and PostgreSQL databases, with features like automatic schema migration and support for extensible enumeration (soft enum) data types. The client also includes options to decompress downloaded files and improved handling of URL-encoded database credentials.

For detailed information on all the new features and improvements, please refer to the release notes.

Important Update Requirement for DAP CLI v1.1.0

While the upgrade brings many benefits, it also introduces a new requirement: providing a namespace is now mandatory. Previously, if no namespace was specified, the client defaulted to the "canvas" namespace. To ensure compatibility with the new version, you will now need to explicitly set the "namespace" parameter. For example:

 

 

dap --base-url https://api-gateway.instructure.com --client-id example-client-id --client-secret client-secret-here incremental --namespace canvas --table users --since 2024-01-01T00:00:00

 

 

In addition to "canvas," there are two other available namespaces: "canvas_logs" and "catalog." For more details on these namespaces and their usage, please refer to the relevant documentation and the blogpost that aims to help understanding them.

We understand that this may require some adjustments in your current setup, but the enhanced capabilities and performance gains will make it worthwhile.

How to Update to the Latest Version

Updating to the latest version of the DAP CLI is straightforward. Since it is available as a PyPI package, you can easily update it by running the following command in your terminal:

 

 

pip install --upgrade instructure-dap-client

 

 

For more information, you can visit the PyPI package page.

Make the Switch Today

We strongly recommend upgrading to DAP CLI v1.1.0 as soon as possible to take full advantage of the enhanced features and improved performance. For detailed information about the latest version, check out the official announcement.

We appreciate your understanding and cooperation as we work to provide you with the best tools and resources. If you need assistance with the upgrade process, please do not hesitate to reach out to our support team.

We greatly appreciate the community feedback provided. Please continue to let us know how v1.1.0 works and what features and enhancements you'd like to see next. Expect new features soon!