Manage Data Sources
This page details the immuta datasource
command, its subcommands and arguments, and the workflow for creating, renaming, and deleting data sources.
Command Overview: immuta datasource
immuta datasource
This command allows you to list, save, delete, and rename data sources in your instance of Immuta. The table below illustrates subcommands and arguments.
Subcommands | Description | Argument(s) |
---|---|---|
| List all data source connection keys. | n/a |
| List all data sources for a given connection key. |
|
| Create or update all specified data sources in Immuta given connection information to the remote database. |
|
| Delete all data sources for the given connection key. |
|
| Rename the data source connection key. |
|
Options
Use these options to get more details about the datasource
command or any of its subcommands:
-h
--help
Create a Data Source: immuta datasource save
immuta datasource save
Add your remote database's connection information in a valid YAML file for the V2 API. Additional payload examples for creating data sources can be found here:
Run
immuta datasource save <filepath> [--wait int] [--dryRun]
, referencing the file you just created. The options you can specify include-d
or--dryRun
: No updates will actually be made to the data source(s).-h
or--help
: Get more information about the command.-w
or--wait int
: Specify how long to wait for data source creation.
Example
The following example illustrates a user saving an updated datasourceInfo.yaml
file, first as a dry run and then by specifying that the data sources wait 5 seconds to be created.
Rename a Data Source Connection Key: immuta datasource rename
immuta datasource rename
Run
immuta datasource list keys
to view a list of data source connection keys. Options you can specify include-h
or--help
: Get more information about the command.-v
or--verbose
: Print response as JSON.
To rename one of your data source connection keys, run
immuta datasource rename <old connection key> <new connection key>
. You can include the-h
or--help
options to get more information about this command.
Example
The following example illustrates a user renaming a data source connection key to demonstration
.
Delete Data Sources: immuta datasource delete
immuta datasource delete
This command will delete all data sources for the connection key you specify.
Run
immuta datasource list keys
to view a list of data source connection keys. Options you can specify include-h
or--help
: Get more information about the command.-v
or--verbose
: Print response as JSON.
Opt to view a list of the data sources in this connection key by running
immuta datasource list sources <connection key>
.Run
immuta datasource delete <connection key> [--dryRun]
to delete all of these data sources. Options you can specify include-d
or--dryRun
: No updates will actually be made.-h
or--help
: Get more information about the command.
Example
The following example illustrates a user deleting the demonstration
connection key and all its data sources.