Skip to content

RDB User Guide Eng

Jump to bottom
Cho HyunJong edited this page Aug 28, 2014 · 42 revisions

Date : 17 Aug 2013 Written : HyunJong Cho(hangum@gmail.com)

Tadpole DB Hub User Guide

Welcome to Tadpole! This is a web-based DB Query tool. You can connect to variety of database in web browser and can control function for each users(user or admin or dba and so on). The goal is a DB HUB for all DB.

Now we are supporting - Amazon RDS, CUBRID, MarisDB, Oracle, MySQL, MSSQL, PostgreSQL, SQLite, MongoDB. Tadpole lets you creatively focus on your project by simply the amount of work needed for a given task.

List of tested

  • Amazon RDS : aws-java-sdk-1.4.7
  • CUBRID : 8.4.x ~
  • Oracle : 10g ~
  • MySQL : 5.4.x ~
  • MariaDB : 5.5.x ~
  • MSSQL : 2000 ~
  • PostgreSQL : 9.1.x ~
  • SQLite : 3.7.2 ~
  • MongoDB : 2.0.5 ~

Documentation

This is explain for RDBMS.

Agenda

Install

  1. JAVA 1.7.x
  2. Linux, Mac, Windows, Tomcat 6.x (If you want to user the other O.S, connect me : adi.tadpole@gmail.com)
  3. Download - https://code.google.com/p/tadpole-for-db-tools/downloads/list
  4. Reference more : https://github.com/hangum/TadpoleForDBTools/issues?direction=desc&sort=created&state=open

Standalone installation

  1. Execute TadpoleDBHub-1.x.x\tadpole-standalone.exe
  2. After install, automatically run a web-browser(OR you can install the TadpoleForDBToolsStartup by double click). It will happen to you when you first start that you can't find the page to the web-browser cause engine is starting. Don't freak out. Let's click F5(Refresh).
  3. Open the web-browser and start 'http://127.0.0.1:10081/tadpole' ps) Tadpole DB is TadpoleDBHub-1.x.x/configuration/tadpole/db/tadpole-system.db. Please install new version and backup.

Install Tomcat

  1. Did you have installed Tadpole before? OK. Please backup a apache-tomcat-6.x.x/work/Catalina/localhost/tadpole/eclipse/configuration/tadpole/db/tadpole-system.db file. And delete apache-tomcat-6.x.x/work directory.
  2. Change war name to tadpole.war from TadpoleDBHub1.x.x-tadpole.war.
  3. The WAR file should be in the webapp directory path. And Tomcat should be installed and running.
  4. If the context root is tadpole, start http://127.0.0.1:8080/tadpole/tadpole in the web-browser.
  5. If you upgrade to datas of old data, copy to tadpole-system.db from a backup file(number1. apache-tomcat-6.x.x/work/Catalina/localhost/tadpole/eclipse/configuration/tadpole/db/tadpole-system.db) in same directory.

Login

Login

  1. Test mode window.
  2. Tadpole has Admin, Manager, User(Developer). First DEFAULT USER made.
  1. If you want to try test mode, you don't need to EMAIL ADDRESS, PASSWORD. We supported 'admin login/user login' for test mode.
  2. Add new user : (https://github.com/hangum/TadpoleForDBTools/wiki/RDB-User-Guide-Eng#create-a-new-user)

The whole view of Tadpole

Tadpole part

  1. Toolbar(https://github.com/hangum/TadpoleForDBTools/wiki/RDB-User-Guide-Eng#toolbar) : Connection DB, save, authority(if it is a 'manager' or an 'admin' user), environment and so on.
  2. Database List(https://github.com/hangum/TadpoleForDBTools/wiki/RDB-User-Guide-Eng#database-list) : New create DB, delete, shared user's data.
  3. Object Explorer(https://github.com/hangum/TadpoleForDBTools/wiki/RDB-User-Guide-Eng#object-explorer) : Show the Object(Table, View)' list of selected to the Database List.
  4. Main UI(https://github.com/hangum/TadpoleForDBTools/wiki/RDB-User-Guide-Eng#sql-editor) : Show the DB Query editor, MongoDB profile viewer and main job viewer.

Toolbar

A toolbar is a GUI widget on which on-screen buttons, icons, menu, or other input or output elements are placed. And limited permission. 'Manager' can use all function, 'User' can't create DB, delete, profile functions.

toolbar

  • Show connection DB window.
  • Save data in current SQL Editor.
  • Show SQL Editor selected 'Database List' window.
  • Show ERD Editor selected 'Database List' window.
  • Delete shared resources selected 'Database List' window.
  • Show user, db information.
  • Show history information all DB.
  • Show environment information.
  • Show bug, request issues.(need to Github account)
  • Show system preferences.
  • Close button.(If standalone, program shutdown, or run Tomcat, logout)

Database List

Display DB list which do allow the connections. Use shared connection information to user in same groups.

Add DB and Use

Only Manager permission user can add DB.

Add DB : Toolbar connection-toolbar-btn click.

connection dialog

  1. DB List for connection
  2. System preference to management Tadpole
  • Server type : Input DB of server type
  • Server type -> Production Server : You are able to add a new admin user directly to the database. Then generate user can SELECT in the SQL Editor, we are marked to edit frame red color.
  • Server type -> Developer Server : This is development DB and you can do all thing for except permission.
  • Server type -> Others Server : This is add other uses of a DB and you can do all thing for except permission.
  • Group : DB group to add each other easier.
  • Name : DB name for Database List.
  1. Input database information selected no.1.
  2. Additional information connected no.2.
  • Readonly Connection : Can't delete, update and so on connected DB. Only SELECT statements is possible in SQL Editor.
  • Auto Commit : When the auto-commit mode is enabled, the operation commits the transaction immediately after an INSERT, UPDATE or DELETE operation. When auto-commit is disabled, the transaction must be committed (through the effective SQL session) as required.
  • Table Filters : The filter is hidden and shown in the 'Object Explore'.
  • Profile : Query description, query execution time, monitor, result, and measure your application's SQL statements and stored procedures.
  • Show Tables : Display all of the tables in 'Object Explore'. When single schema has large tables, hide table and it prevent much slow for current status.
  • Execute after the confirmation message except SELECT : It must execute after the confirmation message except SELECT in SQL Editor.
  1. Test, Save, Cancel to saved DB.
  • Test Connection : Display the information, when it is possible for a connection to input information of no.2.
  • Confirm : Add input DB connection information.
  • Cancel : Cancel add DB and close job..

Warning) SQLite database file to be worked on as an absolute path of your hdd executed Tadpole DB Hub. It is not local path connected user as "C:\TEMP\SQLite.DB".

Connected DB

If you add DB in the 'Database List', display in the group. And open SQL Editor of DB.

connection-2

  1. Display 'DB icon [D] create name (account information)'. DB name tag
  • First : DB list
  • [D] : acronym of Developer Server. Production Server is [P], Others Server is [O].
  • Input name to create window.
  • Added account DB information. (Normal user can't see).
  1. If you select DB, display Object(For example, Managing selected Tables of DB, Views, Indexes, Procedures, Functions, Trigger) to 'Object explore'.
  2. If you double-click DB, open SQL Editor.
  3. If you select DB, and right-click display

<2013.08.25.23:24 시작.>

If it is a SELECT DB after, right-click on this mouse, display action for execute as user permission.

  • Refresh : Search again from the 'Database List' for the newest.
  • SQL query window : open SQL Editor - Administer -> Session List : Display Session List of DB.
  • Administer -> Delete Database : Remove DB. Notice! DROP database drops all tables in the database and deletes the database and connected DB information.
  • ERD -> All Table ERD : Display relationship by referential integrity.
  • ERD -> Create ERD : Display window to draw ERD, drag and drop tables to 'Object Explore'.
  • Create DML : Display CREATE TABLE, VIEW, Index, Procedure, Function, Trigger template in the SQL Editor.

Object Explorer

If database selected in the Database List, display Table, View, Indexes, Procedures, Functions, Triggers information of Object Explorer'.(Display current running objects)

objectExplorer

Explain table based and same the other object(Views, Indexes, Procedures..).

  1. Search table name.
  • Input Object name and command enter.
  • Don't care upper case and lower case.
  1. Display table name, description. Display column list of ③, when you click the table name.
  • Double click Table name -> display select query in SQL Editor.
  • Display comments on table name Table to mouseover event.
  • You can modify comment in grid windows for Oracle, MSSQL DB.
  1. Display column of table information selected ②.
  • You can modify comment in grid windows for Oracle, MSSQL DB.
  1. There is Procedure run button in Procedure. [Next]

Select Table > Right-click and select Create > Here is the functions. (It is different as permission.)

Object Explorer popup

  • Create Table : Create to SQL Editor what create table query in template.
  • Drop Table : Drop the table.
  • Refresh Table : Refresh Table List.
  • Generate Sample Data : Display dialog generate sample data selected table to Oracle.
  • Generate Statement : Select : Display selected select query of table in SQL Editor.
  • Generate Statement : Insert : Display selected insert query of table in SQL Editor.
  • Generate Statement : Update : Display selected update query of table in SQL Editor.
  • Generate Statement : Delete : Display selected delete query of table in SQL Editor..
  • View DDL : Display selected DDL table in SQL Editor.
  • Table Data Editor : Display data to grid for modify data of table.

SQL Editor

SQL Editor is a database query editor window. Double click the database in the 'Database List' Manager or double click the table in the 'Object explore', or execute template, then you can use SQL Editor. The semicolon(;) as a separator of all query in the SQL Editor. If you create Procedure, input multi line semicolon(;). Then it is not a valid rules. Ok I will solve the problem. You can execute drag block. If you click 'Ctrl + Space(Mac : Command + Space)'in the SQL Editor, display table list. Then you can write sql statement at all.

sqleditor

  1. SQL Toolbar : Quick collection shortcuts of number 2. SQLEditorToolbar

  2. Toolbar

  • Display DB information connected to SQL Editor .
  • Execute : The shell command execute in the query editor. If there is select the block with mouse in the query editor, execute the block query statement and display the result in the query editor.
  • Execute ALL : Displaying about executes all SQL statements in the query editor.
  • Execute Plan : Displaying about describes the SQL statements EXPLAIN PLAN, and explains how to interpret its output.
  • Format SQL : Sorting SQL statements formatter/beautifier.
  • SQL to Application : Converting SQL statements to Java or PHP.
  • Download SQL : Downloding SQL statements to local file.
  • Auto Commit : Execute to Auto-Commit mode for DDL.
  • Commit : Disabled AutoCommit. And if you used to disabled auto-commit mode, commit executed query in DB.
  • Rollback : Disabled AutoCommit. And if you used to disabled auto-commit mode, rollback executed query in DB.
  • Display help in the editor.
  1. Query editor : Executing DML, DDL statements.
  • Input executed sql statements and append such a semicolon at the end. There is no each SQL command with a semicolon, it will consider the execution of a SQL statement.
  • Execute drag and drop the blocks you need from the sql statements, it will consider the execution of a SQL statement. And create Procedure too. You can use the middle query you executed for test. SQLEditor blockquery
  1. Supported shortcut to SQL Editor
  • Windows, Linux : Ctrl key, Mac : Command key.(Explain about windows)
  • Which displays a list of all the keyboard shortcut like eclipse -> Ctrl + Shift + l
  • Save: Ctrl + S
  • Execute SQL statements: Ctrl + enter, F5
  • Optimizer: Ctrl + E
  • Sort query : Ctrl + Shift + F
  • Move current selection: Ctrl + H
  • Convert lowercase to blocking : Ctrl + Shift + Y
  • Convert uppercase to blocking : Ctrl + Shift + X
  • Displays a list of all the keyboard shortcut combinations : Ctrl + Shift + L
  • Delete all : F7
  • Selects all : Ctrl + A
  • Move to selected line in the editor : Ctrl + L
  • Copy to user blocking : Ctrl + C
  • Press Ctrl-C to paste : Ctrl + V
  • View table list : Ctrl + Space
  • Delete from cursor to end of line : Ctrl + D
  1. Result SQL
  • Result SQL : Display result SQL. If you double-click column of result table, display the data to pop-up. If you click Export CSV Data button, downloading data to user's computer. Here the picture. If you are in an input to 'city=r', searching include 'r' in city column. If you are not in an input anything, searching all columns. QueryResult
  • Executed sql statements : Display current executing query and query information. If you click import SQL or double-click query, insert sql statements to SQL Editor. 'View detail' is viewing query in dialog. 'Export' is save SQL statements to local file. 'Delete' is deleted sql statements. 'Refresh' button search and get executed all query statements. ResultQueryHistory
  • Message : Display error message when you run a query. Export data or double-click, you can see more detail. result-message

ERD

ERD select a database in the 'Database List' and select the ERD of toolbar erd button, after select database, click the right-button and you can erd-popup execute.

  1. All Table ERD : Arrange all tables of the database in the ERD editor
  2. Create ERD Diagram : To open a ERD editor for ERD arrange user only wants tables Drag & drop SQL editer after select mouse on Tables of 'Object Explorer' what users wants tables.

erd

Table auto sort option : Open a popup window after a button right-click in the editor and click 'Tree Auto Layout'. So sorting user of user lists in a visually readable format.

Configuration

preference

  1. General tab : Input separator when you try to Session and Export.
  2. MongoDB tab : Setting the default limit count and max count information.
  3. RDB tab : Setting the select limit value and page count value.
  4. User tab : Change user password.

Create a new user

  1. Click the New button in the login page.

new user

AddUser

Users must register as a group member.

  • User type : Manager : Create user groups. Get a manager of the permissions. Manager can Create / Remove DB and User. Share what's new member in groups, db and user sql statements, ERD and so on. You don't have permission to access to system before confirm administrator.(If test mode in the system, you have created an automatic approval.)
  • User type : DBA : DBA User in groups. DBA can create, remove and at all.
  • User type : User : Create a user. Limit part functions.

If all user can use and connect, you need your parent permission to access.

Table Data Editor

  • If you have primary key, you can edit.
  • where : select table again to db.
  • filter : filtering only current window.
  • Data edit : click column and after change to edit mode from view mode.
  • Data save : finished edit data, click save button.

direct editor

Procedure

  • Oracle, MariaDB, MySQL, MSSQL can execute Procedure.

procedure-info-view

  • Blue icon is successed, yellow icon is failed or syntax error or dependent errors in the Procedure. Then you can debug object error and after compile to user View DDL function.
  • Display execte window double click or click pop-up 'Execute Procedure'

procedure-execute-dialog

Session List

  • MariaDB, MySQL can see Session List

session-list

Session List is displayed Session list executed in the DB. And you can close Long time to execute or shutdown query.

  1. Collection shortcuts of Session List.
  2. Display current sql statements.
  3. If you select query of number ②, display SQL statements executed query.

User Management

User list of group, manage db list and add a user, change stop use. Or select executed query list of user, but only administrator and DBA can be use.

UserManagement

Display all user list, if you click user, display 'Executed SQL Management'. This is executed previously is executed again on the viewer.

Executed SQL Management

You will search job history, and if you double click to the history, copy to SQL Editor. Then you can test the job.

ExecutedSQLManagement

Developer Guide

RDB User Guide

MongoDB User Guide

RDB Tutorial

Clone this wiki locally