dap dropdb
Delete a synchronized table in a database
With the dap dropdb command, you can completely drop a table from your database that was previously created with dap initdb. An error is triggered if the given table does not exist in the target database.
This command not only drops the specified table from the target database but also removes meta-information used for synchronization.
Usage
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.
--connection-string <string>
The connection string used to connect to the target database. It must follow RFC 3986 format:
dialect://username:password@host:port/database. Skip, if DAP_CONNECTION_STRING environment variable is set.
Inherited Flags
-h, --help
Displays help information for the command.
Examples
Drop the courses table from your database
$ dap dropdb --namespace canvas --table courses
Same example with the connection string defined in the command
$dap dropdb --namespace canvas --table courses --connection-string postgresql://scott:password@server.example.com/testdb
Related Resources
Last updated