Package: hdxcli
hdxcliis a command-line tool to work with hydrolix projects and tables
interactively.Common operations such as CRUD operations on projects/tables/transforms
and others  can be performed.Hdx-cli installationYou can installhdxclifrom pip:pipinstallhdxcliSystem RequirementsPython version>= 3.10is required.Make sure you have the correct Python version installed before proceeding
with the installation ofhdxcli.UsageCommand-line tool organizationThe tool is organized, mostly with the general invocation form of:hdxcli<resource>[<subresource...]<verb>[<resource_name>]Table and project resources have defaults that depend on the profile
you are working with, so they can be omitted if you previously used
thesetcommand.For all other resources, you can use--transform,--dictionary,--source, etc. Please see the command line help for more information.Profileshdxclisupports multiple profiles. You can use a default profile or
use the--profileoption to operate on a non-default profile.When trying to invoke a command, if a login to the server is necessary,
a prompt will be shown and the token will be cached.Listing and showing profilesListing profiles:hdxcliprofilelistShowing default profile:hdxcliprofileshowProjects, tables and transformsThe basic operations you can do with these resources are:list themcreate a new resourcedelete an existing resourcemodify an existing resourceshow a resource in raw json formatshow settings from a resourcewrite a settingshow a single settingWorking with transformsYou can create and override transforms with the following commands.Create a transform:hdxclitransformcreate-f<transform-settings-file><transform-name>Remember that a transform is applied to a table in a project, so whatever
you set with the command-line tool will be the target of your transform.If you want to override it, do:hdxcli--project<project-name>--table<table-name>transformcreate-f<transform-settings-file>.json<transform-name>IngestBatch JobCreate a batch job:hdxclijobbatchingest<job-name><job-settings>.jsonjob-nameis the name of the job that will be displayed when listing batch
jobs.job-settingsis the path to the file containing the specifications
required to create that ingestion (for more information on the required
specifications, see Hydrolix API Reference).In this case, the project, table, and transform are being omitted and the
CLI will use the default transform within the project and table previously
configured in the profile with the--setcommand. Otherwise, you can add--project <project-name>, --table <table-name> --transform <transform-name>.This allows you to execute the command as follows:hdxcli--project<project-name>,--table<table-name>--transform<transform-name>jobbatchingest<job-name><job-settings>.jsonCommandsProfilelisthdxcli profile listaddhdxcli profile add <profile-name>showhdxcli --profile <profile-name> profile showSet/Unsetsethdxcli set <project-name> <table-name>unsethdxcli unsetProjectlisthdxcli project listcreatehdxcli project create <project-name>deletehdxcli project delete <project-name>activityhdxcli --project <project-name> project activitystatshdxcli --project <project-name> project statsshowhdxcli --project <project-name> project showsettingshdxcli --project <project-name> project settingshdxcli --project <project-name> project settings <setting-name>hdxcli --project <project-name> project settings <setting-name> <new-value>TableTransformJobPurgejobsSourcesDictionaryDictionary FilesFunctionStorageIntegrationMigrateVersionFAQ: Common operationsShowing helpIn order to see what you can do with the tool:hdxcli--helpCheck which commands are available for each resource by typing:hdxcli[<resource>...][<verb>]--helpPerforming operations against another serverIf you want to usehdxcliagainst another server, use--profileoption:hdxcli--profile<profile-name>projectlistObtain indented resource informationWhen you use the verbshowon any resource, the output looks like this:hdxcli--project<project-name>projectshow{"name":"project-name","org":"org-uuid","description":"description","uuid":"uuid",...}If you need to have an indented json version, just add-i,--indent int:hdxcli--project<project-name>projectshow-i4{"name":"project-name","org":"org-uuid","description":"description","uuid":"uuid",...,}