# Module: dataDirectorate

Contains all of the data directorate commands.

Author:
  - Seth Hollingsead
Copyright:
  - Copyright © 2022-… by Seth Hollingsead. All rights reserved
Source:
  - commandsBlob/commands/dataDirectorate.js, line 1

### Requires

- module:dataBroker
- module:ruleBroker
- module:configurator
- module:loggers
- module:data
- @haystacks/constants
- path

### Methods

#### (inner) changeSetting(inputData, inputMetaData) → {array.<boolean, (string|integer|boolean|object|array)>}

This command changes a setting in the D data structure, given a namespace, property name and value.

##### Parameters:

Name | Type | Description
--- | --- | ---
`inputData` | array.<string> | An array that contains the fully qualified path to the setting that should be changed and the data that should be assigned to it. inputData[0] = changeSetting inputData[1] = fully.Qualified.Path inputData[2] = value to assign to the data property
`inputMetaData` | string | Not used for this command.

Author:
  - Seth Hollingsead
Source:
  - commandsBlob/commands/dataDirectorate.js, line 233

##### Returns:

An array with a boolean True or False value to indicate if the application should exit or not exit, followed by the command output.

Type
  array.<boolean, (string|integer|boolean|object|array)>

#### (inner) clearDataStorage(inputData, inputMetaData) → {array.<boolean, (string|integer|boolean|object|array)>}

Completely wipes out all the data stored in the DataStorage data hive of the D data structure.

##### Parameters:

Name | Type | Description
--- | --- | ---
`inputData` | array.<(boolean|string|integer)> | An array that could actually contain anything, depending on what the user entered. But the function filters all of that internally and extracts the case the user has entered a data storage name to clear. If none is provided, the all data storage will be cleared! inputData[0] === 'clearDataStorage' inputData[1] === myDataStorage
`inputMetaData` | string | Not used for this command.

Author:
  - Seth Hollingsead
Source:
  - commandsBlob/commands/dataDirectorate.js, line 200

##### Returns:

An array with a boolean True or False value to indicate if the application should exit or not exit, followed by the command output.

Type
  array.<boolean, (string|integer|boolean|object|array)>

#### (inner) printDataHive(inputData, inputMetaData) → {array.<boolean, (string|integer|boolean|object|array)>}

Prints out all the data contents of a particular data hive in the D-data structure. If no hive is specified then the entire D-data structure will be printed.

##### Parameters:

Name | Type | Description
--- | --- | ---
`inputData` | array.<(boolean|string|integer)> | An array that could actually contain anything, depending on what the user entered. But the function filters all of that internally and extracts the case the user has entered a dat hive name at the top level of the D-data structure. Examples: Configuration, Workflows, Colors, cCommandAliases, etc... inputData[0] === 'printDataHive' inputData[1] === dataHiveName
`inputMetaData` | string | Not used for this command.

Author:
  - Seth Hollingsead
Source:
  - commandsBlob/commands/dataDirectorate.js, line 32

##### Returns:

An array with a boolean True or False value to indicate if the application should exit or not exit, followed by the command output.

Type
  array.<boolean, (string|integer|boolean|object|array)>

#### (inner) printDataHiveAttributes(inputData, inputMetaData) → {array.<boolean, (string|integer|boolean|object|array)>}

Prints out all of the attributes for a given specified data-set from the D-data structure.

##### Parameters:

Name | Type | Description
--- | --- | ---
`inputData` | array.<(boolean|string|integer)> | An array that could actually contain anything, depending on what the user entered. But the function filters all of that internally and extracts the case the user has entered a data hive or leaf data structure in the hierarchy and a name of an attribute where all values should be printed. Examples ConstantsValidationData.ColorConstantsValidation.Actual inputData[0] === 'printDataHiveAttributes' inputData[1] === ConstantsValidationData.ColorConstantsValidation.Actual
`inputMetaData` | string | Not used for this command.

Author:
  - Seth Hollingsead
Source:
  - commandsBlob/commands/dataDirectorate.js, line 104

##### Returns:

An array with a boolean True or False value to indicate if the application should exit or not exit, followed by the command output.

Type
  array.<boolean, (string|integer|boolean|object|array)>