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

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

--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

Drop all locally present tables of the namespace from your database: $ dap dropdb --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.