Skip to content

RDB User Guide Eng

Jump to bottom Edit New page
suhyunjeon edited this page Aug 23, 2013 · 41 revisions

Date : 17 Aug 2013 Written : HyunJong Cho([email protected])

Tadpole for DB Tool User Guide

Welcome to Tadpole! This is a web-based DB Query tool. You can connect variety DB 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.6.x(Mac 1.7.x)
  2. Linux, Mac, Windows, Tomcat 6.x (If you want to user the other O.S, connect me : [email protected])
  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-Kor#%EC%8B%A0%EA%B7%9C-%EC%9C%A0%EC%A0%80-%EB%93%B1%EB%A1%9D)

The whole view of Tadpole

Tadpole part

  1. Toolbar(https://github.com/hangum/TadpoleForDBTools/wiki/RDB-User-Guide-Kor#%ED%88%B4%EB%B0%94) : 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-Kor#%EB%8D%B0%EC%9D%B4%ED%84%B0%EB%B2%A0%EC%9D%B4%EC%8A%A4-%EB%AA%A9%EB%A1%9D) : New create DB, delete, shared user's data.
  3. Object Explorer(https://github.com/hangum/TadpoleForDBTools/wiki/RDB-User-Guide-Kor#%EC%98%A4%EB%B8%8C%EC%A0%9D%ED%8A%B8-%ED%83%90%EC%83%89%EA%B8%B0) : Show the Object(Table, View)' list of select to the Database List.
  4. Main UI(https://github.com/hangum/TadpoleForDBTools/wiki/RDB-User-Guide-Kor#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, menus, or other input or output elements are placed. And limited permission. 'Manager' can user 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 : If you have user p운영 DB로 등록하여 일반 사용자권한의 유저는 SQL Editor에서 SELECT만 실행 할수 있으며, 에디터의 테두리를 빨간색으로 표시하여 식별이 용이하도록 하였습니다.
  • 운영 타입 -> Developer Server : 개발용 DB로 등록하며 권한에 제약없이 모든작업이 가능합니다.
  • 운영 타입 -> Others Server : 기타용도의 DB로 등록하며 권한에 제약없이 모든작업이 가능합니다.
  • 그룹 : DB의 연결 정보를 사용 용도나 업무 연관성에 따라 그룹별로 등록하여 관리할 수 있습니다.
  • 이름 : DB가 데이터베이스 탐색기에서 표시될 이름을 입력합니다.
  1. 1번 항목에서 선택 된 데이터 베이스 정보를 입력합니다.
  2. 2번 항목에서 연결된 정보의 부가 정보 입니다.
  • Readonly Connection : 연결된 디비는 삭제, 수정 조작명령을 할 수 없습니다. SQL Editor에서 SELECT 명령만 가능한 연결을 합니다.
  • Auto Commit : SQL Editor에서 INSERT, UPDATE, DELETE 쿼리 실행후 DBMS에 자동또는 수동 Commit 여부를 지정합니다.
  • Table Filters : 오브젝트 탐색기에 목록을 표시하거나 숨길 테이블에 대한 필터링 대상을 등록하고 관리합니다.
  • Profile : 사용자가 SQL Editor에 입력한 쿼리를 저장하며 쿼리내용, 실행소요시간, 정상처리여부 등을 저장합니다.
  • Show Tables : 오브젝트 탐색기의 테이블 목록을 보여줄지 여부를 설정합니다. 단일 스키마에 대량의 테이블이 존재할때 해당 테이블을 표시하지 않도록 하여 사용자 화면의 반응속도가 과도하게 느려지는것을 방지할 수 있습니다.
  • SELECT가 아닌SQL 문은 확인 후 실행 : SQL Editor에서 SELECT 이외의 모든 쿼리는 실행 전에 사용자에게 확인 후 실행 하도록 합니다.
  1. 입력 된 DB를 테스트, 저장, 취소합니다.
  • Test Connection : 2번 항목에 입력한 정보로 DB연결이 가능한지 확인 후 결과를 표시합니다.
  • 확인 : 입력된 DB 연결정보를 등록 합니다.
  • 취소 : DB 등록 작업을 취소하고 등록작업을 종료합니다.

주의) SQLite 인 경우 Tadpole DB Hub가 실행중인 컴퓨터의 하드디스크의 절대경로입니다. 사용자가 접속한 컴퓨터의 로컬 경로가 아니므로 주의 해야 합니다.

연결된 DB

DB를 등록하면 '데이터베이스 목록' 창에 입력한 그룹에 표시됩니다. 또한, DB의 SQL Editor창이 열립니다.

connection-2

  1. DB는 'DB아이콘 [D] 등록이름 (개정정보)' 표시 됩니다. DB name tag
  • 첫 번째는 DB의 종류입니다.
  • [D]는 Developer Server의 약어입니다. Production Server는 [P]로 표시되면 Others Server는 [O]로 표시됩니다.
  • 등록화면에서 입력했던 이름 입니다.
  • 등록했던 DB의 계정 정보입니다. (일반사용자 권한의 유저는 보이지 않습니다)
  1. DB를 선택하면, '오브젝트 탐색기'에 Object(예를 들어. 선택된 DB의 Tables, Views, Indexes, Procedures, Functions, Trigger 등을 관리합니다.)가 표시됩니다.
  2. DB를 더블 클릭하면 SQL Editor창이 열립니다.
  3. DB를 선택 후 마우스 오른쪽 버튼을 클릭하면 사용자 권한에 따라 실행 가능한 액션이 표시 됩니다.
  • Refresh : '데이터베이스 목록'창을 최신정보로 다시 조회합니다.
  • SQL 쿼리 창 : SQL Editor 창이 열립니다.
  • Administer -> Session List : DB의 Session List를 보여줍니다.
  • Administer -> Delete Database : DB를 삭제합니다. 모든 사용자의 DB 연결정보가 삭제되니 신중하게 선택해야 합니다.
  • ERD -> 모든 테이블 ERD : DB의 모든 테이블의 참조무결성 제약조건을 기준으로 하여 관계를 표시합니다.
  • ERD -> ERD 기본창 생성 : ERD을 그릴 수 있는 창이 표시 되며 '오브젝트 탐색기'에서 테이블들을 끌어다 놓을 수 있습니다.
  • DML 생성 : CREATE TABLE, VIEW, Index, Procedure, Function, Trigger 문의 템플릿을 SQL Editor에 표시합니다.

< 윗 부분 작업예정, 아랫 부분 작업 중 : 20130818 전수현>

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)' SQL Editor 창에서 Ctrl + Space(Mac은 Command + Space)를 누르면 테이블 목록이 표시되며 표시된 목록에서 선택하여 쿼리를 작성할 수 있습니다.

sqleditor

Add a custom footer
Add a custom sidebar
Clone this wiki locally