Release 1.1. User's Guide and Reference

Transcription

1 Release 1.1 User's Guide and Reference

2 1. NuoDB API DataSource Reference Page NuoDB Online Documentation v Overview About the NuoDB Architecture Client Connections System Requirements and Support Installing NuoDB Linux Installation Mac OS X Installation Windows Installation Installing a New License Uninstalling NuoDB Getting Started QuickStart Run the QuickStart Console > Explorer QS Execute SQL Commands Web Console with the QuickStart Copy of Execute SQL Commands Using Command Line to Get Started Linux Command Line Usage Windows Command Line Usage Developing with NuoDB C++ with NuoDB Getting Started Java Hibernate with NuoDB Getting Started Java with NuoDB Getting Started JRuby with NuoDB Getting Started Sample Client Programs Migrating Databases to NuoDB APIs and Drivers NuoDB Drivers Available NuoDB Drivers NuoDB Drivers on GitHub JDBC Connections JDBC Connection Properties ODBC Connections Example: Using ODBC and Microsoft Excel to Read a NuoDB Database Example: Using ODBC and Open Office Calc to Read a NuoDB Database NuoDB ADO.NET Driver NuoDB PHP PDO Driver NuoDB Zend Framework Adapter APIs C++ API Reference JDBC API Reference JDBC API Requirements JDBC API Sample Understanding Client Connections Programming C++ with NuoDB Java With NuoDB Tools and Utilities Tools NuoDB Loader NuoDB Manager NuoDB Migrator NuoDB Migration Usage Examples for NuoDB MSSQL Migration MySQL Migration Oracle Migration

3 PostgreSQL Migration Commands NuoDB SQL CLI nuosql Command Batch Processing from the Command Line Selecting from the DUAL Table Metadata Troubleshooting the NuoDB SQL Client NuoDB Web Console Start the NuoDB Web Console Start a Database Using the Web Console Specify Alert Settings webapp.properties Storefront Demo rd Party Utilities DbVisualizer for NuoDB JDBC Driver OLD_DbVisualizer for NuoDB JDBC Driver SQL Workbench/J SQuirreL Universal SQL SQL Reference Summary of SQL Supported by NuoDB SQL Reference Pages ALTER DOMAIN ALTER SEQUENCE ALTER TABLE ALTER TRIGGER ALTER USER AUTOCOMMIT COMMIT CREATE DATABASE CREATE DOMAIN CREATE INDEX CREATE PROCEDURE CREATE ROLE CREATE SCHEMA CREATE SEQUENCE CREATE TABLE CREATE TRIGGER CREATE USER CREATE VIEW DELETE DROP DATABASE DROP DOMAIN DROP INDEX DROP PROCEDURE DROP ROLE DROP SCHEMA DROP SEQUENCE DROP TABLE DROP TRIGGER DROP USER DROP VIEW EXPLAIN GRANT INSERT RELEASE REPLACE REVOKE ROLLBACK SAVEPOINT

4 SELECT SET SHOW START TRANSACTION TRUNCATE TABLE UPDATE UPGRADE USE SQL Language Elements and Transactions Datatypes Supported by NuoDB NuoDB Extensions Standard SQL Datatype Keywords Supported String Types Date, Time, and TimeStamp Conversions Numeric Types Datatypes [old] <HIDDEN> Domains Operators and Operations Logical Operators Comparison Operators Numeric Operations Functions CHAR_LENGTH Function SUBSTR Function String Concatenation Date and Time Functions Expressions Value Expressions Conditional Expressions Object Privileges Transactions and Isolation Levels Relationship to java.sql Levels Internationalization and Localization Migration Notes Distinction between a schema and a database Compliance with SQL Standard Summary of SQL in NuoDB Working With Triggers SQL Administration and Deployment Administration Tools nuoagent Commands to Start and Stop NuoDB Brokers and Agents Starting and Stopping NuoDB Agents/Brokers, Web Console and Tray Monitor nuodb default.properties Provisioning NuoDB Domain Administrators Data Durability in NuoDB Configuration Scenarios Single Host Configuration Multiple Host Configuration Amazon AWS Multiple Data Centers and Cloud Regions Automate Configuration Scenarios Using Amazon Web Services (AWS) Components Microsoft Azure Deployment Guidelines Memory Management High Availability (HA)

5 Redundancy and Failover Hadoop Distributed File System (HDFS) Troubleshooting NuoDB How To Scale Out a NuoDB Database Setup a Pilot Project on Multiple Hosts Glossary Release Notes Bug Fixes and Improvements Known Bugs and Limitations Acknowledgements Documentation Download

6 NuoDB API DataSource Reference Page JDBC API NuoDB Company Website Copyright 2013 NuoDB, Inc. All rights reserved SPACER

7 NuoDB Online Documentation v1.1 Welcome to the NuoDB Documentation! Installation and Getting Started Installing NuoDB Getting Started Overview SQL Materials SQL Reference SQL Language Elements and Transactions Programming and Administration APIs and Drivers Tools and Utilities Administration Tools

8 Overview A NuoDB system is designed for the configuration, deployment, and management of one or more databases on a cloud. From a conceptual point of view, a NuoDB system has three layers: a Management Layer, an SQL Layer, and a Data Layer. Each NuoDB database is associated with multiple processes running in each of these layers. Management Layer NuoDB Broker is a process that manages access to transaction engines and storage managers, independent of any particular database in the NuoDB system. By default, when you start a broker, the broker defines a NuoDB domain. NuoDB Agent is a process that manages NuoDB processes running on a particular computer. It starts and stops the NuoDB servers and communicates with a broker about the state of the system. NuoDB Manager is a text-based tool that you can use interactively or non-interactively to administer all aspects of NuoDB. NuoDB Web Console is a web based GUI administration tool running by default on; /localhost:8080 NuoDB System Tray is a GUI tool running on MAC OSX and Windows used to more easily launch the NuoDB Console, QuickStart Wizard and SQL Prompt. NuoDB Loader is a tool for importing and exporting data. SQL Layer NuoDB Transaction Engine provides access to a single database. It handles requests from clients, caches data, and coordinates transactions. There may be any number of transaction engines running on a single machine or across a cluster. Data Layer NuoDB Storage Manager is a process that provides durability of the data that it handles (for example by writing to disk). There may be any number of storage managers running on a single machine or across a cluster. Each storage manager is associated with exactly one database. Transaction engines and storage managers send asynchronous messages to each other while the system is running, in order to maintain copies of the current database. NuoDB Domain Lastly, a NuoDB Domain is a collection of NuoDB hosts that have been provisioned to work together to support one or more NuoDB databases. By default, when you start a broker, the broker defines a NuoDB domain. On most platforms the NuoDB installer will automatically start a broker when the OS starts. The following drawing is a conceptual illustration of the components that comprise a NuoDB system.

9 NuoDB Company Website Copyright 2013 NuoDB, Inc. All rights reserved SPACER

10 About the NuoDB Architecture Atomic Architecture, Latency and Storage Management NuoDB uses a unique architecture to achieve high performance, elasticity, scalability, and ACID compliance. Overview How does NuoDB handle the case of two transactions, running on parts of a database that are separated by a long-latency network, where each transaction can run and commit before either transaction can determine the existence of the other? How do storage managers that ensure durability also maintain consistency with each other and with the current state of the database? The NuoDB architecture makes it possible for transaction engines to maintain a copy of a database in memory, and for storage managers to stay synchronized with each other and with the transaction engines. All elements of a NuoDB database (data, indexes, metadata, and transaction state) are maintained in objects called atoms, which are of various types. The transaction manager atom (TMA) tracks the start events and commit events of all transactions in the system. Instances of the TMA receive and send messages to and from other TMAs, and to and from TEs and SMs. Each TE and each SM has a TMA instance. Transactions A NuoDB client application starts a transaction by recording a start event on a TE, which is referred to as the local TE. Similarly, when the transaction completes, the TE records a transaction end event. All TEs record all start and end events, making it possible for all transactions to be visible across the database. All TEs for a particular database communicate with each other by means of batched, asynchronous messages; messages about transaction state changes require no acknowledgement. When two transactions are operating independently (for example, inserting values into different tables) they do not communicate at all. How Conflicts Are Resolved Conflicts can occur on specific pieces of data, such as trying to update to the same record, or inserting the same values into unique indexes. If multiple copies of an atom are in circulation, and there is a conflict, a single instance of the atom is designated as the atom chairman. The atom chairman acts as referee and resolves the conflict of operations on data. The steps in this kind of conflict resolution are as follows: The local records or index atom instance sends a change request to the records or index atom chairman. The chairman receives change requests and determines if there is a conflict. During this communication process, each change is stalled. Consequently the transaction thread stalls until the atom chairman responds. If the change does not conflict with concurrent changes the transaction proceeds. Commit Protocol NuoDB database administrators can set a minimum level of durability for a database, and application developers can require a higher level of durability for specific applications. The commit protocol is specified as a command line option. The remote commit with journaling protocol guarantees that at least one SM has copies of all of a transaction's changes before the transaction commits. The following list describes the steps in a commit process: The transaction issues a commit request to the TE it is connected to (which is the local TE). The local TE sends a pre-commit message to the TMAs on SMs. The SMs receive the pre-commit message and each one: Flushes its replication message journal, using direct I/O Sends a "CommitACK" message to the TMA on the local TE. The TMA on the local TE: Receives at least one "CommitACK" message Sends a "committed" message to all other TMAs Tells its TE that it can respond to the transaction saying its commit succeeded. Because the commit sequence is critical to performance, the messages are not batched, but sent immediately. This sequence guarantees that all changes made by the committed transaction are on durable storage in at least one place. If all the SMs serving the database fail simultaneously, applying the journaled replication message to the archived atoms restores all changes made by transactions that had committed before the catastrophe. Applications or databases with higher durability requirements can require a commit

11 protocol, which requires receiving "commit received" messages from two SMs. NuoDB Company Website Copyright 2013 NuoDB, Inc. All rights reserved SPACER

12 Client Connections The following illustration shows a simple NuoDB database system and a client that wants to connect to it. The steps in the process shown in this conceptual illustration are as follows: 1. An application that seeks to connect to the database calls to the broker on Host A Because the Broker communicates with all Agents in the Domain it knows which Transaction Engines are available and determines the best transaction engine for the application. The broker communicates back to the client that it should connect to the Transaction Engine on Host B. Once the Application knows which Host and Transaction Engine to communicate with, it will no longer communicate with the Broker. The client connects to the Transaction Engine on Host B. About Client Connections and Transaction Engines NuoDB distributes new requests for transactions from a client application to existing transaction engines that are connected to the client application. There is no mechanism for redistributing existing connections when a new transaction engine starts. You must explicitly establish a new connection from the client application and send it to the newly started transaction engine. If you add a transaction engine process while client applications are connected to transaction engines that are already running, and you want to have the same number of connections, and you want to balance the connections among all transaction engines, you must explicitly disconnect the existing client connections and reconnect clients to all transaction engines after you start the new transaction engine. NuoDB Company Website Copyright 2013 NuoDB, Inc. All rights reserved SPACER

13 System Requirements and Support NuoDB runs on Linux, Mac OS X, and Windows, and requires the Java SDK. Supported Operating Systems Ubuntu and 12.x RHEL 5.9 and 6.x Linux (x64) SuSe Linux Enterprise Server 11 sp2 opensuse 12.x Amazon Basic EC2 MAC OS X 10.7.x or later (x64) Windows (x64) 7 or later note: Client support only for x32 Additional Software Requirements NuoDB requires Java 1.6 or later, and has been tested using the following software: Oracle Java 1.6 MAC JDK 1.6 Open JDK 1.6 On Windows (x64), Java must also be (x64). 3rd Party Software NuoDB will install Jetty as the embedded web server for NuoConsole:\ Jetty 8.1 Minimum Recommended Hardware CPU Memory Dual Core x86_64, 1.6GHz 4 GB Unsupported Software NuoDB does not support g++ on Windows NuoDB Ruby drivers have not been tested on Windows NuoDB Go driver is not supported NuoDB Perl driver is not supported

14 NuoDB Company Website Copyright 2013 NuoDB, Inc. All rights reserved SPACER

15 Installing NuoDB NuoDB is supported on and provides installation packages multiple operating systems. Please select your platform of choice below for further details. System Requirements and Support Linux Installation Mac OS X Installation Windows Installation Installing a New License Bug Fixes and Improvements Known Bugs and Limitations NuoDB Company Website Copyright 2013 NuoDB, Inc. All rights reserved SPACER

16 Linux Installation To install and add new users you must have write access to the /opt directory. RPM Installation Run the RedHat Package Manager (RPM) using the NuoDB package $ rpm --install nuodb-1.1.linux.x64.rpm Installation Details Installation Directory Path Variable /opt/nuodb /opt/nuodb/bin NuoDB Broker Running Using options from the default.properties file Web Console Running License 2 Hosts DEB Installation Run the Debian package utility, dpkg: dpkg --i nuodb-1.1.linux.x64.deb Installation Details Installation Directory Path Variable /opt/nuodb /opt/nuodb/bin NuoDB Broker Running Using options from the default.properties file Web Console Running License 2 Hosts TAR.GZ Installation Copy the compressed file and expand it to the install directory you wish to use: $ sudo cp nuodb-1.1.linux.x64.tar.gz /opt/ $ sudo tar -zxvf /opt/nuodb-1.1.linux.x64.tar.gz Configure your environment variable. Add $NUODB_ROOT /nuodb/bin to the PATH, where $NUODB_ROOT is where you installed the product.

17 $ export PATH=$PATH:/opt/nuodb/bin Optionally, use init.d scripts to start NuoDB processes. NuoDB provides a sample init.d script. To experiment with the NuoDB SQL client and a sample NuoDB database see the QuickStart. You can also get started just by using the command line: see Linux Command Line Usage. Installation Details Installation Directory Path Variable No Default Set during Installation No Default must be set manually NuoDB Broker Not Running Must be started manually Web Console Not Running Must be started manually License 2 Hosts NuoDB Company Website Copyright 2013 NuoDB, Inc. All rights reserved SPACER

18 Mac OS X Installation To install NuoDB you must have write access to the /opt directory. Wizard Installation NuoDB can be installed by double-clicking the.pkg file and walking through the installation prompts. Once the installation is complete, the QuickStart Wizard will appear. The OS X Gatekeeper feature may cause an "Unidentified Developer" error to be thrown when downloading or installing apps that were not purchased via the Mac App Store. If you experience this behavior use the following to resolve the error: 1. Goto: System Preferences > Security and Privacy > General 2. Select the "Anywhere" radio button for "Allow applications downloaded from:" Command Line Installation The Command Line installation of NuoDB allows you bypass the installation Wizard and install using all of the default options. Please note that the QuickStart Wizard will appear once the Command Line installation is complete. $ sudo installer -pkg ~/Downloads/nuodb-1.1.macosx.x64.pkg -target / Installation Details The following are the default installation details, regardless of the installation method (Wizard or Command Line). Installation Directory Path Variable /opt/nuodb /opt/nuodb/bin NuoDB Broker Running Using options from the default.properties file Web Console Running Default License 2 Hosts Post Installation Once the installation is complete you will be prompted to run the QuickStart Wizard which will introduce you to the elements of the NuoDB Architecture and automatically start a test database. You can choose to cancel the QuickStart Wizard, and in that case we would suggest that you review the Linux Command Line Usage for examples of how to start a database manually. NuoDB Company Website Copyright 2013 NuoDB, Inc. All rights reserved SPACER

19 Windows Installation Prerequisites Write permissions. To install NuoDB you must have write access to the C:\Program Files directory..net Framework v4 or later must be installed, or the NuoDB ADO.NET driver, which is part of the NuoDB install package, will not install. To verify you have it, look for it in the list of installed programs in Control Panel (Start > Control Panel > Programs > Programs and Features). If it's not installed, download and install.net Framework v4 before installing NuoDB. Important Previous versions of NuoDB 64-bit installations are automatically upgraded as part of the NuoDB v1.1 installation process. 32-bit installations however are not, and require the user to first uninstall the previous version before installing NuoDB v1.1. Wizard Installation NuoDB can be installed by double-clicking the.exe file and walking through the installation prompts. Once the installation is complete, the QuickStart Wizard launches. When you install NuoDB on Windows you may see a User Account Settings dialog indicating that the installer is about to make changes to the computer. Our installer is a signed as NuoDB, Inc. Silent Installer The silent installer suppresses all interactive dialog prompts and installs NuoDB to the default locations noted below. Command > nuodb-1.1.windows.x64.exe /S The installer does several things beyond unpacking the software, including: Sets up the proper registry entries for the NuoDB ODBC driver Checks that a valid version of Java is installed Installs and starts a broker as a Windows Service. Installation Details The following are the default installation details, regardless of the installation method (Wizard or Silent Install). Installation Directory Path Variable c:\program Files\nuodb c:\program Files\nuodb\bin NuoDB Broker Running Using options from the default.properties file Web Console Running Default License 2 Hosts

20 Post Installation Once the installation is complete you will be prompted to run the QuickStart Wizard which will introduce you to the elements of the NuoDB Architecture and automatically start a test database. You can choose to cancel the QuickStart Wizard, and in that case we would suggest that you review the Windows Command Line Usage for examples of how to start a database manually. NuoDB Company Website Copyright 2013 NuoDB, Inc. All rights reserved SPACER

21 Installing a New License The Free License is limited to a domain of two hosts only. The following instruction will walk you through obtaining and installing a new license. Obtain a new license License Type Cost Notes Developer Free Requires online registration at the NuoDB WebSite Allows for unlimited hosts Not supported for production environments. Professional Priced Requires a purchase by contacting the Nuo DB Sales Organization Supported for production environments Regardless of how you obtain your new license, you will receive an with your new license file as an attachment. Installation Steps Before you Begin You must have a Broker running to successfully install your new license. The following instruction assumes you are using default domain and password as defined in the etc/default.properties file. Save your License The license needs to be saved to and installed on the host running the Broker, only. There is no need to install the license to any other host in your NuoDB Domain. Start the Broker # By default, the NuoDB installation will automatically start a broker and domain for you unless you installed using the TAR.GZ files. UNIX $ java -jar /opt/nuodb/jar/nuoagent.jar & Windows > start java -jar "c:\program Files\nuodb\jar\nuoagent.jar" Start nuodbmanager

22 # Always use the nuodbmanager utility when administering your domain and database from the command line. UNIX $ java -jar /opt/nuodb/jar/nuodbmanager.jar --broker localhost --password bird Windows > java -jar "c:\program Files\nuodb\jar\nuodbmanager" --broker localhost --password bird Install your new license # The following command is for all platforms nuodb [domain] > apply domain license licensefile /path/to/your/license_file.txt Verify your new license # The following command is for all platforms nuodb [domain] > show domain license NuoDB Company Website Copyright 2013 NuoDB, Inc. All rights reserved SPACER

23 Uninstalling NuoDB To unistall NuoDB: Windows 7 Control Panel Navigate to Start > Control Panel > Programs > Uninstall a program Select NuoDB from the list of installed programs and click Unistall/Change. The NuodDB Uninstall dialog opens. 3. Click Uninstall to uninstall NuoDB. Windows Command Line Interface 1. Open a CMD window (Start > Run > cmd). Run the following commands: > cd C:\Program Files\NuoDB\ > uninstall nuodb-sh Linux/Mac OSX 1. Open a Terminal and run the following commands: $ cd /opt/nuodb $ sudo sh uninstall-nuodb.sh $ Password: $ This will uninstall NuoDB and remove ALL associated files and preferences. $ Do you wish to proceed with the uninstall? (Y/n): y $ Uninstalling NuoDB... $ NuoDB successfully uninstalled. NuoDB Company Website Copyright 2013 NuoDB, Inc. All rights reserved SPACER

24 Getting Started Get started with NuoDB by running a NuoDB startup script that creates a sample database for you to explore, or by creating your own database. Run a sample client that shows how to connect an application to a NuoDB database. QuickStart Using Command Line To Get Started Developing with NuoDB NuoDB Company Website Copyright 2013 NuoDB, Inc. All rights reserved SPACER

25 QuickStart Get started with NuoDB by running a NuoDB startup script that creates a domain, a database, and a sample schema. The script starts NuoDB Console and the NuoDB SQL client, so you can use NuoDB with a small sample project. Run the QuickStart Execute SQL Commands Use NuoDB Web Console to Explore the Domain NuoDB Company Website Copyright 2013 NuoDB, Inc. All rights reserved SPACER

26 Run the QuickStart Procedure to get the product up and running with a sample NuoDB database. The Quickstart runs as a part of the installation however, these instructions will guide you after the product is installed. This task is part of the NuoDB QuickStart, which offers an introduction to the basic features of NuoDB. Run the QuickStart Wizard Windows and Mac OS X Wizard 1. From the NuoDB System Tray select NuoDB Console. The NuoDB Console opens in a browser tab. Note Currently, there is no system tray available for Linux installations. To run the QuickStart manually on a Linux install, see Command-Line instructions in the next section 2. On the Console > Home tab, click Start QuickStart. 3. Leave the Domain Settings and Database Settings unchanged, and click Create Database to start a storage manager (SM), start a transaction engine (TM), create a schema, and import sample data into the database. The QuickStart database is created.

27 4. Once the database is created, click the Admin or Explorer link to login to the domain containing the database. 5. The Domain Login dialog appears. Accept the default Domain name and password credentials (domain, bird) and click Log in.

28 The Explorer link opens to the Console Explorer tab, showing the test database in the Data Hierarchy tree. Click here to expand... The Admin link opens to the Console Admin tab showing Domain Overview of the domain you are logged into. Click here to expand...

29 Run the QuickStart Command-Line The quickstart can also be executed form the command line. Running from the command line accomplishes the same steps as the visual quickstart and provides you with a SQL prompt for further exploring. LINUX/MAC $ /opt/nuodb/run-quickstart WINDOWS > c:\program Files\NuoDB\run-quickstart.cmd QuickStart Tasks On all platforms, running the Quickstart accomplishes the following: Configures your system path. Creates a domain (which is named domain) using the settings in the default.properties file. The initial administrator (with a user name of domain) has an initial password (bird), and a second domain administrator user is quickstart with a password of quickstart. Starts a NuoDB database, named test, with its storage repository in WINDOWS: \tmp\test_archive LINUX/MAC: /tmp/test_archive Creates sample schema (hockey). Creates a sample database (test). Imports data to the sample database from: WINDOWS: %\nuodb\samples\quickstart\bruins.csv LINUX/MAC: $/nuodb/samples/quickstart/bruins.csv Starts the NuoDB SQL client (nuosql), with user name and password of dba and goalie, respectively. Starts NuoDB Console as a process. By default it starts on After the script finishes: Take a look at the remaining tasks in the Quick Start documentation to discover how you can experiment with the NuoDB SQL client, NuoDB Manager and NuoDB Console.

30 To understand the role of various NuoDB system components, look at the Overview topic. Other topics explain how to start a pilot project of your own, how to set up and administer a system on the cloud, and connect a client to NuoDB. NuoDB Company Website Copyright 2013 NuoDB, Inc. All rights reserved SPACER

31 Console > Explorer QS 1. Double-click the database. The Database Login dialog launches with the default username and password (dba, goalie). 2. If not already present, enter the username and password, and click Login. You are now logged into database as DBA. 3. To run a query against the database, click New. A tabbed New Query window opens. 4. Write a SQL query and click Execute Query. Note Unless the schema is selected in the Database Hierarchy, fully qualified table names must be used in SQL Explorer

32 4. queries, e.g., hockey.teams or system.connections. This is because the SQL Explorer uses the USE statement internally in the Database Hierarchy, and therefore its use in the Query window can produce SQL processing conflicts. Selecting a schema in the Database Hierarchy implements USE for your query. The query executes. NuoDB Company Website Copyright 2013 NuoDB, Inc. All rights reserved SPACER

33 Execute SQL Commands Start NuoSQL from the Command-Line To launch nuosql from the command line, open a terminal or command line window and cd to: Linux/Mac opt/nuodb/bin Windows C:\Program Files\nuodb\bin Then issue the following command. nuosql <DatabaseName>@<HostName> --user <UserName> --password <Password> Linux/Mac Example... Linux/Mac Command $ nuosql test@localhost --user dba --password goalie Linux/Mac Result Execute your SQL Commands Windows Example... Windows Command > cd "c:\program Files\nuodb\bin" > nuosql.exe test@localhost --user dba --password goalie Windows Result

34 Execute your SQL Commands Executing SQL Commands Once NuoSQL is started you can execute SQL commands as you normally would. More information regarding the NuoDB SQL Syntax can be found here and here. In the window where the SQL session is running issue the following command: SQL> SHOW TABLES; Tables in schema HOCKEY MASTER SCORING TEAMS MASTER, SCORING and TEAMS are the sample tables created when you execute the QuickStart. To see what is in the table, run the following: SQL> SELECT * FROM teams ORDER BY name; YEAR TMID CONFID DIVID RANK PLAYOFF G W L T OTL NAME TOB th Battalion 1972 ALB 0 WW Alberta Oilers 2010 AND WC PC 2 CQF Anaheim Ducks <ETC> Type help to show a list of the NuoDB SQL client commands.

35 SQL> help ALTER DOMAIN ALTER SEQUENCE ALTER TABLE ALTER TRIGGER ALTER USER <ETC> Change definition of a domain (not yet implemented) Change definition of a sequence Change definition of a table Change definition of a trigger Change definition of a user Exit the NuoDB SQL client by typing quit at the SQL prompt: SQL> quit NuoDB Company Website Copyright 2013 NuoDB, Inc. All rights reserved SPACER

36 Web Console with the QuickStart Use NuoDB Web Console to view, analyze, and manage a domain. This example uses the domain created by running the Quick Start. Connect to the Web Console By default the NuoDB Web Console runs on port 8080 and the install packages will configure the Web Console to automatically run in the background. The examples shown here are based on the database that is created as a part of the QuickStart. If you have not run the QuickStart please see Run the QuickStart for information Open a browser and go to: Login using the following: a. b. Username: quickstart Password: quickstart Domain Overview The default view of the domain, will provide you with access to manage the domain and database resources. Select your Domain to install a new license. Select Database to Add/Remove databases from your Domain. Select Host to manage individual NuoDB processes.

37 View the Database View the current Test database by selecting database link. The Databases page will view information such as; Status of the database Transactions per second Number of Client Connections CPU and Memory usage Click the name of the database to view more details about the database processes and status. View Database Acitivity Regardless of the database view you are in there will always be a graphical Activity view in the Web Console window.

38 View Host Information To view information about the individual hosts in your domain, you must select host from the Domain Overview. Next Select the individual host you want to work with to view detailed information. NuoDB Company Website Copyright 2013 NuoDB, Inc. All rights reserved SPACER

39 Copy of Execute SQL Commands NuoDB is bundled with both a browser based and text based analysis and management tools for your NuoDB database. Launch SQL Explorer 1. Launch the following from your browser: 2. Login to your Domain. Note: this example uses the domain credentials for the QuickStart domain (quickstart / quickstart) 3. Select your database from the Database Hierarchy and supply your database level credentials. Note: this example uses the domain credentials for the QuickStart domain (dba / goalie) 4. Select "New" from the Database Hierarchy pane, to open a Query Tab and enter your SQL commands. 5. Go To Sample SQL Commands... Launch NuoSQL from the System Tray NuoSQL is the command line interface to the NuoDB SQL interface. Use the instruction below that matches your OS. OSX Tutorial... Select NuoDB SQL Prompt from the System Tray menu.

40 A Terminal window will open with the SQL> prompt. Sample SQL Commands... By default using the System Tray to launch the NuoDB SQL Prompt will attempt to connect to the test database that is created when the QuickStart is executed. If this database is not running you will receive an error similar to: Connection Failed: no NuoDB nodes are available for database If you receive this error, simply run the QuickStart to start the database. Windows Tutorial... Select NuoDB SQL Prompt from the System Tray menu.

41 A CMD window will open with the SQL> prompt Sample SQL Commands... By default using the System Tray to launch the NuoDB SQL Prompt will attempt to connect to the test database that is created when the QuickStart is executed. If this database is not running you will receive an error similar to: Connection Failed: no NuoDB nodes are available for database If you receive this error, simply run the QuickStart to start the database. Currently, the Linux installation of NuoDB does not have a System Tray integration. On Linux, you must launch NuoSQL from the command line (below). Start NuoSQL from the Command-Line You can also start NuoSQL directly from the command-line. NuoSQL Syntax

42 nuosql --user <UserName> --password <Password> Unix Example... Unix Command $ nuosql test@localhost --user dba --password goalie Unix Result Execute your SQL Commands Windows Example... Windows Command > cd "c:\program Files\nuodb\bin" > nuosql.exe test@localhost --user dba --password goalie Windows Result

43 Execute your SQL Commands Executing SQL Commands Once NuoSQL is started you can execute SQL commands as you normally would. More information regarding the NuoDB SQL Syntax can be found here and here. In the window where the SQL session is running issue the following command: SQL> SHOW TABLES; Tables in schema HOCKEY MASTER SCORING TEAMS MASTER, SCORING and TEAMS are the sample tables created when you execute the QuickStart. To see what is in the table, run the following: SQL> SELECT * FROM teams ORDER BY name; YEAR TMID CONFID DIVID RANK PLAYOFF G W L T OTL NAME TOB th Battalion 1972 ALB 0 WW Alberta Oilers 2010 AND WC PC 2 CQF Anaheim Ducks <ETC> Type help to show a list of the NuoDB SQL client commands. SQL> help ALTER DOMAIN ALTER SEQUENCE ALTER TABLE ALTER TRIGGER ALTER USER <ETC> Change definition of a domain (not yet implemented) Change definition of a sequence Change definition of a table Change definition of a trigger Change definition of a user Exit the NuoDB SQL client by typing quit at the SQL prompt: SQL> quit