Skip to content

Commit

Permalink
change MAX-OPTS-FROM-MODULE to be kebab-case
Browse files Browse the repository at this point in the history
  • Loading branch information
hansenmc committed Jun 11, 2019
1 parent 1007d80 commit 8fa4dcc
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ Option | Description
**<a name="LOADER-USE-ENVELOPE"></a>LOADER-USE-ENVELOPE** | Boolean value indicating whether FileUris loaders should use an XML envelope, in order to send file metadata in addition to the file content.
**<a name="JOB-NAME"></a>JOB-NAME** | Name of the current Job.
**<a name="JOB-SERVER-PORT"></a>JOB-SERVER-PORT** | Optional port number to start a lightweight HTTP server which can be used to monitor, change the number of threads, and pause/resume the CORB job. Port number must be a valid port(s) or a valid range of ports. <ul><li>Ex: 9080</li><li> Ex: 9080,9083,9087</li><li> Ex: 9080-9090</li><li> Ex: 9080-9083,9085-9090</li></ul> The job server will bind to a port from the configured port number(s). By default, if the **JOB-SERVER-PORT** option is not specified, a job server is not started. <p> When a port is specified and available, the job server URL will be logged to the console with both the UI `http://<host>:<port>` and metrics URL `http://<host>:<port>/metrics`. (grep for string *com.marklogic.developer.corb.JobServer logUsage*) <p>The metrics URL supports the following parameters:<ul><li>**COMMAND**=pause (or resume). </li><li>**CONCISE**=true limits the amound of data returned</li><li>**FORMAT**=json (or xml) returns job stats in the requested format</li><li>**THREAD-COUNT**=<#> will adjust the number of threads for the executing job</li></ul>
**<a name="MAX_OPTS_FROM_MODULE"></a>MAX_OPTS_FROM_MODULE** | Default is 10. Max number of custom inputs from the **URIS-MODULE** to other modules.
**<a name="MAX-OPTS-FROM-MODULE"></a>MAX-OPTS-FROM-MODULE** | Default is 10. Max number of custom inputs from the **URIS-MODULE** to other modules.
**<a name="METADATA"></a>METADATA** | The variable name that needs to be defined in the server side query to use the metadata set by the **URIS-LOADER**.
**<a name="METADATA-TO-PROCESS-MODULE"></a>METADATA-TO-PROCESS-MODULE** | If this option is set to true, **XML-METADATA** is set as an external variable with name **METADATA** to **PROCESS-MODULE** as well. The default value for this option is false.
**<a name="METRICS-COLLECTIONS"></a>METRICS-COLLECTIONS** | Adds the metrics document to the specified collection.|
Expand Down
5 changes: 3 additions & 2 deletions src/main/java/com/marklogic/developer/corb/Options.java
Original file line number Diff line number Diff line change
Expand Up @@ -498,15 +498,16 @@ public final class Options {
/**
* Default is 10. Max number of custom inputs from the {@value #URIS_MODULE}
* to other modules.
* @since 2.4.5
*/
@Usage(description = "Default is 10. Max number of custom inputs from the URIS-MODULE to other modules.")
public static final String MAX_OPTS_FROM_MODULE = "MAX_OPTS_FROM_MODULE";
public static final String MAX_OPTS_FROM_MODULE = "MAX-OPTS-FROM-MODULE";

/**
* The variable name that needs to be defined in the server side query to use the metadata set by the {@value #URIS-LOADER}
*
* @see #@see #XML_METADATA
* @since 2.4.5
* @since 2.4.5
*/
@Usage(description = "The external variable name that needs to be defined in the server side query to use the metadata set by the URIS-LOADER")
public static final String METADATA = "METADATA";
Expand Down

0 comments on commit 8fa4dcc

Please sign in to comment.