dhconfig schemas
The schemas configuration data type of the dhconfig tool is used to manage schemas in the system, with actions import, export, list, and delete.
As with other dhconfig configuration data types, the --help argument provides detailed information on the available actions and arguments, as well as usage examples. Use --help whenever you need more information about the available actions. For example, if you want information about the import action, you can run:
Which prints the following:
...followed by a description of all of the subcommand's arguments and some usage examples.
Due to the number of available actions and combinations, and the robust in-tool documentation via --help, an exhaustive list of all possible commands is not provided here. Instead, we will elaborate on some of the more complex arguments below, and then give some usage examples. We recommend that you use the --help argument as needed for more information.
Arguments
| Argument | Description |
|---|---|
-s,--namespaceset <arg> | Limit processing to this namespace set (User or System). Can be specified multiple times. |
-e,--skip-errors | Attempt to process all eligible schemas, even when errors are encountered. If omitted, processing stops at the first error. |
-l,--lenient-validation | It is possible that classes used in a schema are not available when reading a schema. This is a fatal error unless this option is specified. Validation can be disabled entirely by setting the property SchemaXmlParser.disableValidation=true. |
--no-compile | Do not compile listeners while importing a schema. This can be used to import schemas with apparent errors. Use with care: if the Data Import Server cannot compile the listeners, data cannot be ingested. |
-o,--operate-on-namespace | Operate on a namespace instead of a schema. |
import
Note
Import actions require authentication, with sudo, --key, or --user.
Deploy a (new) single schema:
Deploy a (new) single schema, skipping all data validation (use with care):
Deploy a (new) single schema directly to etcd, bypassing the configuration server:
Re-deploy the ExampleNamespace schemas:
export
Export all schemas in namespace DbInternal to /tmp/schemas:
Print a schema to stdout:
list
List all namespaces:
List all schemas in namespace DbInternal:
List all System schemas, bypassing configuration server (requires more file permissions):
delete
Note
Delete actions require authentication, with sudo, --key, or --user.
Delete MyTable1 and MyTable2 from namespace MyNamespace:
Delete namespace MyNamespace: