This page details the immuta project
command, its subcommands and arguments, and the workflow for creating, renaming, and deleting projects.
immuta project
This command allows you to list, save, delete, and rename projects in your instance of Immuta. The table below illustrates subcommands and arguments.
Use these options to get more details about the project
command or any of its subcommands:
-h
--help
immuta project save
Add your project information in a valid YAML file for the V2 API. Additional payload examples for creating projects can be found here:
Run immuta project save <filepath> [--dryRun] [--deleteWorkSpaceDataSources]
, referencing the file you just created. The options you can specify include
--deleteWorkSpaceDataSources
: Delete all data and the data sources associated with a project workspace when the workspace is deleted.
-d
or --dryRun
: No updates will be made.
-h
or --help
: Get more information about the command.
The example below illustrates a user listing all projects and then creating the project demo project
.
immuta project rename
Opt to list all project keys to identify which project you would like to rename by running immuta project list
. Options you can specify include
-h
or --help
: Get more information about the command.
-v
or --verbose
: Print response as JSON.
Rename the project key by running immuta project rename <old project key> <new project key>
, enclosing the name of the project key in quotation marks. Options you can specify to get more information about this command include -h
or --help
.
The example below illustrates a user renaming the demo project
project key to data analytics team
.
immuta project delete
Opt to list all project keys to determine which project key you would like to delete by running immuta project list
. Options you can specify include
-h
or --help
: Get more information about the command.
-v
or --verbose
: Print response as JSON.
Delete a project key by running immuta project delete <project key> [--dryRun] [--hardDelete
, enclosing the project key in quotation marks. Options you can specify include
-d
or --dryRun
: No updates will be made.
--hardDelete
: If this is set, it will delete everything related to the project in Immuta. If not set, it will only disable the project.
-h
or --help
: Get more information about the command.
The example below illustrates a user first disabling and then deleting the project Data Analytics Team
.
Subcommands | Description | Argument(s) |
---|---|---|
delete
Delete a project by project key.
project key
list
List all project keys.
n/a
rename
Rename the project key.
new project key
save
Create or update a project in Immuta.
filepath