AnzoGraph Settings Reference
This topic provides reference information for each of the AnzoGraph 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 or databases in general. For instructions on changing settings, see Changing AnzoGraph Server Settings.
Basic
- enable_persistence
- enable_sparql_protocol
- enable_ssl_protocol
- internal_directory
- max_memory
- output_format
- persistence_directory
- sparql_protocol_port
- sparql_spec_default_graph
- spill_directory
- ssl_protocol_port
- startup_info
- stop_timeout
- truncate_clob
- use_custom_ssl_files
- user_queues
Advanced
- anzo_protocol_port
- auto_restart_directory
- auto_restart_max_attempts
- auto_restart_time
- aws_log_level
- aws_search_regions
- azgmgrd_client_auth
- azgmgrd_password
- bits_per_pred_index
- bits_per_uri_index
- blank_node_name
- call_home_for_updates
- comm_port_base
- compile_concurrent
- compile_max_memory
- compile_max_seconds
- compile_optimized
- copy_file_size
- enable_owlstats
- enable_refresh_stats_on_update
- enable_root_user
- enable_unbound_variables
- float_decimals
- float_format
- grpc_token_expiry
- ignore_deniedlist_queries
- jvm_max_memory
- jvm_options
- log_directory
- paged_data
- paged_cache_memory_percent
- policy_file_enabled
enable_persistence
Default Value: false (boolean)
This setting controls whether AnzoGraph's saves a copy of the data in memory to disk. For more information, see Using AnzoGraph Persistence (Preview).
enable_sparql_protocol
Default Value: false (boolean)
This setting controls whether to enable the HTTP SPARQL endpoint. The sparql_protocol_port setting controls the port to use to access the endpoint.
Enabling the SPARQL HTTP protocol opens the standard SPARQL-compliant HTTP endpoint. Unlike the Anzo protocol endpoint, the SPARQL HTTP endpoint is not secured.
enable_ssl_protocol
Default Value: false (boolean)
This setting controls whether to enable the secure HTTPS SPARQL endpoint. The ssl_protocol_port setting controls the port to use.
Enabling the SPARQL HTTPS protocol opens the standard SPARQL-compliant HTTPS endpoint. Unlike the Anzo protocol endpoint, the SPARQL HTTPS endpoint is encrypted but not authenticated.
internal_directory
Default Value: Not set (char). The default directory is <install_path>/internal.
The directory where AnzoGraph should save internal database-related files such as generated code, logs, and query plans. For more information, see Relocating AnzoGraph Directories.
max_memory
Default Value: System-based (int)
Specifies the amount of memory (in MB) that is available for AnzoGraph. The default is system-based; at startup, AnzoGraph determines the amount of RAM that is available and sets max_memory. In test environments where AnzoGraph may be co-located with other programs, you can set the max_memory value to put a limit on the amount of memory AnzoGraph can use. However, Cambridge Semantics recommends that you do not set max_memory unless instructed by Support.
output_format
Default Value: xml (char)
Specifies the default output format for AnzoGraph responses. Valid values are xml, json, or csv.
persistence_directory
Default Value: Not set (char). The default directory is <install_path>/persistence.
The directory where AnzoGraph should save data when enable_persistence is true and data is persisted to disk. For more information, see Relocating AnzoGraph Directories.
sparql_protocol_port
Default Value: 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
Default Value: 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 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 Changing the Default FROM Clause Behavior.
spill_directory
Default Value: Not set (char). The default directory is <install_path>/spill.
The directory where AnzoGraph should save temporary query files that spill to disk. For more information, see Relocating AnzoGraph Directories.
AnzoGraph 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
Default Value: 8256 (int)
This setting specifies the port to use to access the SPARQL HTTPS endpoint when enable_ssl_protocol is true.
startup_info
Default Value: 1 (int)
Specifies how verbose the database startup message is: - 0-quiet, 1-ready, 2-ports, 3-more.
stop_timeout
Default Value: 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
Default Value: false (boolean)
Specifies whether to automatically truncate large strings to the maximum string size (2 MB).
use_custom_ssl_files
Default Value: false (boolean)
Indicates whether you are replacing AnzoGraph's self-signed certificates with your own custom certificates. To configure AnzoGraph to use your certificates, follow the instructions in Replace the Default Self-Signed Certificates with Trusted Certificates.
Anzo also needs to trust the new certificates. Make sure you have Trust All TLS Certificates enabled on the AnzoGraph connection or make sure Anzo's trust store has either the certificate for the CA that signed the certificate or the certificate itself.
user_queues
Default Value: 40 (int)
Sets the limit on the number of queries that can run concurrently.
anzo_protocol_port
Default Value: 5700 (int)
The Anzo protocol (gRPC) port for secure communication between AnzoGraph and Anzo.
auto_restart_directory
Default Value: Not set (char). The default directory is <install_path>/internal.
Specifies the base location of the auto_restart directory, which contains the denied_list, warned_list, and unanalyzed_list directories. For more information about the auto-restart feature, see Managing the Automatic Restart Feature.
auto_restart_max_attempts
Default Value: 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 Managing the Automatic Restart Feature.
auto_restart_time
Default Value: 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 Managing the Automatic Restart Feature.
aws_log_level
Default Value: 2 (int)
AnzoGraph uses an AWS C++ SDK for loading data from S3. This setting controls the logging level for the AWS SDK. The default value is 2, which is Error level logging. Valid values are:
- 0 (Off)
- 1 (Fatal)
- 2 (Error)
- 3 (Warn)
- 4 (info)
- 5 (Debug)
- 6 (Trace)
aws_search_regions
Default Value: Not set (char)
Lists the regions to search for AWS S3 buckets that are listed as file locations for LOAD queries.
azgmgrd_client_auth
Default Value: false (boolean)
Controls whether the system management daemon (azgmgrd) and system manager (azgctl) use authentication in addition to encryption when connecting to other system managers over the system management gRPC port (5600). The default value is false, which means the system management connections are encrypted but not authenticated. For more information about azgmgrd authentication, see Enable System Manager Authentication.
azgmgrd_password
This is the password that the system management daemon (azgmgrd) uses for gRPC access to the database. Typically this value is not changed as it is only used internally for authentication between the system manager and the database. If you do want to change the password, you cannot change it directly in the settings.conf file. See Change the System Manager Password for instructions.
bits_per_pred_index
Default Value: 16 (int)
This setting specifies the maximum number of unique graph and predicate URIs that can be stored in AnzoGraph. The maximum number is two to the power of this value. The default value (16) for bits_per_pred_index is set to the maximum value and should not be changed. 2^16 = 64k unique predicate and graph URIs.
bits_per_uri_index
Default Value: 32 (int)
This setting specifies the maximum number of unique subject URIs that can be stored in AnzoGraph. The maximum number is two to the power of this value. The default value (32) for bits_per_uri_index is set to the maximum value and should not be changed. 2^32=4+ trillion unique subject URIs.
blank_node_name
Default Value: genid (char)
This setting specifies the default name basis for blank nodes. By default, AnzoGraph generates a number ID for the node. For example, inserting _:a
results in a URI such as bnode:a__63
.
call_home_for_updates
Default Value: false (boolean)
This setting controls whether AnzoGraph checks for updates over the internet.
comm_port_base
Default Value: 9100 (int)
This setting specifies the port to use for internal cluster communication.
compile_concurrent
Default Value: 8 (int)
This setting specifies the maximum number of generated code compilations to perform concurrently.
compile_max_memory
Default Value: 500 (int)
Sets the limit on the amount of memory (in MB) that AnzoGraph can allocate for compiling generated code before switching from optimized compile to non-optimized compile.
compile_max_seconds
Default Value: 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
Default Value: background (char)
Specifies the type of optimized compile to perform.
copy_file_size
Default Value: 5 (int)
This setting controls the size (in MB) of the Turtle files that are generated when Graphmart contents are exported to files.
enable_owlstats
Default Value: true (boolean)
In order to generate query execution plans, AnzoGraph 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
Default Value: true (boolean)
AnzoGraph's internal statistics gathering queries are triggered automatically when data is loaded. And the resulting statistics are used for all subsequent queries against the data. This setting controls whether AnzoGraph re-runs the statistics gathering queries whenever the data is updated, not just on the initial load.
enable_root_user
Default Value: false (boolean)
This setting controls whether to allow a user running with root privileges to start AnzoGraph.
enable_unbound_variables
Default Value: false (boolean)
Controls whether AnzoGraph 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 returns an error. For more information, see Ignoring Missing Graphs.
float_decimals
Default Value: 6 (int)
This setting does not apply to results that are returned from AnzoGraph to Anzo over gRPC protocol. Anzo converts floating point values to Java native float objects with 6 – 7 total digits of precision. This setting would only affect results that are returned directly from AnzoGraph to another application over HTTP/S protocol.
AnzoGraph 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
Default Value: g (char). In the default configuration, a value of 10000000000.123 is returned as 1e+10.
This setting does not apply to results that are returned from AnzoGraph to Anzo over gRPC protocol. Anzo converts floating point values to Java native float objects with 6 – 7 total digits of precision. This setting would only affect results that are returned directly from AnzoGraph to another application over HTTP/S protocol.
AnzoGraph 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.
grpc_token_expiry
Default Value: 0 (int).
This setting controls how often (in seconds) the gRPC token expires. A value of 0 means the token never expires.
ignore_deniedlist_queries
Default Value: 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 Managing the Automatic Restart Feature.
jvm_max_memory
Default Value: Not set (char). When not set, the default is 5% or 4g, depending on which value is smaller.
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. 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.
jvm_options
Default Value: 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.
log_directory
Default Value: Not set (char). When not set, the default location is /tmp.
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 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 directories.
paged_data
Default Value: false (boolean)
Enables or disables AnzoGraph's paged data feature, which controls whether data is stored in memory or on disk. When this option is false (the default value), data is stored in memory. Setting this option to true changes data storage from in-memory to on-disk (in the persistence_directory).
Enabling this option changes underlying database operations. Before enabling paged data, make sure that the performance and storage impacts are well-understood and that your environment meets the requirements. See Sizing Guidelines for Disk-Based Storage (Preview) for details.
paged_cache_memory_percent
Default Value: 20 (int)
When paged_data is enabled, this setting controls the amount of memory (as a percentage of total memory) to use for caching the most recently requested data. The default value is 20, which means AnzoGraph is configured to use 20% of the total available memory for caching data for analytics. For example, if you have 1 TB of data on disk and 300 GB of available RAM, AnzoGraph caches in memory 60 GB of the most recently accessed data. If a query requests data that is not currently cached, AnzoGraph releases the least accessed data from memory and loads the relevant data into memory. Note that a portion of the paged cache memory percent is used for the overhead of tracking the pages that are accessed. For more information, see Enabling Paged Data Mode (Preview).
Cambridge Semantics recommends that you do not set this value higher than 30.
policy_file_enabled
Default Value: false (boolean)
Enables or disables file system access control policies. When policy_file_enabled
is false (the default value), AnzoGraph 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 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 Managing AnzoGraph File Access Policies.