Product Documentation. Quick Start Guide. Version 8.7.5/XE6 Published May, 2015

Transcription

1 Prduct Dcumentatin Quick Start Guide Versin 8.7.5/XE6 Published May, 2015

2 2015 Embarcader Technlgies, Inc. Embarcader, the Embarcader Technlgies lgs, and all ther Embarcader Technlgies prduct r service names are trademarks r registered trademarks f Embarcader Technlgies, Inc. All ther trademarks are prperty f their respective wners. Embarcader Technlgies, Inc. is a leading prvider f award-winning tls fr applicatin develpers and database prfessinals s they can design systems right, build them faster and run them better, regardless f their platfrm r prgramming language. Ninety f the Frtune 100 and an active cmmunity f mre than three millin users wrldwide rely n Embarcader prducts t increase prductivity, reduce csts, simplify change management and cmpliance and accelerate innvatin. The cmpany's flagship tls include: Embarcader Change D Studi, DBArtisan, Delphi, ER/Studi, JBuilder and Rapid SQL. Funded in 1993, Embarcader is headquartered in San Francisc, with ffices lcated arund the wrld. Embarcader is nline at May, 2015 Embarcader Technlgies 2

3 CONTENTS Intrducing Rapid SQL... 5 Abut Rapid SQL... 5 Installing and Licensing Rapid SQL... 7 Technical Requirements and DBMS Supprt... 8 Installing Rapid SQL... 9 Licensing Yur Prduct Licensing Yur Applicatin Rapid SQL Tutrial exercises Sessin 1: Getting Started Sessin 2: Prductivity Enhancers Sessin 3: Scripting Sessin 4: Wrking with Cde Wrkbench Sessin 5: Building a Database Prject Sessin 6: Visual Query Builder Sessin 7: Live Data Editr Sessin 8: Cde Analyst Sessin 9: SQL Debugging and Prfiling Embarcader Technlgies 3

4 Embarcader Technlgies 4

5 Intrducing Rapid SQL Intrducing Rapid SQL Rapid SQL is an integrated develpment envirnment that enables develpers t create, edit, versin, tune, and deply server-side bjects residing n Micrsft SQL Server, Oracle, Sybase Adaptive Server, InterBase/Firebird, IBM DB2 fr Linux, Unix, and Windws, and IBM DB2 fr z/os databases. Its unified database develpment envirnment prvides extensive graphical facilities that simplify SQL scripting, bject management, reverse engineering, database prject management, versin cntrl and schema deplyment. With Rapid SQL, prgrammers can develp and maintain high-quality, high-perfrmance client/server and web-based applicatins in less time, and with greater accuracy. Abut Rapid SQL Yur new applicatin prvides tls that can be used by a number f functins within an rganizatin using DBMS frm multiple vendrs, in testing, develpment, r prductin envirnments. Datasurce management tls - Datasurces must be registered. Datasurces can be registered manually r semi-autmatically. Strage can be registry-based r file-based, and a netwrk strage ptin facilitates shared use f datasurce catalgs. Object management tls - Yur applicatin supprts a wide range f database bjects and related elements fr each DBMS. Yu can create new bjects, edit existing bjects, and use a range f bject peratins that supprt cmmn, general r DBMS-specific actins. Cding Envirnments/Editrs - Fully-featured envirnments dedicated t SQL, DDL and Active Script develpment are prvided. Executin ptins are available as apprpriate, and envirnment-specific related features, such as rllback/cmmit and query plan ptins, are prvided. Related cding aids include n-the-fly semantic and syntactic validatin, text substitutin shrtcuts, and visual query building tls. Related executin tls include script and file executin facilities. Prject Management, Versin Cntrl, and Script Library - Rapid SQL database prject management facilities help yu rganize, alter, and keep track f changes t database bjects r SQL scripts. The prject management facilities act as a repsitry t maintain all surce cde fr a database prject. Rapid SQL als incrprates versin cntrl functins and build management facilities t help yu manage and build prjects. Other Time-savers and Prductivity Tls - Wrking within the Rapid SQL envirnment, yu have access t database and file search facilities, use visual difference t cmpare files r database bjects, and access the Micrsft Windws task scheduler. License-specific Add-ns - Depending n the licenses yu purchased, yu have access t the fllwing tls: The Rapid SQL Cde Analyst helps yu identify time-cnsuming lines f cde. It lets yu perfrm detailed respnse time analysis, benchmark the executin f ne r mre prcedures r functins, save respnse time metrics, and perfrm intelligent cmparisns against current executin times. Embarcader Technlgies 5

6 Intrducing Rapid SQL Debuggers, available fr IBM DB2 fr Linux, Unix, and Windws, Oracle, Sybase, and SQL Server, let yu test functins and prcedures. A Prfiler is available fr Oracle datasurces. Embarcader Technlgies 6

7 Installing and Licensing Rapid SQL Installing and Licensing Rapid SQL Befre yu can register any Embarcader Technlgies applicatin, yu must meet the minimum technical requirements. If yu meet all the minimum technical requirements, yu can install Rapid SQL. After installatin, yu must license the applicatin. The fllwing tpics walk yu thrugh this prcess: Technical Requirements and DBMS Supprt Installing Rapid SQL Licensing Yur Prduct Embarcader Technlgies 7

8 Installing and Licensing Rapid SQL Technical Requirements and DBMS Supprt Fr system requirements and details n DBMS prduct supprt in Rapid SQL, see the Read Me at Embarcader DB Team Server Supprt Rapid SQL can make use f datasurce definitins stred n an Embarcader DB Team Server. Fr details, see the nline help. Generic JDBC and ODBC Supprt Generic JDBC/ODBC cnnectivity t nn-dedicated DBMS systems r nn-database datasurces is als prvided. Rapid SQL can cnnect t a datasurce using a custmer-prvided, third-party JDBC versin 3.0 r ODBC versin 3.0 driver. Minimal Rapid SQL functinality is prvided, including a basic Explrer tree and SQL querying. IBM DB2 fr Z/OS Stred Prcedure Requirements When wrking against an IBM DB2 fr z/os data surce, Rapid SQL relies n the fllwing stred prcedures, prvided as an ptinal installatin step in setting up the DB2 subsystem: DSNWZP DSNUTILS ADMIN_COMMAND_DSN ADMIN_COMMAND_DB2 Prir t using Rapid SQL against an IBM DB2 fr z/os data surce, ensure that these cmpnents are installed n the server. See IBM DB2 fr z/os dcumentatin fr mre infrmatin. Embarcader Technlgies 8

9 Installing and Licensing Rapid SQL Installing Rapid SQL T install the applicatin successfully, yu must cmplete each panel f the installatin wizard. 64- bit and 32-bit versins f Rapid SQL are available with the trial versin, which can be dwnladed frm The Rapid SQL installatin wizard installs all crrespnding files n yur machine. The installer ffers cmmn ptins such as license agreement, file and flder selectins, and shrtcut ptins. An applicatin-specific ptin lets yu assciate file suffixes f elements such as SQL scripts with Rapid SQL. NOTE: Befre installing Rapid SQL frm Embarcader TlClud, see fr additinal requirements r revised instructins. The panels presented by the wizard vary depending n whether yu are upgrading r perfrming an initial installatin. Cautin: If yu have nt registered a license when yu start a Rapid SQL installatin, yu will be prmpted t register a license. Fr mre infrmatin, see Licensing Yur Prduct. After the installatin is cmplete, we recmmend that yu rebt yur machine befre using Rapid SQL. Embarcader Technlgies 9

10 Installing and Licensing Rapid SQL Licensing Yur Prduct Each Embarcader client applicatin requires ne r mre licenses in rder t run. An Embarcader prduct, such as Rapid SQL, has a baseline license which prvides basic feature supprt fr that prduct. In additin, incremental licenses may be required t supprt specific DBMS platfrms, prduct add-ns, r ther functins. Fr mre infrmatin, see the fllwing tpics: Licensing Overview Licensing Yur Applicatin Selecting a License Categry During Startup Online/Offline Mde and Cncurrent License Checkut Embarcader Technlgies 10

11 Installing and Licensing Rapid SQL Licensing Overview The fllwing tpics prvide a high-level discussin f key licensing tpics and directs yu t surces f mre detailed infrmatin. Viewing Yur License Type and Mdules Understanding Trial, Wrkstatin, and Netwrked Licenses Rapid SQL License Mdules, DBMS Supprt, and Feature Availability Rapid SQL XE License Mdules, DBMS Supprt, and Feature Availability Directing Queries Regarding Licenses Viewing Yur License Type and Mdules The Abut... dialg, available frm the Help menu, displays yur license type and each individual license mdule currently registered. Understanding Trial, Wrkstatin, and Netwrked Licenses Three kinds f licenses are available: Trial, Wrkstatin, and Netwrked. Trial licenses A license fr a 14-day, full-featured trial versin f the prduct. The trial license must be registered befre yu can use the prduct. Wrkstatin licensing Netwrked licensing A license r set f licenses is tied t a particular wrkstatin. The prduct can nly be used n that wrkstatin. Netwrked licenses are administered and distributed by a central License Server (Embarcader License Center r Acress FLEXnet Publisher). There are tw types f netwrked licenses: Cncurrent and Netwrked Named User. With Cncurrent licensing, users n different machines take turns using licenses frm a shared pl. With Netwrked Named User licensing, licenses are pre-assigned t specific users setup n the license server's user list. Thse users are guaranteed t have licenses available any time. NOTE: Cncurrent licenses can be brrwed fr use withut a netwrk cnnectin. Fr details, see Online/Offline Mde and Cncurrent License Checkut. Fr a detailed descriptin f licensing ptins, see Rapid SQL License Mdules, DBMS Supprt, and Feature Availability Individual license mdules crrespnd t the DBMS platfrms yu are licensed t use. In additin, each DBMS license mdule crrespnds t a prduct editin. Feature availability fr each license mdule editin is as fllws: Standard - Prvides baseline supprt including datasurce management, bject management, SQL editing and executin, and standard tls and utilities. Prfessinal (Rapid SQL) - Standard editin features plus SQL Debugger, SQL Prfiler, and Cde Analyst. Embarcader Technlgies 11

12 Installing and Licensing Rapid SQL Rapid SQL XE License Mdules, DBMS Supprt, and Feature Availability An XE license prvides access t all supprted DBMS platfrms. XE mdule and feature availability is as fllws: XE Pr (Rapid SQL) - Prvides baseline supprt including datasurce management, bject management, SQL editing and executin, and standard tls and utilities, SQL Debugger, SQL Prfiler, and Cde Analyst. Directing Queries Regarding Licenses Questins regarding license availability, feature availability, and client r server licensing, shuld be directed as fllws: If yu wrk in an rganizatin that uses netwrked licensing, direct any questins t yur If yu are using wrkstatin licensing, direct licensing questins t yur Embarcader Technlgies representative. Embarcader Technlgies 12

13 Installing and Licensing Rapid SQL Licensing Yur Applicatin See the fllwing tpics fr details n registering yur prduct: Registering a Trial r Wrkstatin License during Installatin Registering a Wrkstatin License After Applicatin Startup Registering By Phne Registering a Netwrked License Registering a Trial r Wrkstatin License during Installatin Shrtly after initiating dwnlad f a trial versin f an Embarcader prduct, yu shuld receive an with a serial number yu must register during installatin. Similarly, if yu purchase an Embarcader prduct while n trial versin is active, yu will receive a serial number that must be registered during installatin. 1 Start the installatin. An Embarcader License Registratin dialg appears. 2 Cpy the serial number frm the and paste it in the Serial Number field. 3 Enter yur Embarcader Develper Netwrk accunt credentials in the Lgin r and Passwrd fields. If yu have nt previusly created an EDN accunt, r have frgtten yur passwrd, click I need t create... r. 4 Click Register. Yur activatin file shuld be dwnladed and installed autmatically. If this des nt happen, click the Truble Cnnecting? Try Web Registratin link and fllw the prmpts. If yu still have prblems, see Registering By Phne. Registering a Wrkstatin License After Applicatin Startup The fllwing instructins assume that yu have received a wrkstatin license by and that yu currently have a valid trial license. If yu did nt install a trial versin r the trial perid has expired, fllw the instructins in Registering a Trial r Wrkstatin License during Installatin instead. 1 On the Help menu, select Abut, and then n the dialg that pens, click Manage t pen a license manager dialg. 2 On the Serial menu, select Add. 3 Cpy the serial number frm the and paste it in the Add Serial Number dialg, then click OK. Embarcader Technlgies 13

14 Installing and Licensing Rapid SQL 4 Right-click n the serial number yu added, and then select Register frm the cntext menu. A registratin dialg pens. Nte: The Registratin Cde bx shws a machine-specific identifier required with ther registratin methds. 5 Ensure that the Register using Online Registratin radi bx is selected. 6 Prvide Develper Netwrk credentials in the DN Lgin name r and DN Passwrd bxes. If yu have nt previusly created an EDN accunt, r have frgtten yur passwrd, click I need t create... r. 7 Click Register. 8 If prmpted t restart the applicatin, click Yes. Yur activatin file shuld be dwnladed and installed autmatically. If this des nt happen, click the Truble Cnnecting? Try Web Registratin link and fllw the prmpts. If yu still have prblems, Registering By Phne. Registering By Phne If yu have prblems with either f the abve prcedures, yu can register licenses by phne. Yu will have t prvide: Develper Netwrk credentials The registratin cde displayed in the Embarcader License Registratin dialg that appears when yu start an unlicensed applicatin The prduct base license serial number The license serial numbers fr any additinal features yu have purchased. Fr Nrth America, Latin America and Asia Pacific, call (415) ptin 2 and then fllw the prmpts. The hurs are Mnday t Friday, 6:00 A.M. t 6:00 P.M. Pacific time. Fr Eurpe, Africa and the Middle East, call +44 (0) The hurs are Mnday t Friday, 9 A.M. t 5:30 P.M. U.K. time. Shrtly after phning in, yu will receive an cntaining an activatin file. Then d the fllwing: 1 Save the file t the desktp r a scratch directry such as c:\temp. 2 On the Help menu select Abut and then n the dialg that pens, click Register. A registratin dialg pens. 3 Select the I have received an activatin file (*.slip r reg*.txt) radi bx. 4 Click the Brwse buttn and use the Select License Activatin File dialg t lcate and select the activatin file yu installed. 5 Click the Imprt buttn t imprt the activatin file and when cmplete, click the Finish buttn. Embarcader Technlgies 14

15 Installing and Licensing Rapid SQL 6 If prmpted t restart the applicatin, click Yes. Registering a Netwrked License If yu wrk in an rganizatin using Netwrked licensing, an administratr, department head, r smene perfrming a similar functin will prvide yu with an activatin file. Once yu receive the file, save it t the license subfld (typically C:\Prgram Files\Embarcader\<prduct><versin>\license\), then restart the applicatin. N additinal steps are necessary. Embarcader Technlgies 15

16 Installing and Licensing Rapid SQL Selecting a License Categry During Startup During startup, if multiple cncurrent license categries are available, yu are prmpted t select a categry t use fr this Rapid SQL sessin. Multiple license categries can be set up t prvide differing feature access r access t different DBMS versins. Feature and DBMS versin access are licenses. Nte: This dialg als includes the ptin t remember yur selectin n subsequent startups. If yu select that ptin, yu can subsequently use the Select Licenses buttn n the Abut... dialg (Help > Abut) t select a different license. Cntact yur License Administratr fr details n individual license categries r requests fr additinal feature r DBMS supprt. Embarcader Technlgies 16

17 Installing and Licensing Rapid SQL Online/Offline Mde and Cncurrent License Checkut Cncurrent licenses can be used in bth nline and ffline mdes. In nline mde, yu must have a cntinuus netwrk cnnectin t yur License Center. Licenses are checked ut n startup and checked back in n shutdwn. Yu can als use a license in ffline mde. When yu explicitly check ut a license fr ffline use, yu can use the license withut a cnnectin t yur License Center fr a specified duratin. This lets yu wrk while travelling r cmmuting, wrk away frm yur primary wrk area, r use the license when a netwrk cnnectin is unavailable r nt required. Nte: Cntact yur site administratr fr infrmatin n ffline license availability, the maximum duratin, ffline license plicy at yur site, r any ther issues arising frm nline license usage. T check ut a license fr ffline use: 1 On the Help menu, select Checkut License. The Check Out Licenses Fr Offline Use dialg pens. 2 Select the check bx assciated with each individual license yu want t check ut. 3 In the Checkut Duratin bx, type the number f hurs that yu can use the ffline license withut a netwrk cnnectin t the License Center. 4 Click OK. Yu can wrk ffline fr the specified duratin. The duratin perid begins immediately. If yu subsequently establish a netwrk cnnectin t the License Center befre the license duratin expires, yu can indicate t the License Center that the ffline license is n lnger required. T indicate that an ffline license is n lnger required: 1 On the Help menu, select Checkin License. There is n interruptin in Rapid SQL usage. The license is nt actually checked in until yu shut dwn Rapid SQL. Embarcader Technlgies 17

18 Rapid SQL Tutrial exercises Rapid SQL Tutrial exercises The exercises that fllw walk yu thrugh the Rapid S cmpleting these exercises, yu will have the fundatin yu need t explre the many features administratin and develpment tls prvided. This guide is divided int a set f sessins: Sessin 1: Getting Started Sessin 2: Prductivity Enhancers Sessin 3: Scripting Sessin 4: Wrking with Cde Wrkbench Sessin 5: Building a Database Prject Sessin 6: Visual Query Builder Sessin 7: Live Data Editr Sessin 8: Cde Analyst Sessin 9: SQL Debugging and Prfiling Yu can use this basic tutrial as a radmap f prduct highlights, but als t help yu find yur wn path t explre Rapid SQL. Help Tpics frm the Help menu t find many additinal resurces that cmplement and build n many f the activities shwn in this tutrial. Nte: The tutrial exercises make use f the sample SQL Server database, AdventureWrks. Since this is nt part f a typical install, yu can btain the files frm installatin CDs r nline surces t install and attach that database. Alternatively, yu can perfrm the tasks targeted fr the AdventureWrks database against anther available database. N destructive actins are initiated in the exercises. Embarcader Technlgies 18

19 Rapid SQL Tutrial exercises Sessin 1: Getting Started Befre anything else, yu must perfrm the fllwing tasks: Starting the Rapid SQL Applicatin Registering Crss-Platfrm Datasurces t Rapid SQL Embarcader Technlgies 19

20 Rapid SQL Tutrial exercises Starting the Rapid SQL Applicatin Hw yu start Rapid SQL/DBArtisan depends n the type f applicatin yu are evaluating: InstantOn versin - start the applicatin by duble-clicking the file yu dwnladed. Fully-installed versin - The Start menu sequence fr Rapid SQL/DBArtisan is always in the frm Prgrams > Embarcader Rapid SQL/DBArtisanversin identifier> Rapid SQL/DBArtisanversin identifier, where versin identifier reflects the versin yu are running. T get started 1 Run Rapid SQL/DBArtisan. The first time Rapid SQL starts, a dialg pens, prmpting yu t set up datasurces. In additin t letting yu manually set up individual datasurces, a number f mre autmated methds are available. If yu have installed and used ther Embarcader tls, Rapid SQL can find any active datasurces being used by thse tls. In additin, Rapid SQL prvides a Discver Datasurces feature that autmatically searches the DBMS cnfiguratin files n yur system fr datasurces that are nt currently registered. Since ther Embarcader tls let yu exprt datasurce definitins t file, yu als have the ptin f imprting these definitins. 2 Fr the purpse f this tutrial, click Cancel. Yu will be registering a datasurce manually. The main Rapid SQL/DBArtisan windw pens. Embarcader Technlgies 20

21 Rapid SQL Tutrial exercises :: Prceed t Registering Crss-Platfrm Datasurces t Rapid SQL. Embarcader Technlgies 21

22 Rapid SQL Tutrial exercises Registering Crss-Platfrm Datasurces t Rapid SQL Fr nw, yu will register a datasurce manually. 1 On the Datasurce menu, select Register Datasurce. A Datasurce Registratin Wizard pens. 2 Chse Micrsft SQL Server as the DBMS type and then click Next. The next panel pens. 3 Ensure that a Registratin type f User defined is selected, specify the Hst name f an SQL Server datasurce n yur netwrk, verride the Datasurce Name with SAMPLE_DATASOURCE and then click Next. 4 Prvide valid credentials in the User ID and Passwrd bxes, and then select the Aut-Cnnect? checkbx t eliminate having t prvide credentials each time yu cnnect t this datasurce. 5 In the left-hand pane, select Datasurce Grup, select the MS SQL Server flder, and then click Finish. Nte: The Datasurce Grup panel als lets yu assign a categry t a datasurce. This prvides a means t visually distinguish between different server purpses, develpment vs. prductin, fr example, in yur enterprise. Categrizatin is a custmizable feature. 6 Select Yes when prmpted t cnnect t the new datasurce. Rapid SQL ffers the same easy-t-use Datasurce Registratin Wizard fr all supprted DBMS platfrm cnnectins. The cnnectin infrmatin nly needs t be set up ne time fr each platfrm and can be saved lcally r in a cmmn datasurce catalg fr use by ther Embarcader prducts. By default, Rapid SQL stres datasurce definitins in the Windws Registry. There is als a lcal, file-based ptin. Embarcader prducts supprting these methds can share datasurce catalgs n the same machine. Embarcader Technlgies 22

23 Rapid SQL Tutrial exercises There is als a netwrk-shared strage ptin. Lastly, datasurce definitins can be stred centrally n an Embarcader DB Team Server fr use by Rapid SQL users. Rapid SQL als ffers the ability t imprt and exprt datasurce definitins. This lets yu share definitins amng users and acrss datasurce strage methds. Prceed t Sessin 2: Prductivity Enhancers. Embarcader Technlgies 23

24 Rapid SQL Tutrial exercises Sessin 2: Prductivity Enhancers This sessin fcuses n sme cmmnly used time-saving features: The Datasurce Navigatr Tree Creating an Object Using the Object Creatin Wizard Wrking With an Existing Object Using the Object Editr Object Dcumentatin and Reprting Wrking With Cde, Files and Data Setting Envirnment Optins Script Library Wrking with Scripts and Files Viewing Data Retaining Datasurce Navigatr View Settings Datasurce Navigatr Bkmarks Setting Keybard Shrtcuts and Htkeys Referencing Mst Recently Used Datasurces Embarcader Technlgies 24

25 Rapid SQL Tutrial exercises The Datasurce Navigatr Tree Rapid SQL makes it easy and intuitive t navigate between datasurces and t drill-dwn int atmic database bjects within the Datasurce Navigatr tree. The Datasurce Navigatr displays all registered datasurces and serves as the entryfunctinality. and ensure that Organize By Object Type is selected. 2 Select and expand the SAMPLE_DATASOURCE > Databases > AdventureWrks nde t display the database bject sub-ndes. Prceed t Creating an Object Using the Object Creatin Wizard. Embarcader Technlgies 25

26 Rapid SQL Tutrial exercises Creating an Object Using the Object Creatin Wizard Frm within the Navigatr tree yu can create any database bject using simple Object Creatin Wizards. The fllwing is an example f hw t use the Table Object Creatin Wizard. It is similar t the Object Creatin Wizards available within Rapid SQL fr all database bjects and ther supprted elements. 1 Right-click n the Tables nde and select Create. A Create Table Wizard pens. 2 Select a Schema and prvide a Name f SAMPLE_TABLE. Leave the remaining default settings and click Next. 3 Add a clumn, using a Name f Sample_Clumn1 and select a Type f char. Experiment with the Add Clumn and Delete buttns, and with selecting a clumn and mdifying its attributes. 4 Click Finish. The DDL View panel pens shwing the DDL that will be used t create the new table. 5 Deselect the Launch Object Editr After Execute and then click Execute. Rapid SQL builds the platfrm-specific SQL cde, syntactically-crrect and ready t run the first time. There is n SQL cding required in any f the Rapid SQL Object Creatin Wizards. Prceed t Wrking With an Existing Object Using the Object Editr. Embarcader Technlgies 26

27 Rapid SQL Tutrial exercises Wrking With an Existing Object Using the Object Editr While the wizard ffered yu the ptin t autmatically pen an editr n creating the table, yu can als manually pen an editr. 1 In the Navigatr, ensure that the Tables nde is expanded and then right-click n yur new table and select Open. Object Editr features are as fllws: All Object Editrs prvide standardized, multi-tabbed windws fr each database bject type. All Object Editrs prvide fully-functinal tlbars fr easy bject management. Rapid SQL has full knwledge f the underlying DBMS system catalg, syntax and alteratin rules, s the user can cncentrate n what needs t be dne, nt n hw t d it. Drp-dwn bxes allw yu t easily mve between wners and bjects. The Rapid SQL Object Editrs easily perfrm peratins that wuld nrmally require painstaking and errr-prne scripting, such as deleting r inserting clumns in a table while preserving data, dependencies and permissins. Rapid SQL analyzes the database catalg t determine its structure, and then autmatically generates the SQL script required fr the extended alteratin. Fr instance, when a full table alteratin is required, Rapid SQL autmatically unlads and relads the data, eliminating tedius wrk. 2 Clse the Object Editr windw. Embarcader Technlgies 27

28 Rapid SQL Tutrial exercises Prceed t Object Dcumentatin and Reprting. Embarcader Technlgies 28

29 Rapid SQL Tutrial exercises Object Dcumentatin and Reprting Rapid SQL prvides rich, detailed HTML Reprting fr all database bjects. Building a brwserready reprt fr any bject is nly a few muse-clicks away. 1 Expand the Tables nde, right-click n any table and select Reprt frm the menu. A Reprt dialg pens. 2 Enter a destinatin Reprt Hme Page File Name. This can be a netwrk web server directry. 3 Enter a Reprt Title and click Execute. The HTML reprt will autmatically be displayed in the Rapid SQL applicatin wrkspace. Fr example: The HTML reprt can be saved t a new file r referenced in the file named abve. Nte: All HTML reprts are brwser-ready and suitable fr psting directly t the web. Prceed t Wrking With Cde, Files and Data. Embarcader Technlgies 29

30 Rapid SQL Tutrial exercises Wrking With Cde, Files and Data Rapid SQL prvides many features and pwerful develpment tls fr creating and executing SQL cde and wrking with data. Nte: Fr purpses f this exercise, we are nly cvering high-level functinality f the majr features and tls within Rapid SQL. Prceed t Setting Envirnment Optins. Embarcader Technlgies 30

31 Rapid SQL Tutrial exercises Setting Envirnment Optins The Optins dialg allws yu t set the Rapid SQL develpment envirnment t meet yur needs. 1 Select File > Optins frm the menu. The Optins dialg pens. The Optins dialg has ne page per ptin categry. Select an ptin categry in the left-hand pane and yu can subsequently set ptins n that page. Optins are applied when yu click OK. 2 Clse the Optins dialg. Prceed t Script Library. Embarcader Technlgies 31

32 Rapid SQL Tutrial exercises Script Library The Script Library prvides a drag-and-drp library interface f all supprted DBMS syntax, SQL syntax, built-in functins, ptimizer hints, and SQL-cnditinal syntax. Additinally, it prvides the ability t create custm flders t stre cmmnly-used cde fr quick and efficient access, as needed. T pen the Script Library: 1 Select View > Script Library. The Script Library windw pens. 2 Expand the Micrsft nde and then expand the Schema sub-nde. 3 Right-click the Prcedures nde and select Open. The selected cde pens in the SQL Editr windw and is ready fr executin. 4 Right-click in the editr windw and select Clse frm the cntext menu. T add a custm flder t the Script Library 1 Right-click the Script Library flder. 2 Select New Flder frm the cntext menu. A new flder is added t the Script Library flder. T clse the Script Library windw: 1 Select View > Script Library. Prceed t Wrking with Scripts and Files. Embarcader Technlgies 32

33 Rapid SQL Tutrial exercises Wrking with Scripts and Files Rapid SQL extends the aut-generatin f SQL cde by allwing yu t run yur scripts acrss multiple databases at the same time. File Executin Facility Files cntaining SQL scripts can be added t the File Executin Facility and executed immediately r scheduled t run later. 1 On the Tls menu, select File Executin Facility. Rapid SQL pens the File Executin Facility dialg bx. 2 T lcate the file yu want t execute, click Add. Use the Add Files dialg bx t lcate and select a file. 3 On the Target tab, select the datasurces t run the script against. 4 On the Output tab, select the desired utput ptin. Fr the purpses f this example, select Graphical Output. Nte: T enable the scheduling functin fr the script, yu must select the File Output ptin. 5 If yu want t send ntificatin that the script has executed, n the Ntify tab, cmplete the target infrmatin. 6 Click Execute if yu want Rapid SQL t run the script against the target datasurces. Otherwise, clse the dialg withut executing. Nte: Separate script utput windws are created fr each selected datasurce. Script Executin Facility The Tls menu als ffers a Script Executin Facility. Similar t the File Executin facility, it lets yu type r paste the script t be executed. Prceed t Viewing Data. Embarcader Technlgies 33

34 Rapid SQL Tutrial exercises Viewing Data Rapid SQL prvides several ptins fr brwsing data. In additin, it gives yu the ability t cnstruct even the mst cmplex SQL statements with pint-and-click ease. Select * Brwsing 1 On the Datasurce Navigatr, expand the MS SQL Servers nde. 2 Expand any database yu knw has table data, expand the Tables nde, right-click a table, and then click SELECT * FROM. All clumns and rws frm the table are displayed in the active wrkspace. 3 Clse the wrkspace windw. Prceed t Retaining Datasurce Navigatr View Settings. Embarcader Technlgies 34

35 Rapid SQL Tutrial exercises Retaining Datasurce Navigatr View Settings 1 Click n the drpdwn at the tp f the Datasurce Navigatr. 2 Select Retain View Settings. The Navigatr will pen the next time just as yu left it. All cnnectins that were present when yu clsed Rapid SQL will be re-established. Prceed t Datasurce Navigatr Bkmarks. Embarcader Technlgies 35

36 Rapid SQL Tutrial exercises Datasurce Navigatr Bkmarks Rapid SQL allws yu t set bkmarks fr frequently visited database bjects. 1 Right-click n any nde in the Datasurce Navigatr. 2 Select Add Bkmark and use the Add Friendly Bkmark Name dialg t ptinally prvide a new name, and create the bkmark. After Bkmarks are defined yu can use them t easily navigate t cmmnly used datasurce resurces. In this case, yu wuld select the drpdwn at the tp f the Datasurce Navigatr, selecting Bkmarks > SQLServer and then selecting the bkmark yu just created. The Bkmark Manager handles maintenance f Bkmarks. 3 Select the drpdwn at the tp f the Datasurce Navigatr and then select Bkmarks>Bkmark Manager. 4 Clse the Bkmark Manager dialg. Embarcader Technlgies 36

37 Rapid SQL Tutrial exercises Prceed t Setting Keybard Shrtcuts and Htkeys. Embarcader Technlgies 37

38 Rapid SQL Tutrial exercises Setting Keybard Shrtcuts and Htkeys 1 On the Tls menu, select Custmize. 2 In the Custmize dialg, g t the Keybard tab. The Keybard tab can be used t set keybard shrtcut htkeys fr all areas f Rapid SQL functinality. 3 Clse the Custmize dialg. Prceed t Referencing Mst Recently Used Datasurces. Embarcader Technlgies 38

39 Rapid SQL Tutrial exercises Referencing Mst Recently Used Datasurces 1 Select File > Recent Datasurces and then select a datasurce. This will autmatically place yu n the datasurce within the Navigatr, ready t wrk with active cnnectin. Prceed t Sessin 3: Scripting. Embarcader Technlgies 39

40 Rapid SQL Tutrial exercises Sessin 3: Scripting Generating Cde Right-click feature Autmated errr detectin and cding assistance Other cding aids Embarcader Technlgies 40

41 Rapid SQL Tutrial exercises Generating Cde By prviding several cde generatin and assistance ptins, Rapid SQL makes crss-platfrm develpment easy fr develpers f all experience levels. Nte: The fllwing examples build n the SAMPLE_DATASOURCE registered earlier in this Evaluatin Guide. These examples can be applied t any registered datasurce fr any f the supprted platfrms. Cde Generatin Facility The Cde Generatin Facility can be used t create cmplete prcedures, functins r packages revlving arund views r tables. 1 Frm the menu, pen Tls > Cde Generatin Facility. 2 Select the SAMPLE_DATASOURCE datasurce, the AdventureWrks database, and the Purchasing schema frm the drpdwn list bxes. 3 Select the Vendr table, Name as the input clumn and all clumns fr utput. 4 Select Select as the cde ptin. Embarcader Technlgies 41

42 Rapid SQL Tutrial exercises 5 Select a file t save the generated script and check Open. 6 Click OK and the DDL t create the prcedure will be generated and displayed in an editable windw, called the DDL Editr. Yu can edit the name f the new prcedure and any f the generated cde at this time. Name the new prcedure sample_select_vendrs. 7 Click n the Execute buttn t submit the DDL and create the prcedure. The indicated file will be saved n the selected directry. Nte: N SQL statement cding is required t generate cmplete stred prcedures and packages. If applicable, Rapid SQL allws all generated cde t be previewed and edited t fit any develpment need. Prceed t Right-click feature. Embarcader Technlgies 42

43 Rapid SQL Tutrial exercises Right-click feature - create cmplete prcedures, functins r packages revlving arund views r tables. 1 Frm the Datasurce Navigatr tree, expand the SAMPLE_DATASOURCE > AdventureWrks > Tables sub-nde. 2 Right-click n the Vendrs table. 3 Select Generate > Prcedure > Select. 4 Select Name as the input clumn, and leave all utput clumns selected. 5 Click OK and the DDL t create the prcedure will be generated and displayed in the DDL Editr. Yu can edit the name f the new prcedure and any f the generated cde. Name the new prcedure sample_select_vendrs2. 6 Click n the Execute r Step Execute buttn t submit the DDL and create the prcedure. Prceed t Autmated errr detectin and cding assistance. Embarcader Technlgies 43

44 Rapid SQL Tutrial exercises Autmated errr detectin and cding assistance Rapid SQL prvides a range f features that detect r help yu avid errrs and save keystrkes in develping yur scripts. T enable these features: 1 On the File menu, select Optins. The Optins dialg pens. 2 In the left-hand pane, expand the ISQL nde and then select Cde Assist. 3 On the Cde Assist panel: Ensure that Enable Cde Cmplete is selected. Ensure that Severity levels fr semantic validatin prblems has Warning selected. Ensure that Enable Real-time syntax checking is selected. 4 Click OK. T see these features in actin: 1 On the File menu, click New, and then SQL. Rapid SQL pens the SQL Editr windw. Yu can add SQL cde via yur methd f chice (freefrm typing, retrieve frm a file, paste cpied cde, etc.). 2 Type SELECT * FROM and stp typing. Nte the errr cnditin. Rapid SQL can run a syntax check any time there is an interval f 1.5 secnds between keystrkes. Yu can als disable autmatic syntax checking and nly run a check when yu manually initiate it. Syntax errr anntatin persists until yu crrect the prblem. 3 This time type a fragment that includes the name f a nnexistent bject, SELECT * FROM NON.OBJECT, fr example. Fr nw, ignre any ppups. The warning cnditin is a result f nthe-fly semantic validatin. Embarcader Technlgies 44

45 Rapid SQL Tutrial exercises Rapid SQL ntifies yu when a script cntains a reference t an bject that Rapid SQL cannt reslve. 4 Type SELECT * FROM fllwed by a space and then stp typing. If n ppup appears, press CTRL+SPACE. The Cde Cmplete suggestin bx lets yu select frm bjects r bject name cmpnents such as databases r schema. This feature saves keystrkes and minimizes typing errrs. See the nline Help fr full descriptins f these features. 5 Clse the current SQL Editr windw. T restre Rapid SQL settings: 1 On the File menu, select Optins. The Optins dialg pens. 2 On the Cde Assist panel, click the Restre defaults buttn. 3 Click OK. Prceed t Other cding aids. Embarcader Technlgies 45

46 Rapid SQL Tutrial exercises Other cding aids Rapid SQL prvides extensive, easy-t-use cding aids fr all f the supprted DBMS platfrms, thrughut the applicatin. Aids are prvided in the frm f ready-t-use cde templates and blcks f syntactically crrect cde. Paste SQL 1 Frm the Datasurce Navigatr tree, expand the SAMPLE_DATASOURCE > AdventureWrks sub-nde. 2 Select File > New > SQL t pen an SQL Editr windw. 3 Select Edit > Paste SQL Statement t pen the Paste SQL windw. 4 On the Paste SQL dialg, select Sample_Datasurce frm the Datasurce drpdwn, AdventureWrks frm Database, All Owners frm Owner, and an Object Type f Tables. 5 In the Tables list, select Purchasing.Vendr. 6 Under the Clumns list, click ALL. 7 Click the Select radi buttn. 8 Click Paste Statement t cpy the generated cde t the SQL Editr windw. Yu can use the statement as is, r mdify the cde as needed. Embarcader Technlgies 46

47 Rapid SQL Tutrial exercises Paste SQL Syntax 1 Select File > New > SQL t pen a fresh SQL Editr windw. 2 Select Edit > Paste SQL Syntax t pen the SQL Syntax fr SQL Server windw. 3 Select a template and click Paste t cpy the cde template int the SQL Editr windw. 4 Add yur wn cde t cmplete the needed peratin. Prceed t Sessin 4: Wrking with Cde Wrkbench. Embarcader Technlgies 47

48 Rapid SQL Tutrial exercises Sessin 4: Wrking with Cde Wrkbench The Cde Wrkbench lets yu cnfigure resurces fr tw SQL Editr features: Cde Templates Aut Replace Cde templates are cmplete cde blcks that can be easily added t pen windws r scripts with a few keystrkes. When yu type CTRL+SPACE, the Cde Assist menu pens, letting yu select a cde template fr insertin in the editr windw. Aut Replace lets yu define shrtcuts cnsisting f a few characters that represent lnger character strings. Instances f these Aut Replace expressins are autmatically replaced by the replacement string n activatin events such as typing SPACE, TAB, r RETURN. This feature is useful fr creating shrtcuts fr ne-line cmmands r SQL statement subsets, r even t detect and fix cmmn typgraphical errrs such as teh fr the. Fr example, cnsider an Aut Replace definitin with an expressin f sel t represent Select * Frm: If the assciated activatin event includes a SPACE, then n typing sel fllwed by pressing SPACE, the fllwing replacement ccurs. Rapid SQL lads a default set f Aut Replace and Cde template definitins at startup, but yu can als add, edit, and delete definitins. In additin, yu can save sets f definitins t file and subsequently lad specific sets f definitins, allwing yu t custmize yur templates t different platfrms r develpment prjects. T invke Cde Wrkbench settings: Embarcader Technlgies 48

49 Rapid SQL Tutrial exercises 1 Select Tls > Cde Wrkbench. The Settings tab lets yu enable the Aut Replace and Cde Template features. 2 Inspect the Cde Templates and Aut Replace tabs. 3 Click OK. Prceed t Sessin 5: Building a Database Prject. Embarcader Technlgies 49

50 Rapid SQL Tutrial exercises Sessin 5: Building a Database Prject Rapid SQL prvides an excellent team develpment envirnment by allwing yu t reverse engineer live database bjects int ff-line SQL surce cde files. Yu can subsequently perfrm tasks such as distribute the files r add them t a Versin Cntrl System (VCS). This example will reverse engineer the table bjects frm the Micrsft SQL Server AdventureWrks database int a Rapid SQL prject 1 Select File > New > Prject t pen the wizard. 2 Enter sample_prject as the name, and accept the default target directry. Select Frm Database and click OK. 3 On the Cnnectin page, select SAMPLE_DATASOURCE and click Next. 4 On the Catalgs page, select AdventureWrks and click Next. 5 Click Schemas t pen the Schema Selectin dialg. Select Human Resurces, Purchasing, and Sales, and then click OK. The Object Selectin page pens. 6 Under Object Types, select Tables. Then, under Objects, expand the Tables nde and select the Purchasing.Vendr, Sales.SpecialOffer, and HumanResurces.Emplyee tables. Click Next. 7 On the Optins page, leave the default selectins and click Finish. 8 When the Execute page shws that reverse engineering is cmplete, click Cntinue. The Prject tab displays the results f the reverse engineering. Embarcader Technlgies 50

51 Rapid SQL Tutrial exercises Befre clsing the Prject tab, investigate the individual prject elements. In additin, check the File and Prject menus fr prject and versin cntrl ptins. Prceed t Sessin 6: Visual Query Builder. Embarcader Technlgies 51

52 Rapid SQL Tutrial exercises Sessin 6: Visual Query Builder Rapid SQL gives yu the ability t cnstruct cmplex SQL statements with pint-and-click ease using the Visual Query Builder. 1 Frm the Navigatr tree, right-click n the HumanResurces.Emplyee table and select Build Query. The table is autmatically added t the Query Builder wrkspace. 2 On the Tables/Views tab, right-click n the Department table and select Add. 3 Similarly, n the Tables/Views tab, right-click n the EmplyeeDepartmentHistry table and select Add. 4 Rearrange the cntents f the windw t lk like the fllwing graphic. 5 Select the clumns indicated in the graphic. Nte that the tables are autmatically identified as being jined by any clumns with the same name and datatype. Als, nte that the query is being built in the lwer pane. 6 Click n the DML tab t expse the visual query building clauses and ptins. Yu can right-click n any clause t easily add the cde t the query. Embarcader Technlgies 52

53 Rapid SQL Tutrial exercises 7 Experiment with adding, deleting, and mdifying clauses. 8 Click the Execute buttn t execute the query. The results will display in the lwer windw. Befre clsing the Query Builder, experiment with additinal ptins. Try selecting a different statement type, such as Insert r Update, frm the drpdwn at the tp f the Query Builder windw. Use the different clauses n the DML tab. Nte: Any visual query builder sessin can easily be saved t a file fr later use. Prceed t Sessin 7: Live Data Editr. Embarcader Technlgies 53

54 Rapid SQL Tutrial exercises Sessin 7: Live Data Editr 1 Frm the Navigatr, right-click n the Purchasing.Vendr table and select Edit Data. 2 In the Data Editr Filter dialg, click Add All t add all clumns t the editing sessin. At this pint, yu can add a WHERE clause that will filter fr nly the desired data. Nte that Rapid SQL builds the SQL t retrieve the data t be edited in the Select Statement area. 3 Click OK. A Data Editr pens. Nte the drpdwn at the left f the tlbar. The editing windw has LIVE and BATCH mdes: LIVE mde cmmits yur changes each time yu mve t a new rw. BATCH mde will allw yu t mve within the windw and cmmit yur changes when ready. Changes made in BATCH mde can be cancelled by selecting the Relad Data icn. At any time during the sessin, yu can change the filter parameters by selecting the Filter Data icn. Prceed t Sessin 8: Cde Analyst. Embarcader Technlgies 54

55 Rapid SQL Tutrial exercises Sessin 8: Cde Analyst The Cde Analyst allws yu t capture run-time statistics n executable database bjects, including stred prcedures and functins. Nt nly can yu capture statistics fr single bjects, but yu can grup mre than ne bject. T get started 1 Select Tls > Cde Analyst. Nte: In rder fr Cde Analyst t run, 5 repsitry tables will be created n the database. Select the database yu wuld like the tables t be installed n and press OK. Once the tables are sessin. 2 On the Cde Analyst tlbar, click the Create New Cllectin buttn. 3 On the Cde Analyst Object Selectin dialg, prvide a Sessin Name, lcate and select the bjects t be executed, and click Next. 4 Use the Cde Analyst Object Initializatin dialg t initiate prviding input parameters as required, change the rder f executin, and when ready, click Finish. Once the sessin has been run, the ttal time fr the executin is displayed in the Run Summary tab. Embarcader Technlgies 55

56 Rapid SQL Tutrial exercises 5 Select the ther tabs t view the tabular and graphical representatin f the executin details n yur selected bjects. Fr example: The Run Detail tab shws a breakdwn f the different bjects that make up the sessin. The Unit Detail tab cntains the specific time measurements fr individual SQL statements. 6 Clse the Cde Analyst windw. Prceed t Sessin 9: SQL Debugging and Prfiling. Embarcader Technlgies 56

57 Rapid SQL Tutrial exercises Sessin 9: SQL Debugging and Prfiling Rapid SQL ffers the fllwing facilities that help yu test and ptimize cde: SQL Debugging SQL Prfiling- Oracle Only Embarcader Technlgies 57

58 Rapid SQL Tutrial exercises SQL Debugging The SQL Debugger is anther database prductivity tl that lets yu debug SQL Server, Oracle, Sybase ASE r DB2 stred prcedures, as well as Oracle functins. SQL Debugger simplifies the task f finding cding errrs. 1 In the Navigatr, expand the Prcedure r Functin nde. 2 Right-click the bject and select Debug frm the cntext menu. 3 If the prcedure r functin takes input parameters, the Prcedure Executin windw prmpts yu t enter values. 4 Enter input values and press Cntinue. Tip: Rapid SQL allws the user t save the input variable values t a file fr later use. This is very helpful fr prcedures/functins with many input variables that need t be run repeatedly. The applicatin pens the SQL Debugger Interface. Embarcader Technlgies 58

59 Rapid SQL Tutrial exercises The Debugger features basic executin, line-by-line executin, breakpint supprt, and ther cmmn debugging features. Fr details, refer t the relevant nline Help tpics. Prceed t SQL Prfiling- Oracle Only. Embarcader Technlgies 59

60 Rapid SQL Tutrial exercises SQL Prfiling- Oracle Only The SQL Prfiler within Rapid SQL prvides the ability t capture the metrics f varius PL/SQL prgrammable bjects as they are executed in the database. It quickly identifies perfrmance bttlenecks by first calculating the verall runtimes f bjects like Oracle packages, and then cmputing the amunt f time each line f PL/SQL cde spends executing. Infrmatin is presented in an easily viewed, drill-dwn frmat. 1 T start a prfiling sessin, use the Tls menu ptin and select SQL Prfiler > Start. 2 Enter a name fr the prfiling sessin r select an existing name frm the drpdwn. Press OK. The Prfile sessin is nw active. 3 Execute the prgrammable bject (i.e. Stred Prcedure) yu wish t capture metrics n. 4 When finished, select Tls > SQL Prfiler > Stp. The SQL Prfiler Stp dialg windw prmpts yu t select an ptin. 5 Press Stp. Embarcader Technlgies 60

61 Rapid SQL Tutrial exercises 6 On the Navigatr, expand the PL/SQL Cde Prfiling nde. 7 Right-click n the prfile sessin and select Run Summary. The Run Summary windw pens. 8 Select a sessin and select Run Detail frm the right-click menu. The Run Detail screen appears allwing yu t view the metrics fr this executin in bth a graphical and text frmat. 9 T drill dwn further int the data, highlight a unit and select Unit Detail frm the right-click menu. Scrll thrugh the Surce windw t view the times fr each statement. 10 T cmpare 2 cases, select the 2 cases yu wish t cmpare (shift-click t select the secnd case) frm the Run Summary screen and select Cmpare frm the right-click menu. The SQL Prfiler Run Cmparisn screen appears. See the relevant nline Help tpics fr mre infrmatin n prfiling. Embarcader Technlgies 61