dap snycdb
Synchronize data changes of a table to your database
Automatically retrieves incremental updates of a table, connects to your database, and applies these updates to the target table. This process is handled within a single atomic transaction, ensuring that, in case of an error, the data in your database remains consistent. Only tables that were created by initdb can be synchronized using syncdb.
The timestamp for performing incremental queries is stored in the dap_meta table, along with other metadata about synchronized tables. The dap_meta table is maintained by the DAP client library and should not be modified or dropped.
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.
--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
Get new or modified records of the courses table from the canvas namespace and insert into your database
$ dap syncdb --namespace canvas --table courses
Same example with the connection string defined in the command
$dap syncdb --namespace canvas --table courses --connection-string postgresql://scott:password@server.example.com/testdb
Related Resources
Last updated