System Settings Reference

This topic provides reference information for each of the AnzoGraph DB system configuration settings. The configuration file, <install_path>/config/settings.conf, categorizes the settings as either Basic or Advanced. The advanced-level settings should only be configured by system administrators or users with an advanced level of knowledge about AnzoGraph DB or databases in general. For instructions on changing settings, see Change System Settings.

Basic Settings

This section describes the settings in the Basic section of settings.conf.

Setting Default Value (type) Description
anzo_protocol_port 5700 (int) The Anzo protocol (gRPC) port for secure communication between AnzoGraph DB and other Cambridge Semantics' applications.
auto_restart_directory Not set (char) Specifies the base location of the auto_restart directory, which contains the denied_list, warned_list, and unanalyzed_list directories. When not set, the default is <install_path>/internal. For more information about the auto-restart feature, see Manage Automatic Database Restart Options.
enable_persistence true (boolean) Controls AnzoGraph DB's save data to disk option. By default, persistence is enabled and the data in memory is saved to disk (in the persistence_directory) after every transaction. Each time the database is restarted, the persisted data is automatically loaded back into memory. When persistence is disabled, data must be reloaded back into memory when the database is restarted.
enable_sparql_protocol true (boolean) This setting controls whether to enable the standard SPARQL-compliant HTTP endpoint. The sparql_protocol_port setting controls the port to use to access the endpoint. The SPARQL HTTP endpoint is not secured.
enable_ssl_protocol true (boolean) This setting controls whether to enable the secure HTTPS SPARQL endpoint. The ssl_protocol_port setting controls the port to use. The SPARQL HTTPS endpoint is encrypted but not authenticated.
internal_directory Not set (char) The directory where AnzoGraph DB should save internal database-related files such as generated code, logs, and query plans. When not set, the default is <install_path>/internal. For more information, see Relocate AnzoGraph DB Directories.
license_file license.pem (char) This setting specifies the name of the license file. Do not change this value unless instructed to do so by Cambridge Semantics Support.
load_errors_graph load_errors (char) This setting specifies the name of the graph to load error messages to if LOAD SILENT is specified with a SPARQL LOAD query and errors are encountered during the load.
load_normalize_datetime Not set (char) This setting specifies a dateTime value to use in place of any invalid dateTime values that are found when loading files with a SPARQL LOAD query. If AnzoGraph DB returns a "Datum is not a datetime, use setting 'load_normalize_datetime' to patch bad data" error, you can specify the value to substitute for any invalid dateTimes. For example, "0001-01-01T00:00:00Z".
log_directory Not set (char) Specifies where to write system management daemon (azgmgrd) log files. These types of logs (azgmgrd.log, azgctl-<user>.log, azgpidmgr.log, and azgpids.log) are created before the system is initialized and may be written before the <install_path>/internal/log directory exists. Therefore, they are located outside of the AnzoGraph DB file system, /tmp by default. If you change the log_directory value, Cambridge Semantics recommends that you choose another location that is outside the internal AnzoGraph DB directories. When not set, the default location is /tmp.
log_rotate_counter 5 (int) This setting controls the number of azgmgrd.log files to retain when the logs are rotated and a new one is created. Logs are rotated once a file reaches the size limit specified in log_size_limit. By default, 5 files are kept plus the current one. When this value is 0, the log files are not rotated and a single file will contain all of the azgmgrd logging information.
log_size_limit 1790000 bytes (int) This setting sets the limit (in bytes) for the size of the azgmgrd.log file. When the limit is reached, the current file is saved and a new one is started.
max_memory 0=System-based (int) Specifies the amount of memory (in MB) that is available for AnzoGraph DB. The default is system-based; at startup, AnzoGraph DB determines the amount of RAM that is available and sets max_memory. In test environments where AnzoGraph DB may be co-located with other programs, you can set the max_memory value to put a limit on the amount of memory AnzoGraph DB can use. However, Cambridge Semantics recommends that you do not set max_memory unless instructed by Support.
output_format xml (char) Specifies the default output format for AnzoGraph DB responses. Valid values are xml, json, or csv.
persistence_directory Not set (char) The directory where AnzoGraph DB should save data when enable_persistence is true and data is persisted to disk. When not set, the default is <install_path>/persistence. For more information, see Relocate AnzoGraph DB Directories.
service_graph_rowset_limit 1000 (int) This setting places a limit on the number of rows that can be returned per request against the SPARQL endpoint.
sparql_protocol_port 7070 (int) This setting specifies the port to use to access the SPARQL HTTP endpoint when enable_sparql_protocol is true.
sparql_spec_default_graph false (boolean) Controls the default scope of SPARQL queries when FROM clauses are excluded from a query. When false, queries without FROM clauses target the default graph (DEFAULTSET) only. Triples in named graphs will not be included in the scope of the query. When true, AnzoGraph DB conforms to the SPARQL specification and includes the default graph and all named graphs in the scope of a query that omits the FROM clause. For more information, see Change the Default FROM Clause Behavior.
spill_directory Not set (char) The directory where AnzoGraph DB should save temporary query files that spill to disk. When not set, the default is <install_path>/spill. For more information, see Relocate AnzoGraph DB Directories.

AnzoGraph DB uses O_DIRECT to read the spill files into the database. If you relocate the spill directory, make sure to place it on an ext4 file system that supports O_DIRECT.
ssl_protocol_port 8256 (int) This setting specifies the port to use to access the SPARQL HTTPS endpoint when enable_ssl_protocol is true.
startup_info 1 (int) Controls how verbose the database startup message is: - 0-quiet, 1-ready, 2-ports, 3-more.
stop_timeout 30 (int) When the database stop command is issued, this setting specifies the number of seconds to wait for queries to finish before stopping the database.
truncate_clob false (boolean) Controls whether to automatically truncate large strings to the maximum string size (2 MB).
use_custom_ssl_files false (boolean) Indicates whether you are replacing AnzoGraph DB's self-signed certificates with your own custom certificates. To configure AnzoGraph DB to use your certificates, place the certificate files in the <install_path>/config directory and set use_custom_ssl_files to true. Restart the system management daemon (azgmgrd) as well as the database to apply the configuration change.
user_queues 64 (int) This setting configures the limit on the number of queries that can run concurrently.
xray_sth_portion 0.001 (float) This setting configures the percentage of total memory to use for storing historical system table information in memory before spilling to disk. The default value 0.001 = 0.1% of memory.
xray_sth_spool_duration 7days (char) This setting controls the length of time to accumulate historical system table information on disk for xrays.
xray_sth_spool_maxgb 20 (int) This setting controls the maximum size (in GB) per node of historical system table information to keep on disk for xrays. When the limit is reached, AnzoGraph DB deletes the oldest N records, where N depends on the server workload, but is typically about 5 to 6 minutes worth of system table data.

Advanced Settings

This section describes the settings in the Advanced section of settings.conf.

Setting Default Value (type) Description
auto_restart_max_attempts 5 (int) Specifies the number of times the system manager should attempt to start the database after a crash. The default value is 5, which means the system manager will attempt to restart the database a maximum of 5 times. Changing auto_restart_max_attempts to 0 disables the auto-restart feature. For more information about the auto-restart feature, see Manage Automatic Database Restart Options.
auto_restart_time 600 (int) Specifies the number of seconds to spend attempting to restart the database. If all attempts fail and this time limit is reached, the system manager stops trying to restart the database. The default value is 600, which means that the system manager will attempt to restart the database for a maximum of 600 seconds (10 minutes). For more information about the auto-restart feature, see Manage Automatic Database Restart Options.
comm_enable_ssl false (boolean) This setting controls whether SSL rather than gRPC is used for communication between the nodes in a cluster.
comm_port_base 9100 (int) This setting specifies the port to use for internal cluster communication.
compile_concurrent 8 (int) This setting specifies the maximum number of generated code compilations to perform concurrently.
compile_max_memory 500 (int) Sets the limit on the amount of memory (in MB) that AnzoGraph DB can allocate for compiling generated code before switching from optimized compile to non-optimized compile.
compile_max_seconds 30 (int) Sets the limit on the number of seconds to spend compiling generated code before switching from optimized compile to non-optimized compile.
compile_optimized background (char) Specifies the type of optimized compile to perform.
copy_file_size 5 (int) This setting controls the size (in MB) of the Turtle files that are generated when graphs are exported to files. For more information, see Copy Graphs to Files.
cron_graphs Not set (char) This setting configures the comma-separated list of the cron graph names to enable. For information about cron graphs, see Schedule Automated Data Updates.
cron_graphs_recheck 10 (int) This setting specifies the interval (in seconds) to wait before re-checking the cron_graphs value to determine if there are changes.
enable_acl false (boolean) This setting controls whether AnzoGraph DB's internal access control mechanism is enabled.
enable_external_auth false (boolean) This setting controls whether external access control is enabled. For information about access control, see Authentication and Access Control.
enable_ocx true (boolean) This setting controls whether support for OpenCypher and BOLT protocol is enabled. For information about OpenCypher support, see Cypher Query Language Reference.
enable_owlstats true (boolean) In order to generate query execution plans, AnzoGraph DB needs to gather statistics about the data, such as the number of triples per graph and number of distinct subjects and predicates. This setting controls whether advanced statistics gathering, called OWL stats, is enabled. OWL stats use the metadata from data models to generate statistics. Cambridge Semantics recommends that you leave enable_owlstats enabled unless otherwise instructed.
enable_refresh_stats_on_update true (boolean) Controls whether the statistics in AnzoGraph DB are flagged as outdated when a graph is updated.
enable_root_user false (boolean) This setting controls whether to allow a user running with root privileges to start AnzoGraph DB.
enable_unbound_variables false (boolean) Controls whether AnzoGraph DB returns an empty result or an error if a query references a missing graph or includes unbound variables. This value is set to false by default, which means AnzoGraph DB returns an error. For more information, see Ignore Missing Graphs and Unbound Variables in Queries.
float_decimals 6 (int) This setting does not apply to results that are returned from AnzoGraph DB to other Cambridge Semantics gRPC protocol applications. This setting would only affect results that are returned directly from AnzoGraph DB to another application over HTTP/S protocol.

AnzoGraph DB formats floating point types using the printf format string %.precision format, where precision is the value of the float_decimals, and format is the value of float_format.

The interpretation of float_decimals differs depending on the value in float_format. For fixed point formats (f and F), float_decimals specifies the number of digits to include after the decimal point, padded with zeros if necessary. For floating point formats (e, E, g, and G), float_decimals specifies the number of significant digits to round the result to.
float_format g (char) This setting does not apply to results that are returned from AnzoGraph DB to other Cambridge Semantics gRPC protocol applications. This setting would only affect results that are returned directly from AnzoGraph DB to another application over HTTP/S protocol.

AnzoGraph DB formats floating point types using the printf format string %.precision format, where format is the value of the float_format, and precision is the value of float_decimals. Valid values for float_format are e, E, f, F, g, or G. In the default configuration, a value of 10000000000.123 is returned as 1e+10.
ignore_deniedlist_queries true (boolean) Controls whether denied list queries are blocked from running or are allowed to be run when the database is returned to normal operation. The default value is true, which means denied list queries are ignored. Incoming queries are not compared with the denied list and are permitted to run. If ignore_deniedlist_queries is false, denied list queries are not ignored and are therefore blocked from running until they are removed from the denied list. For more information about the auto-restart feature, see Manage Automatic Database Restart Options.
jvm_max_memory Not set (char) Specifies the maximum size of the heap that can be used by the embedded Java virtual machine (JVM). Use k, m, or g (case insensitive) for KiB, MiB, or GiB. You can also specify % to indicate a percentage of the total memory that is available to AnzoGraph DB. By default, this value is not set, which means jvm_max_memory defaults to either 5% of the total memory or 4g, whichever value is smaller. When not set, the default is 5% or 4g, depending on which value is smaller.
jvm_options Not set (char) Lists any optional parameters to use for configuring the embedded JVM. Use a semicolon-delimited (;) list to specify multiple parameters. For information about JVM options, see Options in the Java Documentation.
policy_file_enabled false (boolean) Enables or disables file system access control policies. When policy_file_enabled is false (the default value), AnzoGraph DB does not perform file path access checks when a query reads or writes files or directories on the file system. When policy_file_enabled is true and a query attempts to access a file or directory on the file system, AnzoGraph DB performs the file path access checks that are configured in the file_policy_* settings and returns an access denied error message if the path is not accessible. For instructions on configuring file access policies and the file_policy_read, write, delete, and deny settings, see Manage File Access Policies.