Client Package

In this section we make a distinction between a server and client installation.

  • A Server Installation is a full deployment of NuoDB as described in Deployment Models. A Server installation is required to create a NuoDB domain and to run databases.

  • A Client in this context refers to a person or application trying to access an existing NuoDB installation (existing servers and databases).

  • The Client Installation is a subset of the Server installation and does not contain the code to run admin or database processes (APs, TEs or SMs) - these must already be running elsewhere.

Why use the Client Package?

  • Corporate security policies normally restrict access to the NuoDB server machines. Although NuoDB’s tools, such as nuocmd and nuosql, are installed with the server, only privileged DBAs can run them directly on a server machine.

  • The C and C++ drivers are not available on public websites. You do not want to perform a full Server installation just to get some driver libraries.

  • Similarly, if you just want to use the command line tools, the sample SQL data and/or the example applications.

  • Even for drivers available on public websites (such as GitHub, Maven Central or the NPM Registry) your company may not allow unrestricted downloads from public websites, or even from NuoDB.

This is why we provide the Client Package.

  • It allows you to install just the client tools locally on any machine or VM running Windows or Linux, and also the drivers needed for C or C++ development.

  • The client tools and drivers in the package can be first curated by your systems administrators to ensure they meet security requirements before being made available within your company.

  • If you are running NuoDB locally in containers on Windows using Docker, you can install the Client Package for Windows to access NuoDB directly (assuming the ports are mapped correctly) avoiding use of docker exec. Note that your database must be specified as <database-name>@localhost.

Everything in the client package, including the Sample Data and example applications, is always installed as part of a full installation. However, as mentioned above, these installations typically have restricted access and you do not need a full installation just to run tools or get drivers.

Installation

To install:

  1. Download the Client Package as a compressed tar or zip file from NuoDB Support.

  2. Unpack in a convenient location.

  3. Set NUODB_HOME to this location in your environment.

  4. Add the bin directory to your path to use the tools.

  5. There is a README.txt in the root of the installation with a complete description of its contents.

To run the nuocmd tool, Python 3 must be installed on your machine.

For more information, see Command Line Tools and Drivers in the NuoDB Client Package.

For convenience, the Client-Only package includes the pynuoadmin Python package which in turn includes nuocmd. Intended for DBAs, they can copy or install the pynuoadmin package to any machine and run nuocmd without needing to install anything else. Refer to the README.txt for the list of files to copy. Alternatively install pynuoadmin using pip.

Content Locations

The contents of the client-only package are organised in the same way as the full server installation. This means the files for a given tool or driver may be spread across several different directories.

The table below shows the overall directory structure. However, for a full, detailed description of the contents of the client-only package, and where to find the files you need for each driver, refer to its README.txt.

Directory Contents Documentation

bin

  • NuoDB utilities such as nuosql, nuocmd

  • C, C++ and ODBC DLLs for Windows

doc

  • License information

N/A

etc/python

  • pynuoadmin Python Package

  • Python Driver Package

include

  • Include files for C and C++

lib

  • C, C++ and ODBC libraries for Windows

lib64

  • C, C++ and ODBC libraries for Linux

samples

  • Examples of using Java, C and C++ drivers

  • The ice-hockey SQL data.