Dgraph flags

The Dgraph program starts the MDEX Engine.

You start the MDEX Engine by running a program called Dgraph, which you point at a set of indices prepared by the Dgidx. The Dgraph has a number of options that allow you to adjust the MDEX Engine. For example, you can tweak spelling, caching, and so forth.

The usage of Dgraph is as follows: 
dgraph [-?Adv] [--flags] <db_prefix>
where <db_prefix> specifies the path to the directory, and the prefix used for the files in your Endeca application.
Flag Description
? Print the help message and exit.
-A Deprecated. Disallow server shutdown and restart operations through admin?op=exit and admin?op=restart URL commands sent to the Dgraph.
-d Start in debug mode.
-v Verbose mode. Print information about each request to stdout.
--ancestor_counts Compute counts for root dimension values and any intermediate dimension value selections. By default, the Dgraph only computes refinement counts for proper refinements (in other words, for actual refinement dimension values). It does not compute counts for root dimension values or for any intermediate dimension value selections.
--back_compat <api-version> Enable backwards compatibility, so that the Dgraph can communicate with previous versions of the Presentation API. In addition to the currently supported version of the Presentation API, the following previous full versions are supported: 6.0.x, 5.1.x, 5.0.x and 4.8.x. Therefore, the value for <api-version> must be one of the following:
  • 601 for all 6.0.x versions of the API.
  • 510 or 500 for all corresponding versions of the API, 5.1.x and 5.0.x.
  • 480 for the 4.8.x versions of the API, including the Perl API.
Note: Starting with version 6, the Endeca Presentation API is part of the Platform Services package. For the version of the Platform Services that is compatible with the current version of the MDEX Engine, see the MDEX Engine Installation Guide.
--backlog-timeout <seconds> Specify the wait limit (in seconds) for a query that has been read and queued for processing. This is the maximum number of seconds that a query is allowed to spend waiting in the processing queue before the Dgraph responds with a timeout message. The default value is 60 seconds.
--cmem <MB> Specify the maximum memory usage in MB for the MDEX Engine main cache. When --cmem is not specified, the default value is 1024 MB (1GB), for Dgraph installations on 64-bit platforms.
--config <path> Specify a configuration file to read on startup. The configuration file should contain arguments of the same format used on the command line (that is, it ignores whitespace, including newlines).
--deadends Deprecated. The MDEX Engine ignores this flag if it is specified.
--diacritic-folding Ignore character accents when processing search requests. For details about how characters with diacritical marks are mapped to their ASCII equivalents, see the MDEX Engine Basic Development Guide.
--disable_fast_aspell Disable fast mode for the aspell spelling module. If you disable fast mode, it decreases the performance of the spelling correction, but may allow additional queries to be corrected.

When the fast mode is enabled, it can significantly speed up applications that use spelling correction features with the aspell module. The fast mode is used by default.

--disable_web_services Suppress the automatic loading of XQuery modules at startup.
--dtag <data-tag> Specify the data tag to send with all result XML objects. The default is to use db_prefix as the data tag.
--dym Enable DYM (Did You Mean?) explicit query spelling suggestions for full-text search queries.
--dym_hthresh <thresh> Specify the threshold number of hits at or above which DYM (Did You Mean?) suggestions will not be generated. The default is 20.
--dym_nsug <count> Specify the maximum number of DYM (Did You Mean?) query suggestions to return for any query. The default is 1.
--dym_sthresh <thresh> Specify the threshold spelling correction score for words used by the DYM (Did You Mean?) engine. The default is 175.
--dynrank_consider_collapsed Use this flag to force the MDEX Engine to consider intermediate collapsible dimension values as candidates for dynamic ranking.

This flag alters the default behavior of the MDEX Engine when dynamically ranking dimensions with collapsible dimension values. By default (without this flag specified), the MDEX Engine considers only leaf dimension values for dynamic ranking, removing all intermediate dimension hierarchy from consideration.

With the default behavior, when a hierarchical dimension's mid-level values (all except the root and leaf values) are configured as collapsible in Developer Studio, and when the dimension is also set to use dynamic refinement ranking, the dimension collapses and displays only leaf values for all navigation queries. The mid-level dimension values are never displayed regardless of the number of leaf values present in the navigation state.

If you would like the MDEX Engine to consider intermediate dimension values (that are configured as collapsible) for dynamic ranking, use this flag.

--esampmin <num> Specify the minimum number of records to sample during refinement computation. The default is 0. Tuning recommendations:
  • For most applications, larger values reduce performance without improving dynamic refinement ranking quality.
  • For some applications with extremely large, non-hierarchical dimensions (if they cannot be avoided), larger values can meaningfully improve dynamic refinement ranking quality with minor performance cost.
--ethresh <num> Deprecated.
--explicit_no_keep_alive Deprecated. If specified, triggers a deprecation warning but is otherwise ignored.
--failedupdatedir <dir> Specify the directory into which the MDEX Engine should save the failed update files.

The default directory that the MDEX Engine uses for storing the failed update files is <updatedir>/failed_updates/.

--help Print the help message and exit.
--implicit_exact Deprecated. The MDEX Engine ignores this flag if it is specified.
--implicit_sample Deprecated. The MDEX Engine ignores this flag if it is specified.
--lang <lang-id> Assume all queries are in the specified language. The default is en (US English).
--latin1 Deprecated. Ignore character accents when handling search requests, and use ISO Latin 1 character mappings when processing search requests.
--log <path> Specify the path for the Dgraph request log file. The default log file is named dgraph.reqlog.
--log_stats <path> Specify the path and filename for the EQL (Endeca Query Language) statistics log. By default, this log is turned off; specifying this flag activates logging of statistics for EQL requests.
--log_stats_thresh <value> Set the threshold above which statistics information for an Endeca Query Language request will be logged. The value is specified in milliseconds (1000 milliseconds = 1 second). The value can also be specified in seconds by adding a trailing s to the number, such as 1s for 1 second. The default is 60000 milliseconds (1 minute). Note that this flag is dependent on the --log_stats flag being used.
--memusage Deprecated . The MDEX Engine ignores this flag if it is specified.
--mergepolicy <policy> Set the default merge policy of the MDEX Engine for partial updates. The value for <policy> must be either balanced or aggressive. If this flag is not used, balanced will be the default merge policy. For details on the merge policy, see the Partial Updates Guide.
--net-close-timeout Deprecated. Prior to version 6.1, this flag set the default maximum wait time (in seconds) for client connection shutdown. The MDEX Engine now uses the FIN_WAIT_2 timeout interval to set the number of seconds that the HTTP server waits after sending the response for the client to close down its end of the socket. If this timeout expires, the server forcibly shuts down the connection. The default value varies by operating system: for Linux it is 60s; for Solaris, it is 675000ms; and for Windows it is 240s. For details on changing the default value in your operating system, see the Performance Tuning Guide.
--net-timeout Specify the maximum number of seconds the Dgraph waits for the client to download data from queries across the network. The default network timeout value is 30 seconds.
--noctrct

Do not return information about implicit dimensions with node results, when displaying refinements in navigation results.

This flag lets you optimize performance for applications where it is not necessary to present the implicit dimensions to the users in navigation results. If you specify this flag, the MDEX Engine still computes the implicit dimensions with node results, but they are not included in the navigation results that are displayed to the users.

--nomrf Disable filtering for dynamic business rules.
--out <stdout/stderr file> Specify file path to which stdout/stderr should be remapped (the default is to use default stdout/stderr for the process).

Running the Dgraph in an Endeca Application Controller environment creates a default file named dgraph-S0-R0.out.

--pcmem Deprecated. The MDEX Engine ignores this flag if it is specified.
--persistdir Direct the Dgraph audit persistence file to a directory of your choice. By default, the file is written to a directory called persist that is located in the application’s working directory. For details about the audit persistence file, see the Endeca Performance Tuning Guide.

Important: Use the --persistdir flag only when you first start the Dgraph. Do not move or rename this directory after it has been created.

--phrase_max <num> Specify the maximum number of words in each phrase for text search. The default number is 10. If the maximum number of words in a phrase is exceeded, the phrase is truncated to the maximum word count and a warning is logged.
--pidfile <pidfile-path> Specify the file to which to write the process ID (pid). If unspecified, the default name of the pid file depends on how the Dgraph starts.

Running the Dgraph in a Control System environment or from the command line creates a default named dgraph.pid. Running the Dgraph in an Endeca Manager environment creates a default named dgraph-S0-R0.pid.

--port <num> Specify the port to use in server (non-interactive) mode. The default is 5555.
--search_max <num> Specify the maximum number of terms for text search. Default is 10.
--snip_cutoff <num> Limit the number of words in a property that the MDEX Engine evaluates to identify the snippet. If a match is not found within <num> words, the MDEX Engine does not return a snippet, even if a match occurs later in the property value.

If the flag is not specified, or <num> is not specified, the default is 500.

--snip_disable Globally disable snippeting.
--spellpath <path> Specify location of spelling data files. Parameter should be a full path to a directory containing the needed aspell support files for spelling correction features (see the --dym and --spl options). Note that this path must be an absolute path (relative paths are not supported). In addition, this is a path to a directory containing at least the generic pspell/aspell support files. This does not need to be the same as the location of the .spelldat file for the indexed data set. The Dgraph typically requires write permissions in this directory, unless a correct or writable .pwli file is already available in this directory.
--spell_bdgt <num> Set maximum number of variants considered for spelling and DYM (Did You Mean?) correction (the default is 32).
--spell_glom Allow cross-property suggestions, and count cross-property matches when evaluating the frequencies of suggestions. Normally, suggestions must match results in a single property value.
--spell_nobrk Disable word-break analysis in the suggestion engine. Normally, in addition to considering spelling corrections, the suggestion engine considers alternate word separation points for the query to generate suggestions for DYM (Did You Mean?) and auto-correct.
--spl Enable auto-suggest spelling corrections for record (full text) and dimension search.
--spl_hthresh <thresh> Specify the minimum number of hits at or above which auto-correct suggestions will not be generated. The default is 1, meaning that if there are one or more hits for a user’s search, then auto-correct does not provide spelling suggestions. Stated differently, if you use the default of 1 and there are zero (0) hits for a user’s search, then spelling auto-correct does engage and provides suggestions for alternate keyword spellings.
--spl_nsug <count> Specify the maximum number of auto-correct suggestions to return. The default is 1.
--spl_sthresh <thresh> Specify the threshold spelling correction score for words used as auto-correct suggestions. The default is 125.
--sslcertfile <certfile-path> Specify the path of the eneCert.pem certificate file that will be used by the Dgraph to present to any client for SSL communications. Using this flag provides the certificate which the MDEX Engine presents to the client for SSL; this option also forces HTTPS connections rather than HTTP. If not given, SSL is not enabled for Dgraph communications.
--sslcafile <CA-certfile-path> Specify the path of the eneCA.pem Certificate Authority file that the Dgraph will use to authenticate SSL communications with other Endeca components. This flag defines the Certificate Authority file the MDEX Engine uses to validate client connections for mutual authentication purposes. If not given, SSL mutual authentication is not performed.
Note: If you need to establish a secure but not authenticated connection, use the --sslcertfile flag without the --sslcafile flag.
--sslcipher <cipher-list> Set one or more cipher names (such as RC4-SHA) that specify the minimum cryptographic algorithm that the Dgraph will use during the SSL negotiation. If multiple ciphers are specified, the names must be separated by colons.
--stat-all Enable all available dynamic dimension value attributes. Note that this option has performance implications and is not intended for production use.
--stat-abins Enable refinement counts for aggregated records. A refinement count is the number of records that would be in the result set if you were to refine on a dimension value. An aggregated record is a record that represents several records that are rolled up into a single record for display purposes.

If you use this flag, the refinement counts reflect how many aggregated records the MDEX Engine would return in a result set if you were to refine on a dimension value.

In general, the MDEX Engine calculates refinement counts as follows:
  • When returning regular (non-aggregated) record results, the MDEX Engine calculates refinement counts per refinement. (You enable refinement counts in Developer Studio.) The refinement counts for regular records are returned by the MDEX Engine as the Dgraph.Bins property.
  • When returning aggregated record results, the --stat-abins flag lets the MDEX Engine return the refinement counts for aggregated records. These counts accurately reflect the number of aggregated records per refinement. (You enable refinement counts for aggregated records by using this flag.) The refinement counts for aggregated records are returned by the MDEX Engine as the Dgraph.AggrBins property.

Note that dynamic statistics on aggregated records is an expensive computation for the MDEX Engine. Use this flag only if you intend to display the refinement counts for aggregated records in your front-end application.

--stat-bins-cutoff <num> Deprecated. Set the cutoff for record counts. Once there are this many records associated with a refinement dimension value, the record count algorithm stops and returns this number or a number higher than it.
--stat-bins-thresh <thresh> Deprecated. Set the threshold for the maximum number of records above which the MDEX Engine stops computing record counts. By default, the MDEX Engine returns refinement counts for records with no threshold.
--stat-brel Create dynamic record attributes indicating the relevance rank assigned to fulltext search result records.
--stat-rel Create dynamic dimension value attributes indicating the relevance ranking score (for dimension value search results).
--syslog Direct all output to syslog.
--thesaurus_cutoff <limit> Set a limit on the number of words in a user’s search query that are subject to thesaurus replacement.

The default value of <limit> is 3. This means that up to 3 words in a user’s search query can be replaced with thesaurus entries. If there are more terms in the query that match thesaurus entries, none of the words are thesaurus expanded.

This option is intended as a performance guard against very expensive thesaurus queries. Lower values improve thesaurus engine performance.

--thesaurus_multiword_nostem Specify that words in a multiple-word thesaurus form should be treated like phrases and should not be stemmed, which increases performance for some query loads. Single-word terms will be subject to stemming regardless of whether this flag is specified.

This flag prevents the Dgraph from expanding multi-word thesaurus forms by stemming. Thesaurus entries continue to match any stemmed form in the query, but multi-word expansions only include explicitly listed forms. To get the multi-word stemmed thesaurus expansions, the various forms must be listed explicitly in the thesaurus.

--threads <num> Specify the number of threads in the MDEX Engine threading pool. The default is 1 (multithreaded mode). The multithreaded mode cannot be disabled.

The recommended number of threads for the MDEX Engine is typically equal to the number of cores on the MDEX Engine server.

If you specify a value greater than 0, the Dgraph runs the specified number of threads for processing client requests (queries and partial updates), and other CPU-intensive operations related to query processing. The MDEX Engine prioritizes tasks assigned to threads in its threading pool.

Note: If the specified value is 0, the Dgraph interprets it as 1 and still runs in multithreaded mode with the number of threads in its threading pool set to 1.

Additional threads are also started to perform internal maintenance tasks that are less CPU-intensive and do not affect query processing or updates (their number cannot be controlled).

--tmpdir <dir> Specify the path to a temporary directory to be used to hold temporary files (the default is the base directory of db_prefix).
--unctrct Specify to the Dgraph not to compute implicit dimensions, and to only compute and present explicitly specified dimensions, when displaying refinements in navigation results. Specifying this flag does not reduce the size of the resulting record set that is being displayed; however, it improves run-time performance of the MDEX Engine.

Be aware that if you use this flag, in order to receive meaningful navigation refinements, you need to make top-level precedence rules work for ALL outbound queries.

--updatedir <dir> Specify the directory into which completed partial update files will be placed. Partial update files are also read from this directory.
--updatelog Specify the file for update-related log messages. If unspecified, the default name of the update file depends on how the Dgraph starts. Running the Dgraph in a Control System environment (deprecated) or from the command line creates a default named dgraph.updatelog. Running the Dgraph in an Endeca Application Manager environment creates a default named dgraph-S0-R0-update.log.
--updateverbose Show verbose messages while processing updates.
--validate_data Validate that all indexed data loads and then exit.
--version Print version information and exit.
--wb_maxbrks

In word-break analysis, specify the maximum number of breaks to insert or remove per query. The default is 1.

--wb_minbrklen In word-break analysis, specify the minimum length of a new word-break term. The default is 2.
--wb_noibrk In word-break analysis, disable word-break insertion analysis.
--wb_norbrk In word-break analysis, disable word-break removal analysis.
--wildcard_approx <mode> Deprecated. The MDEX Engine ignores this flag.
--wildcard_max <count> Specify the maximum number of terms that can match a wildcard term in a wildcard query that contains punctuation, such as ab*c.def*. The default is 100.
--whymatch Enable computation of "Why Did It Match" dynamic record attributes returned as results of full-text search queries. These dynamic attributes contain a copy of the property/dimension key and value that caused the match, along with query interpretation notes (spelling, thesaurus, and so on).
--whymatchConcise Similar to --whymatch, but produces more concise dynamic attribute values containing only the property/dimension key and query interpretation notes. This is useful when the property value might include large amounts of text, such as document contents.
--wordinterp Enable computation of word interpretation dynamic supplement (or see-also) objects, which report on alternate forms of user query terms considered by the text search engine while processing full-text (record) search requests.
--ws Deprecated. The MDEX Engine ignores this flag and issues a warning if it is specified.
--xquery_fndoc <mode> Specifies the handling of the fn:doc() function within XQuery. The following three values are supported:
  • none causes all calls to fn:doc() to fail.
  • sandbox allows fn:doc(), but interprets its argument as a relative path within the XML subdirectory of the XQuery service directory.
  • open allows fn:doc() and interprets its argument as a URL.

If not specified, defaults to none. Note that open is not supported for use in deployed applications.

--xquery_path <path> Specify the directory in which XQuery Web service resources are located. XQuery main modules and WSDL files are loaded from this directory. Library modules are loaded from the lib subdirectory. If not specified, a user XQuery path is not used.