dap schema
Retrieve the schema of a table.
This command downloads the schema of a specific table within a specified namespace in JSON format.
Usage
Arguments
--base-url <string>
URL to the DAP API endpoint. Use https://api-gateway.instructure.com.
--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.
--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 tables from the canvas namespace
$ dap schema --namespace canvas --table courses
Related Resources
Last updated