The Data Virtuality Server is currently available in four versions: 2.1, 2.3, 2.4, and 3. We recommend checking that you are reading the correct documentation for your version.
The documentation for each version consists of seven parts: Administration Guide, User Guide, Reference Guide, Management API Guide, Upgrade Guide, Performance Optimization Guide, and Licensing and Copyright.
Administration Guide is aimed mainly at administrators and provides information on installing the Data Virtuality Server and other software, configuring it, and keeping it running smoothly.
User Guide describes how replication and materialization work in the Data Virtuality Server, how to set up query builders, and so on. In other words, it gives some theoretical information to help you with working with the Data Virtuality Server.
Reference Guide gives technical information on the SQL dialect, procedures, commands, schemas, and other elements used in the Data Virtuality Server. This guide is more of a handbook, although it also includes practical examples; you can find more practical examples in the Zendesk HelpCenter, which contains articles often written based on actual use cases.
Management API Guide describes system tables, system procedures, and system views.
Upgrade Guide provides a step-by-step manual on how to upgrade your Data Virtuality Server.
Performance Optimization Guide describes ways to improve performance.
Licensing and Copyright contains the license for the use of trial software, a list of third-party open-source components used to develop each component of the software, and third-party licenses.
Tips and Tricks
Before you proceed to read the Data Virtuality Server documentation, you might want to read this section: it contains some practical information to help you get the most out of it.
How to read and use additional information
Some information in the guide is specially formatted to make it easier to single out important information or pick something practical. There are four types of such information: Info, Tip, Note, and Warning, and here are descriptions of each of them:
Just additional information: for example, the feature is implemented starting from a particular version.
Tips, tricks, and hints: for instance, if a process is too time-consuming because it uses lots of data, we may suggest a way to make it more efficient.
Important information and remarks - such as names of properties being case sensitive.
Critically important information - for example, we will include a special warning if the particular procedure deletes all information without further confirmation.
How to copy code from snippets
All snippet boxes come with a Copy button in the top right corner. Clicking it will copy all the code in the snippet (line numbers not included).
How to search using wildcards
Due to platform limitations, wildcards cannot be used at the beginning of a search keyword, but there is a workaround for this: format your search keywords as a regular expression. For example, if you need to search for
*hum*, you can type
/.*hum.*/. The search will then return occurrences of words including 'hum', such as hum, human, and inhumane.