Using the Command Line to Install NuoDB on Windows

Installing NuoDB Using the .exe File

The silent installer suppresses all interactive dialog prompts and installs NuoDB in the default location. To install NuoDB, enter a command such as the following:

> nuodb-ce-n.n.n.n.x86_64.exe [--service-autostart] /S

In this Community Edition example, you would replace n.n.n.n with the NuoDB version number in your .exe filename. For information on adding Enterprise Edition functionality, see Obtaining and Installing an Enterprise Edition License.

Option

Description

--service-autostart

Optionally indicate that you want the installer to automatically start NuoDB services after installation is complete as well as upon each reboot of the machine. The recommendation is to specify this option if you are running Community Edition and otherwise only if you plan to run a domain that includes only single host databases. If you do not specify this option then see Starting and Stopping NuoDB Services.

Installing NuoDB Using the .zip File

To install the Community Edition, unzip nuodb-ce-n.n.n.n.win64.zip in any location you prefer. For information on adding Enterprise Edition functionality, see Obtaining and Installing an Enterprise Edition License.

Multiple different .zip files can be unzipped on the same system.

After extracting the contents of the .zip file, run etc\nuoservice.bat to create Windows service facilities for NuoDB AdminAn interface for domain and database management. Introduced in NuoDB 4.0 to supersede NuoAgent, this interface is used to manage an admin domain. Use NuoDB Admin instead of NuoAgent to start and stop APs. When using NuoDB Admin to manage a domain and its databases, use NuoDB Command (nuocmd) instead of the NuoDB Manager (nuodbmgr) Command Line Interface (CLI) tool. See also Admin Process (AP)., NuoAgent, and nuorestsvc.

Note: All services are configured with manual start-up modes so they will not start automatically when the system starts.

Each service is installed with a unique name that includes the current NuoDB version number. This enables packages from multiple .zip files to be deployed simultaneously without interfering with each other. This also allows deployment using the .exe file to be performed without any knock-on effects from or for the .zip deployments. For example, the NuoDB Admin service installed using the .exe file will be named NuoDBAdmin while the NuoDB Admin service installed using the nuoservice.bat command extracted from nuodb-ce-4.0.0.1.win64.zip will have the name NuoDBAdmin-4.0.0.1.

Post-Installation Configuration

After installation, you will must enable TLS encrytion (in deployments of NuoDB being managed by NuoDB Admin), or edit the default.properties file (in deployments of NuoDB being managed by NuoAgent) before admin services can be started. Also if you would like to run multiple services at the same time you will need to configure them to use different ports.

Starting and Stopping Services

To start or stop (or view the status of) a service, use the etc\nuoservice.bat svc {start|stop|status} command where svc is NuoDBAdmin, NuoDBAgent, or NuoDBRestSvc. For example to start NuoDB Admin, run the following command:

etc\nuoservice.bat NuoDBAdmin start 

There are also simplified scripts to operate on a single service:

etc\nuoagent.bat {start|stop|status}
etc\nuorestsvc.bat {start|stop|status}
etc\nuoadmin.bat {start|stop|status}

Notes on the NuoDB ODBC Driver

Unlike the services mentioned above, there can be only one version of NuoDB's ODBC driver installed on a system at a time. To identify which NuoDB ODBC driver is currently configured, run the nuoservice status command.

When running the nuoservice install command, and there is no NuoDB ODBC driver currently installed, then the ODBC driver from this package will be configured at that time. If there is already a NuoDB ODBC driver configured, it is not affected.

When running the nuoservice uninstall command, and the configured NuoDB ODBC driver installed is the one from this .zip file, then it will be uninstalled. If the current NuoDB ODBC driver is from a different package, it will not affected.

If you are maintaining multiple NuoDB installations on the same system and you are using NuoDB's ODBC driver for each installation, use the nuoservice odbc ... command to switch between them as follows:

etc\nuoservice.bat odbc status

Show the currently configured driver.

etc\nuoservice.bat odbc install 

Configure the current package's ODBC driver to be the active driver.

etc\nuoservice.bat odbc uninstall 

Remove the currently configured NuoDB ODBC Driver.

Uninstalling NuoDB

To uninstall a deployment of NuoDB which was installed using a .zip file, do the following:

1. Run etc\nuoservice.bat uninstall.

2. Delete the directory created when contents of the .zip file were extracted.