E.2. The Structure of the Deployment File

Documentation

VoltDB Home » Documentation » Using VoltDB

E.2. The Structure of the Deployment File

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

Figure E.1, “Deployment XML Structure” shows the structure of the deployment 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. Deployment XML Structure

Table E.1, “Deployment 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. Deployment File Elements and Attributes

Element	Child of	Parent of	Attributes
deployment^*	(root element)	admin-mode, commandlog, cluster, export, heartbeat, httpd, import, partition-detection, paths, security, snapshot, systemsettings, users
cluster^*	deployment		hostcount={int}^* sitesperhost={int} kfactor={int} schema={catalog\|ddl}
admin-mode	deployment		port={int} adminstartup={true\|false}
heartbeat	deployment		timeout={int}^*
partition-detection	deployment	snapshot	enabled={true\|false}
snapshot^*	partition-detection		prefix={text}^*
commandlog	deployment	frequency	enabled={true\|false} synchronous={true\|false} logsize={int}
frequency	commandlog		time={int} transactions={int}
dr	deployment	connection	id={int}^* listen={true\|false} port={int}
connection	dr		source={server[,..]}^*
export	deployment	configuration
configuration^*	export	property	enabled={true\|false} stream={text}^* type={file\|http\|jdbc\|kafka\|rabbitmq\|custom} exportconnectorclass={class-name}
property	configuration		name={text}^*
import	deployment	configuration
configuration^*	import	property	enabled={true\|false} module={text} format={csv\|tsv} type={kafka\|custom}^*
property	configuration		name={text}
httpd	deployment	jsonapi	port={int} enabled={true\|false}
jsonapi	httpd		enabled={true\|false}
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		enabled={true\|false} provider={hash\|kerberos}
snapshot	deployment		frequency={int}{s\|m\|h} prefix={text} retain={int} enabled={true\|false}
systemsettings	deployment	elastic, query, resourcemonitor, snapshot, temptables
elastic	systemsettings		duration={int} throughput={int}
query	systemsettings		timeout={int}^*
resourcemonitor	systemsettings	disklimit, memorylimit	frequency={int}
disklimit	resourcemonitor	feature
feature	diskllimit		name={text}^* size={int[%]}^*
memorylimit	systemsettings		size={int[%]}^*
snapshot	systemsettings		priority={int}^*
temptables	systemsettings		maxsize={int}^*
users	deployment	user
user	users		name={text}^* password={text}^* roles={role-name[,..]}
^*Required

< previous

table of contents

next >