dap snapshot

Download a complete snapshot of a table.

The dap snapshot command generates and download a full snapshot of a dataset at a specific point in time. This is ideal for creating an initial full copy of the dataset or performing occasional full updates. Snapshots are useful for comprehensive analyses, audits, and backups.

Regular use of snapshots is not recommended, as they are resource-intensive for the API and costly to process on the client side.

Usage

dap [arguments] snapshot [flags]

Arguments

--base-url <string> URL to the DAP API endpoint: https://api-gateway.instructure.com. Skip, if DAP_API_URL environment variable is set.

--client-id <string> Client ID obtained from the Identity Service. Skip, if DAP_CLIENT_ID environment variable is set.

--client-secret <string> Client Secret obtained from the Identity Service. Skip, if DAP_CLIENT_SECRET environment variable is set.

Flags

--namespace <string> Specifies the data source (namespace). Available options: {canvas, canvas_log, catalog}.

--table <string> Specifies the table fetch data from.

--format <string> (default: JSONL) Defines the output format. Available options: {CSV, JSONL, Parquet, TSV}.

--output-directory <string> Specifies the absolute or relative path to the output directory where the snapshot will be stored.

Inherited Flags

-h, --help Displays help information for the command.

Examples

Get a snapshot of the courses table from the canvas namespace: $ dap snapshot --namespace canvas --table courses

Get a snapshot of the web_logs table from canvas_log namespace in CSV format $ dap snapshot --namespace canvas_logs --table web_logs --format csv

Related Resources

Key Concepts

Get familiar with the key concepts in DAP.

Rate Limits & Policies

Learn more about the limits and our policies in DAP.

Datasets

Discover the available namespaces and tables.