Open Source RDBMS - Seamless, Scalable, Stable and Free

한국어 | Login |Register

Tadpole SQL Client Tutorial


In this tutorial we are going to show how to get started with this awesome Tadpole SQL Client. You can run Tadpole on any Web browser. If you cannot for some reason, file a bug report to Tadpole Github Issue Tracker. The developer is very responsive. I am sure he will resolve issues pretty quickly. So, let's get started.

Installation

First, download Tadpole. It is available for Windows, Linux and Mac OS X. Once downloaded, simply extract the contents of the archive. No further installation is required. Now double click on tadpole-standalone executable file to start it.

When the program is launched, it will automatically open your default Web browser and navigate to http://127.0.0.1:10081/db?startup=tadpole address. Sometimes the Web page opens faster before Tadpole is ready to listed to browser requests. This may lead to a 404 Page Not Found browser error. All you need to do is refresh the page. It should work now.

Login

When you navigate to http://127.0.0.1:10081/db?startup=tadpole you will be prompted to enter your login credentials. Since you do not have one at this point, you can either create New or login without credentials as a Guest or Manager user. Let's go and click on Manager button.

tadpole_login_dialog.png

Once you are in the system, you will see a full-screen Dashboard consisting of 4 parts:

  1. Main Toolbar at the top.
  2. Connection Manager at the top left.
  3. Object Explorer below Connection Manager.
  4. Query Editor Window which occupies the most space.
  5. And at the bottom the Status Bar.

Database Connection

To connect to your desired database, right click on a target Database Group (in this case we will connect to a CUBRID database), hover over Connection Manager then choose Connect Database menu item.

tadpole_connect_db_menu.png

You will see the following DB Connect Dialog window where you need to enter your database connection info. In this tutorial we will connect to a remote CUBRID demodb database. Locale field is intentionally left blank as no value is required for CUBRID. Do not forget to enter the Display Name so that later you can distinguish the connections among many in the Connection Manager panel. If you want to access this database later, check the Save Database checkbox.

To test if your connection credentials are correct, press the Ping Test button. If everything is correct, you should see the success message as shown below. Once ready, press the OK button.

tabpole_db_connect_dialog.png

Once the database connection is successfully created, a connection record will be created under CUBRID group in Connection Manager panel.

tadpole_connection_manager.png

Object Explorer

When you select a connection (single click; a double click will open the Query Editor), a list of tables will be displayed in the Object Explorer panel on the bottom left. There if you select a table, its column information will be displayed below as in the following figure.

You can similarly view all indexes, views, procedures, functions as well as triggers.

tadpole_object_explorer.png

If you right click on the table list a context menu will popup as shown below.

tadpole_object_explorer_menu.png

If you choose any of the available menu items, an appropriate SQL statement will be generated and placed automatically into the main Query Editor. For example, if we click on Create Table menu item, the following SQL template will be placed which we can change according to our needs.

tadpole_create_table_sql.png

Likewise, if you click on Generate SQL Statement: Select the following will be displayed.

tadpole_generate_select_sql.png

Query Editor

Execute SQL

To execute SQL you simply click on one of the two buttons: Execute or Execute ALL. The difference is that the first one will execute only the last SQL statement and display its output, while the second one will execute all SQL statements and display the output of the last statement.

Execute Plan for CUBRID, at the moment of writing this tutorial, is not supported in Tadpole. A feature request has been registered.

Format SQL

One nice feature of Tadpole allows users to quickly format the entered SQL. For example, the above generated CREATE TABLE statement can be transformed into the following when clicked on Format SQL button which is located in the Query Editor toolbar. Very nice feature especially if the editor contains many queries.

tadpole_format_sql.png

SQL to Application

This feature is also very convenient and unique to Tadpole. If you click on it while there is a SQL statement in the Editor, Tadpole will display a Java or PHP variable which will hold the same query as its value. You can simply copy and paste the provided code into your Java or PHP application.

tadpole_sql_to_application.png

ER Diagram

All Table ERD

Tadpole provides a very nice Entity-Relationship Diagram for any of connected databases. To generate the ER Diagram, right click on a database connection, hover over Connection Manager, then choose All Table ERD menu item.

tadpole_all_table_erd.png

This will generate ER Diagram like the one shown below.

tadpole_cubrid_db_erd.png

Actually this one has also undergone the "Tree Auto Layout" process. When Tadpole generates ERD for your database, the tables in the diagram may look scattered throughout the canvas. To organize all the tables in one click as shown in the above figure, right click on any place of the canvas then choose Tree Auto Layout menu item from the displayed context menu.

tadpole_tree_auto_layout.png

Create ERD Diagram

Alternatively, if you do not want all tables be present in your diagram, you can create a new clean diagram and drag and drop necessary tables from Object Explorer. For this to work, instead of All Table ERD menu item choose Create ERD Diagram menu item from Connection Manager menu. A blank diagram canvas will open and you can start dragging tables from Object Explorer. At some point do not forget to save your work. You can find the Save button in the form of a floppy disk in the main toolbar at the top. Next time you start tadpole, the saved ERD diagrams will be there for you under the connection it belongs to in the Connection Manager.

What's next

Since Tadpole is still in its early development stage, there are many great features we can expect in coming versions. The developer has told that he is working on the following items:

  • Database Monitoring
  • Database Migration from one DB Server to another
  • Test Data Generation
  • PostgreSQL, DB2 and Cassandra support
  • Improved basic functionality
  • NoSQL modeling tool

When new version arrives, we will write more tutorials. So bookmark this page if you passionately wait for new features from Tadpole.

comments powered by Disqus
Page info
viewed 7796 times
translations en
Author
posted 2 years ago by
CUBRID
Contributors
updated 2 years ago by
View revisions
tagged
Share this article