CD2 Complete Newbie Doc?

Jump to solution
Community Participant

Hello Friends-

HEY! I made my own CD2 documentation. I added it to the new CD2 Community G Drive folder.

I am not a coder or dba. The existing CD2 documentation gets me to the point where I can run the cli on my Mac and get a list of tables, and then it stops. The Postman doc gets me making api calls, but not downloading any data.

I set up a postgres database, and I want to know how to hook up CD2 to it. If someone would like to help me, I'd be happy to write the instructions for others (I'm a technical writer). It seems unlikely that I'm the only Canvas admin without experience with this.

Labels (2)
2 Solutions

I would strongly recommend that you check out the official Python client library. It takes most of the work off your shoulder.

In order to retrieve data by interacting with DAP API endpoints directly, you must first start a query job by invoking the API endpoint{namespace}/table/{table}/data

This is an asynchronous call; it will trigger the job but the job will take time to process. You can monitor the status by invoking the status endpoint. Once the job is complete, it returns a series of object IDs. You will need to exchange these object IDs to pre-signed URLs with URL exchange endpoint. Finally, you need to download the files that the pre-signed URLs point to with plain HTTP file download.

DAP API returns full table dumps for a single root account. There is no API for passing row-level filters.

If you think the process is complicated, I agree. This is why we have created the DAP client library, which has the commands snapshot and incremental to do all these steps for you.

View solution in original post

Community Participant

OK FINE! I made my own.

Alex's Simplified CD2 Documentation

It says "Draft" at the top, because, you know, nothing is ever really done. There are no warrantees expressed or implied, yadda, yadda, yadda. But it should get you going.

It's OK, I'm a real technical writer. No animals were harmed in the making of these instructions.

Please let me know if you find any mistakes, or if it helps. 

View solution in original post