E.2. The Structure of the Configuration File

Documentation

VoltDB Home » Documentation » Using VoltDB

E.2. The Structure of the Configuration File

The configuration file starts with the XML declaration. After the XML declaration, the root element of the configuration file is the deployment element. The remainder of the XML document consists of elements that are children of the deployment element.

Figure E.1, “Configuration XML Structure” shows the structure of the configuration file. The indentation indicates the hierarchical parent-child relationships of the elements and an ellipsis (...) shows where an element may appear multiple times.

Figure E.1. Configuration XML Structure

Table E.1, “Configuration File Elements and Attributes” provides further detail on the elements, including their relationships (as child or parent) and the allowable attributes for each.

Table E.1. Configuration File Elements and Attributes

Element	Child of	Parent of	Attributes
deployment^*	(root element)	avro, cluster, commandlog, dr, export, heartbeat, httpd, import, partition-detection, paths, security, snapshot, snmp, ssl, systemsettings, topics, users
avro	deployment		registry={url}^* namespace={text} prefix={text}
cluster^*	deployment		kfactor={int} sitesperhost={int}
heartbeat	deployment		timeout={int}^*
partition-detection	deployment		enabled={true\|false}
commandlog	deployment	frequency	enabled={true\|false} logsize={int} synchronous={true\|false}
frequency	commandlog		time={int} transactions={int}
dr	deployment	connection, consumerlimit, schemachange	id={int}^* role={master\|replica\|xdcr}
connection	dr		source={server[,...]}^* enabled={true\|false} preferred-source={int} ssl=[file-path]
consumerlimit	dr	maxbuffer, maxsize
maxbuffer	consumerlimit
maxsize	consumerlimit
schemachange	dr		enabled={true\|false}
export	deployment	configuration
configuration^*	export	property	target={text}^* enabled={true\|false} exportconnectorclass={class-name} type={file\|http\|jdbc\|kafka\|custom}
property	configuration		name={text}^*
import	deployment	configuration
configuration^*	import	property	type={kafka\|custom}^* enabled={true\|false} format={csv\|tsv} module={text} priority={int} reconnect={int}{s\|m\|h}
property	configuration		name={text}
httpd	deployment		enabled={true\|false}
metrics	deployment		enabled={true\|false} interval={int}{s\|m\|h} maxbuffersize={int}
paths	deployment	commandlog, commandlogsnapshot, droverflow, exportoverflow, snapshots, voltdbroot
commandlog	paths		path={directory-path}^*
commandlogsnapshot	paths		path={directory-path}^*
droverflow	paths		path={directory-path}^*
exportoverflow	paths		path={directory-path}^*
snapshots	paths		path={directory-path}^*
voltdbroot	paths		path={directory-path}^*
security	deployment	ldap	enabled={true\|false} provider={hash\|kerberos\|ldap}
ldap	security	group, ssl	server={url}^* rootdn={text}^* user={text}^* password={text}^* timeout={int}
group	ldap		name={text}^* role={text}^*
ssl	ldap	truststore
truststore	ssl		path={file-path}^* password={text}^*
snapshot	deployment		enabled={true\|false} frequency={int}{s\|m\|h} prefix={text} retain={int}
ssl	deployment	keystore, truststore	enabled={true\|false} external={true\|false} internal={true\|false}
keystore^*	ssl		path={file-path}^* password={text}^*
truststore	ssl		path={file-path}^* password={text}
snmp	deployment		target={IP-address}^* authkey={text} authprotocol={SHA\|MD5\|NoAuth} community={text} enabled={true\|false} privacykey={text} privacyprotocol={text} username={text}
systemsettings	deployment	clockskew, compaction, elastic, flushinterval, priorities, procedure, query, resourcemonitor, snapshot, temptables
clockskew	systemsettings		interval={int}
compaction	systemsettings		interval={int} maxcount={int}
elastic	systemsettings		duration={int} throughput={int}
flushinterval	systemsettings	dr, export	minimum={int}
dr	flushinterval		interval={int}
export	flushinterval		interval={int}
priorities	systemsettings	dr, snapshot	batchsize={int} enabled={true\|false} maxwait={int}
dr	priorities		priority={int}
snapshot	priorities		priority={int}
procedure	systemsettings		loginfo={int} copyparameters={true\|false}
query	systemsettings		timeout={int}^*
resourcemonitor	systemsettings	disklimit, memorylimit	frequency={int}
disklimit	resourcemonitor	feature
feature	disklimit		name={text}^* size={int[%]}^* alert={int[%]}
memorylimit	resourcemonitor		size={int[%]}^* alert={int[%]} compact={true\|false}
snapshot	systemsettings		priority={int}^*
temptables	systemsettings		maxsize={int}^*
threadpools	deployment	pool
pool	threadpools		name={text}^* size={text}^*
topics	deployment	broker, topic	enabled={true\|false} threadpool={text}
broker	topics	property
topic	topics	property	name={text}^* allow={role-name[,..]} format={avro\|csv\|json} opaque={true\|false} priority={int} procedure={text} retention={text}
property	broker,topic		name={text}
users	deployment	user
user	users		name={text}^* password={text}^* expires={date} roles={role-name[,..]}
^*Required

< previous

table of contents

next >