Default data domain profile

This topic lists parameters for the default data domain profile used for single-node data domain deployments hosted by a single Endeca Server instance.

The Endeca Server cluster uses the default data domain profile to support faster deployments of simplified data domains in a development environment. The default data domain profile lets you create a data domain in a single-node Endeca Server instance. If you start a data domain using the default profile, you can later expand the Endeca Server cluster by adding Endeca Server instances and adding a shared file system. You can then export this data domain (thus saving its index), and then import it into an Endeca Server cluster, while adjusting its other characteristics, to ensure you can run it in the production environment. For information on installing and deploying an Endeca Server cluster, see the Oracle Endeca Server Installation Guide.

To list the details of the default data domain profile, use the listDataDomainProfile operation from the Cluster Web Service, or the equivalent endeca-cmd get-dd-profile command.

Note: This profile always exists in the system and cannot be deleted with the deleteDataDomainProfile operation or with the equivalent endeca-cmd delete-dd-profile command.

The following table lists the default data domain profile parameters as they are returned by the Cluster Web Service. The endeca-cmd get-dd-profile command returns equivalent parameters. The command has no options, just the profile name as the argument (default).

Parameter Type Default
name string The name is default.
description string The default system data domain profile.
allowQueriesOnLeader boolean The default is true. The leader node should handle non-updating query load in addition to handling updating queries.
numFollowers integer The default is 0. This profile creates a data domain with only one node that handles all types of requests (updating and non-updating requests).

The number is 0, because the only node in this data domain is a single leader node. This node is created automatically, unlike follower nodes whose number may vary.

allowOversubscribe boolean The default is true. This means that each Dgraph node in the data domain will request its configured number of processing threads from the Endeca Server nodes even if the hosting Endeca Server nodes may not have sufficient CPU.
numComputeThreads integer The default is 2. The number of threads allocated to each Dgraph process (known as the Dgraph node) serving the data domain.
computeCacheSizeMB integer The default is 0 MB. The amount of RAM to allocate to the result cache on each Dgraph node in the data domain.

The default of 0 is interpreted as follows. When an absolute value is 0, the default Dgraph cache size is computed as 10% of the amount of RAM available on the Endeca Server node hosting the Dgraph node.

startupTimeoutSeconds integer The default is 600 seconds. The time, in seconds, it takes the Dgraph process to start up.
shutdownTimeoutSeconds integer The default is 30 seconds. The time, in seconds, it takes the Dgraph process to shut down.
sessionIdType string The default is HEADER. The method used for establishing session affinity when routing requests to the appropriate data domain hosted by the Endeca Server cluster.
sessionIdKey string The default is X-Endeca-Session-ID. The name of the object that is checked by the session affinity method.
readOnly boolean Indicates whether the Dgraph node is read-only (and thus can only process read-only requests to the data domain's index). The default is false.
args string No flags are specified for the Dgraph in the default data domain profile.

Example of the default data domain profile

If you issue the request getDataDomainProfile using the Cluster Web Service at the URL similar to the following: http://host:7001/endeca-server/ws/cluster, and specify default as the profile's name, the default data domain profile is returned in the response.

This example of the response omits web service namespaces. This example also assumes that the WebLogic Server uses the default port 7001, that host is the hostname of the Endeca Server, and endeca-server is the default root context of the Endeca Server Java application running in the WebLogic Server container:

<dataDomainProfile>
    <name>default</name>
    <description>The default system data domain profile</description>
    <allowQueriesOnLeader>true</allowQueriesOnLeader>
    <numFollowers>0</numFollowers>
    <readOnly>false</readOnly>
    <allowOversubscribe>true</allowOversubscribe>
    <numComputeThreads>2</numComputeThreads>
    <computeCacheSizeMB>0</computeCacheSizeMB>
    <startupTimeoutSeconds>600</startupTimeoutSeconds>
    <shutdownTimeoutSeconds>30</shutdownTimeoutSeconds>
    <sessionIdType>HEADER</sessionIdType>
    <sessionIdKey>X-Endeca-Session-ID</sessionIdKey>
</dataDomainProfile>