Audience: Data Owners and Governors
Content Summary: This page details the
immuta datasource
command, its subcommands and arguments, and the workflow for creating, renaming, and deleting data sources.
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.
Use these options to get more details about the datasource
command or any of its subcommands:
-h
--help
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.
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.
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.
The following example illustrates a user renaming a data source connection key to demonstration
.
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.
The following example illustrates a user deleting the demonstration
connection key and all its data sources.
Subcommands | Description | Argument(s) |
---|---|---|
list keys
List all data source connection keys.
n/a
list sources
List all data sources for a given connection key.
connection key
save
Create or update all specified data sources in Immuta given connection information to the remote database.
filepath
delete
Delete all data sources for the given connection key.
connection key
rename
Rename the data source connection key.
connection key