dap schema

Download the schema of a table.

This command generates and downloads the schema of a specific table within a specified namespace in JSON format.

Usage

dap [arguments] list [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 tables whose schemas to fetch. Can be a single table name, a comma separated list of table names or the special all keyword to fetch all tables in the namespace.

--output-directory <string> (default: downloads) 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 schema of courses and users tables from the canvas namespace: $ dap schema --namespace canvas --table courses,users

Get schema of all tables from the canvas namespace: $ dap schema --namespace canvas --table all

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.