User's Guide c-treeace Query Builder

Transcription

1 User's Guide c-treeace Query Builder

2 User's Guide c-treeace Query Builder

3 Contents 1. c-treeace Query Builder Startup Securing Your Connection with SSL Main Window Query Builder Pane... 8 Tables/Columns... 9 Joins Where Group By Order By Resulting Query Pane Menus and Tool strip Tool strip Options Window Status Bar Index All Rights Reserved iii

4 1. c-treeace Query Builder c-treeace Query Builder is a client-side tool for creating simple queries to send to the c-treeace Server. Knowledge of the c-treeace database management system is not required to use this tool, however it is advisable to have some knowledge of the SQL language. The c-treeace Query Builder window is organized into five tabs that help walk you through the development of a full SQL query that can be executed against a running c-treeace Server with the output appearing in grid form. Note the query can also be saved and modified for execution through other c-treeace administration tools (e.g., c-treeace SQL Explorer. All Rights Reserved 4

5 1.1 Startup When starting c-treeace Query Builder it will show you the following connection dialog box in order to establish a connection to a running c-treeace Server. Server Connection Host Name / IP Address - Use this text box to specify the IP address or the machine Host Name where the c-treeace Server is running. If your c-treeace Server is running on your local machine, using the "localhost" machine name will provide better performance. In V11.5 and later, the tools are compatible with the expanded addressing offered by IPv6. SQL Port Number - Enter the TCP/IP port number to be used to connect SQL clients to the c-treeace Server. Note the default Port Number is If you desire to specify a different port ID, place the SQL_PORT keyword in the ctsrvr.cfg file as follows: SQL_PORT # where "#" is the new Port Number. SQL Database Name - Enter in this textbox the SQL database name you want to open. SSL Mode and Certificate Common Name - Set up SSL security, if desired, as described in Securing Your Connection with SSL (page 6). User Options User Name - Specify the user name you want to use to make the connection with the c-treeace Server. Password - Use this text box to enter the user's password. Note the default "User Name" and "User Password" are both "ADMIN" and the Password is case sensitive. When you're done press OK to establish the connection. If you press Cancel the tool will not be connected to the c-treeace Server. All Rights Reserved 5

6 1.2 Securing Your Connection with SSL In V11.5 and later, the GUI tools allow the use of SSL to protect data in transit between the server and the utility. Controls for configuring your connection are provided in the Connection Options window, which is similar to the image below: SSL Mode - Select the desired level of SSL protection from this drop-down: None - Do not use SSL. Basic - Use SSL without certificate checking. Peer Authentication - Use SSL with certificate checking using the certificate file specified below. Certificate (or Certificate Common Name) - If Peer Authentication has been selected, enter the name of the certificate in this field. If no path is entered, the file must be in the current working directory. The three dots to the right of the Certificate field display a dialog box so you can navigate to the certificate. Security Note: For testing and evaluation purposes only, a self-signed X.509 certificate is included in your default c-treeace package. OpenSSL was used to create this certificate. It is critical this included certificate is never used in a production setting. All Rights Reserved 6

7 1.3 Main Window Once you've established a connection you will be able to design a query using the main window of c-treeace Query Builder. This form is divided into three panes: the top pane, Query Builder, is used to design your query; the middle pane, Resulting Query shows the SQL code for the query you are designing; and the bottom pane reports the results of your query. Now let's see how to use the Query Builder pane. All Rights Reserved 7

8 1.4 Query Builder Pane The Query Builder pane is designed with five different tab pages. Every tab page can be used to define the clauses of your SQL SELECT statement. All Rights Reserved 8

9 Tables/Columns The Tables/Columns tab is the basic tab used to create your select query. With this tab you can define the Tables and the Columns involved in your query by simply using the check boxes. You can also define the Column Title and specific SQL Functions to be used. Figure 1: Tables/Columns Tab Page Tables/Views - This check list box will be filled with the tables and the views defined in the database you specified in the Startup Screen. To choose a table for your query just click its check box. The tables you check will be added to the FROM clause of your query. To remove tables from your query simply un-check the proper check box. If you can't see your views click the Show Views strip below in this chapter) button located on the toolbar. (See Tool Columns - This check list box is populated with the columns for the selected table (the highlighted table). To choose columns for your query simply click the corresponding check box. To remove a column from your query un-check the check box. Note, you do not need to select a column for display from every table specified in the query (e.g. you can use a column from a table to specify a WHERE condition without showing it). Reorder - This button invokes the Column Reorder dialog window (see Reordering Columns (page 10) for details). Column Title - Use this text box if you want to specify a more descriptive name for the column heading in the Returned Records grid. If left blank, the Column Name (e.g., All Rights Reserved 9

10 "cust_num" for the first column in the example window above) will appear as the column heading. Function - Use this combo box if you need to apply a SQL function to the highlighted column from the Columns check list box;. The c-treesql reference guide provides detail about the SQL functions or search the FairCom Web site for all the references within the online documentation set. DISTINCT - Check this box if you need to add the DISTINCT (meaning don't return duplicate rows) clause to the highlighted column from the Columns check list box. Note, the DISTINCT clause can be activated only on columns that have a function applied. TOP - Entering a number for this text box will activate the SELECT TOP option for your query. This will limit your query to returning only the first n rows where "n" is the value specified in the text box. If the AutoRun Query Button is activated your query will automatically run when you update the Tables/Columns page controls. Reordering Columns Use this option to reorder the columns to be returned by your query. Figure 2: Columns Reorder Dialog - Moves the highlighted column up in the columns' list (which will appear further to the Left in the Returned Records grid). - Moves the highlighted column down in the columns' list (which will appear further to the Right in the Returned Records grid). When you're done press OK to confirm your new column order, or press Cancel if you don't want to save the new order. All Rights Reserved 10

11 Joins The Joins tab can be used to define a SQL JOIN between two tables. Figure 3: Joins Tab Page Join Type - Use this combo box to select the join type to be used between the two tables. Switch Left/Right Tables - Click this button if you need to switch all the selected columns. By clicking this button all left table columns will become right table columns and vice versa. This is useful for creating a virtual right outer join by switching a left outer join. And/Or - Use this combo box to select one of the operators to bind many columns in to your JOIN statement. From this combo you can also select brackets if you need to make complex JOINS. Left Table Column - Select one of the columns from the selected tables to create the JOIN. Operator - Use this combo box to select the JOIN operator between the joined columns. Right Table Column - This combo box allows you to specify a column from another table to complete the JOIN. In order to have a table and its columns listed in this "Right Table Column", the table must be selected in the Tables/Views check list box. Remove existing joined columns - To delete a JOIN condition from the joined columns list, select the condition row you want to delete by clicking its row header, and then press the Delete button on your keyboard. All Rights Reserved 11

12 Recall, if the AutoRun Query Button update the Joins tab controls. is pressed your query will automatically run when you Where This tab allows you to use a simple grid to define your JOIN and SEARCH conditions for your query. For information about specifying JOIN operations within a WHERE condition, see the FairCom SQL Reference Guide section pertaining to Outer Joins. And/Or - This combo box allows you to choose between the logical operators (And and Or) to bind your where conditions. Note you can also select brackets to nest your search conditions. Column - Select one of the columns in your query to apply a search condition. Operator - Select the operator to use in your where condition (e.g., =,<>,<,<=, >,>=, BETWEEN, NOT BETWEEN,CONTAINS, NOT CONTAINS, EXISTS, IN, NOT IN, IS NULL, IS NOT NULL, LIKE, NOT LIKE). Value/Column - Enter the value to create your where condition, remember to use the single quote (') to delimit textual values. If you need to create a join from a where condition press the Button to switch this control to a combo box displaying column values to choose for completing the join expression. - Clicking this activates the table 'columns' combo box in the Value/Column area. Remove existing Search conditions - To delete a search condition from the where definition grid select the condition you want to delete by clicking its row header, and press the Delete key on your keyboard. All Rights Reserved 12

13 Recall, if the AutoRun Query Button update the Joins tab controls. is pressed your query will automatically run when you Group By The Group by tab can be used to add the GROUP BY condition to your query. To add a GROUP BY condition select the column to be used for the grouping; GROUP BY clauses with multiple rows are allowed too. The example below selects the column "branches" from the teller file which also includes the teller column, issues a Group By on the branch column, and then calculates the sum of each teller at each branch to generate the branch total. Figure 4: Group By Tab Page Column - Use this comb box to select the column to use in the GROUP BY operation. Having - Check this box if you want to specify a HAVING condition for the current grouping rule. Having Search Condition - Specify the desired HAVING search condition. Remove existing Groupings - To delete a GROUP BY clause from the Group By list select the row you want to delete by clicking its row header and then press the Delete key on your keyboard. Recall, if the AutoRun Query Button is pressed your query will automatically run when you update the Joins tab controls. Columns in the select list must also be in the GROUP BY clause or be part of an aggregate function. All Rights Reserved 13

14 Order By The Order By tab allows you to add the ORDER BY clause to your query and select the columns to be used to perform the ordering. Figure 5: Order By Tab Page Column - Select a column already referenced in your query to perform an ascending ORDER BY operation. Descending - Check this box if you want ORDER BY operation for the selected column to be in descending order. Remove existing Order Expressions- To delete an ORDER BY expression from the Order By list select the expression row you want to delete by clicking its row header and press the Delete key on your keyboard. Recall, if the AutoRun Query Button update the Joins tab controls. is pressed your query will automatically run when you 1.5 Resulting Query Pane The Resulting Query pane shows the query built in the Query Builder pane. Note your query can also be modified in the Resulting Query pane and re-executed using the Run button. Be All Rights Reserved 14

15 careful, any changes made within the Resulting Query pane will be overwritten after any change within the Query Builder pane anytime the Run button is pressed or if the AutoRun Query Button is active. 1.6 Menus and Tool strip File Menu Connect/Disconnect - If c-treeace Query Builder is connected to a c-treeace Server, the "Disconnect" option will appear as in the screen below. Selecting "Disconnect" will remove the connection from the c-treeace Server. If c-treeace Query Builder is NOT connected to a c-treeace Server, the "Connect" option will appear. Selecting "Connect" will bring up the Connection Dialog box. See the Startup section above for details on this screen. Save - Saves the current SQL statement. Save As - Saves the current SQL script/statement to a new file. All Rights Reserved 15

16 Exit - Disconnects and then closes c-treeace Query Builder. Options Clicking on the option menu item loads the c-treeace Query Builder options menu. See Section "Options Window (page 17)" for more details. Tool strip - Shows the connection dialog (See Section "Startup") in order to create a new SQL connection between c-treeace Query Builder and a running c-treeace Server. This command can be used only if c-treeace Query Builder is not connected. - Disconnects the tool from the connected server. You can use this command only if c-treeace Query Builder is connected to a c-treeace Server. - Shows the change database dialog in order to open and query a different database managed from the same c-treeace Server you are connected to. - Click this button if you want to add views to the Tables/Views checked list box in the Tables/Columns tab page (see above in this chapter (page 9)). - Click this button if you want to add to the Tables/Views checked list box tables owned by all users. Make sure you have the correct permissions in order to query all user tables. If you have also activated Show Views you will see all the user tables and views. When this button is pushed only items owned by currently connected users will be shown. - Click this button if you want to add SQL system tables to the Tables/Views checked list box. - Click this button to clear all the tab pages and the Resulting Query pane in order to create a new query. - Saves the current resulting query SQL statement to a file. Run Query - Runs the current query specified in the Resulting Query pane and redirects the results to the Retuned Records pane. - When this button is pushed the query will automatically run every time the Resulting Query pane is modified by any user selections. All Rights Reserved 16

17 Options Window The c-treeace Query Builder options window is available from the menu strip. Figure 6: c-tree Query Builder Options Window The options window is divided in to 4 sections, as follows: General Enclose column names in double quotes - If you activate this check box, all the column names involved in your query will be enclosed in double quotes. This is useful if you need to use special reserved names within your queries. Default to AutoRun Query - If this control is checked the AutoRun option will be enabled by default at startup. Connection AutoConnect - Activate it if you want c-treeace Query Builder to automatically connect to a c-treeace server using the default parameters. Remember Password - Check this option if you want c-treeace Query Builder to save your last valid password in order to use it as the default with the AutoConnect option discussed above. Colors Use the radio buttons in the Colors tab to set the colors used by c-treeace Query Builder by choosing between the default Windows blue color scheme or a silver theme designed by our developers. Keep Alive Keep-alive interval - Activate this if you need to maintain an open connection between c-treeace Query Builder and the c-treeace Server through a firewall that implements timeouts. All Rights Reserved 17

18 Status Bar The c-treeace Query Builder status bar is located on the bottom of the c-treeace Query Builder window and provides useful information about the status of c-treeace Query Builder. Figure 7: c-tree Query Builder Status Bar Result Area - The left pane reports the status of the last operation performed. "Error" is displayed if the operation failed and "Success" is displayed for a successful operation. Database Name Area - The second pane reports the database name the tool is currently connected to. User Name Area - The third pane reports the user name you are currently using to establish a connection with the database. Elapsed Time Area - The fourth pane reports the elapsed time to prepare and run the last query sent to the Server. Remember this value does not include the fetch time. It represents only the prepare and run time. Returned Records Area - The fifth pane (furthest right) reports the number of records returned by the last successful query. All Rights Reserved 18

19 Copyright Notice Copyright FairCom Corporation. All rights reserved. No part of this publication may be stored in a retrieval system, or transmitted in any form or by any means, electronic, mechanical, photocopying, recording or otherwise without the prior written permission of FairCom Corporation. Printed in the United States of America. Information in this document is subject to change without notice. Trademarks c-treeace, c-treertg, c-treeams, c-tree Plus, c-tree, r-tree, FairCom and FairCom s circular disc logo are trademarks of FairCom, registered in the United States and other countries. The following are third-party trademarks: AMD and AMD Opteron are trademarks of Advanced Micro Devices, Inc. Macintosh, Mac, Mac OS, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries. Embarcadero, the Embarcadero Technologies logos and all other Embarcadero Technologies product or service names are trademarks, service marks, and/or registered trademarks of Embarcadero Technologies, Inc. and are protected by the laws of the United States and other countries. Business Objects and the Business Objects logo, BusinessObjects, Crystal Reports, Crystal Decisions, Web Intelligence, Xcelsius, and other Business Objects products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of Business Objects Software Ltd. Business Objects is an SAP company. HP and HP-UX are registered trademarks of the Hewlett-Packard Company. AIX, IBM, POWER6, POWER7, and pseries are trademarks or registered trademarks of International Business Machines Corporation in the United States, other countries, or both. Intel, Intel Core, Itanium, Pentium and Xeon are trademarks or registered trademarks of Intel Corporation or its subsidiaries in the United States and other countries. Microsoft, the.net logo, the Windows logo, Access, Excel, SQL Server, Visual Basic, Visual C++, Visual C#, Visual Studio, Windows, Windows Server, and Windows Vista are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Novell and SUSE are registered trademarks of Novell, Inc. in the United States and other countries. Oracle and Java are registered trademarks of Oracle and/or its affiliates. QNX and Neutrino are registered trademarks of QNX Software Systems Ltd. in certain jurisdictions. CentOS, Red Hat, and the Shadow Man logo are registered trademarks of Red Hat, Inc. in the United States and other countries, used with permission. UNIX and UnixWare are registered trademarks of The Open Group in the United States and other countries. Linux is a trademark of Linus Torvalds in the United States, other countries, or both. Python and PyCon are trademarks or registered trademarks of the Python Software Foundation. OpenServer is a trademark or registered trademark of Xinuos, Inc. in the U.S.A. and other countries. Unicode and the Unicode Logo are registered trademarks of Unicode, Inc. in the United States and other countries. Btrieve is a registered trademark of Actian Corporation. ACUCOBOL-GT, MICRO FOCUS, RM/COBOL, and Visual COBOL are trademarks or registered trademarks of Micro Focus (IP) Limited or its subsidiaries in the United Kingdom, United States and other countries. iscobol and Veryant are trademarks or registered trademarks of Veryant in the United States and other countries. All other trademarks, trade names, company names, product names, and registered trademarks are the property of their respective holders. Portions Copyright Unicode, Inc. All rights reserved. Portions Copyright The OpenSSL Project. All rights reserved. This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit ( Portions Copyright Eric Young (eay@cryptsoft.com). All rights reserved. This product includes cryptographic software written by Eric Young (eay@cryptsoft.com). This product includes software written by Tim Hudson (tjh@cryptsoft.com). Portions Dharma Systems, Inc. All rights reserved. This software or web site utilizes or contains material that is DUNDAS DATA VISUALIZATION, INC. and its licensors, all rights reserved. Portions Copyright Jean-loup Gailly and Mark Adler. 12/13/2017

20 2. Index C Copyright Notice xix c-treeace Query Builder 4 G Group By 13 J Joins 11 M Main Window 7 Menus and Tool strip 15 O Options Window 16, 17 Order By 14 Q Query Builder Pane 8 R Reordering Columns 9, 10 Resulting Query Pane 14 S Securing Your Connection with SSL 5, 6 Startup 5 Status Bar 18 T Tables/Columns 9, 16 Tool strip 16 W Where 12 All Rights Reserved 20