Orchard Enterprise Technical Reference Guide

Page tree

Page Description

Use the Query Tool page to view the system data that matches your SQL-based search. You may not edit the information displayed on this page.

Accessing this Page

  • Select the Administration menu button, select the Monitor button, and then select the Query Tool submenu link. You must have the necessary security permissions to access the Administration menu button and to view the Query Tool submenu link. When you select the Administration menu button, the system opens the main Administration menu, which contains administrative menu buttons, including the Monitor menu. To return to the main menu for the system, select the Tasks menu button.

Performing SQL Searches

  1. Select the schema link to view the database schema HTML for reference in a new tab or page in your browser.

  2. Select the Time Conversion button to open the Time Conversion pop-up that allows you to convert the epoch date value to a time stamp or a time stamp into an epoch date value. Select the Convert To Epoch or Convert To Date button to put the time/date into the query in the desired format. Select the Now button to insert the current date/time, or select the Clear button to clear the fields. Select the Cancel button to close the pop-up.
  3. Select the Query Description button to open the Query Description pop-up. Enter a description of the query in the field, and then select the Save button. Select the Cancel button to close the pop-up without saving any changes.
  4. Select a script from the Select a script... drop-down list. When the script is selected, it appears in the text field above the drop-down list.
  5. Select the Load From File button to display the File Upload pop-up. Select the Browse... button to upload a file from your computer.
    • Select the Decode URL characters checkbox to have the system decode any URL characters.
    • Select the Upload button to upload the file, or select the Cancel button to close the pop-up without uploading a file.

  6. Select the History button to display the History pop-up. The History pop-up displays all queries run during the current user session. The pop-up allows the user to select queries from a list and Overwrite or Append them to the current Query Tool text area.

  7. Select the Save To File button to open the file on your computer as well as save the file.
  8. Select the Run Query button to perform the search. Select the Clear Query button to stop the respective processing and return control to the user. This setting stops long-running queries that are not likely to finish in a relatively short time.
  9. The system displays the status of the query in green text below the search options and above the search results.
  10. If you have the necessary security right, the system displays the Unrestricted Query checkbox. Select this option to perform any query (not just "SELECT" commands) other than an "UPDATE," "DELETE," or "DROP" command.
  11. Select either the Formatted Results or the Text Results option to set how the system should display the matching results.
    • Formatted Results: Displays the results in a formatted table.

    • Text Results: Displays the results in a text format, which allows you to copy and paste the text into another program to review or manipulate the data.

  12. Use the sliders at the top left corner of the results to configure how many columns and rows the system displays at a time.

  13. Modify your query or load and run another script, if desired, or save the script to run at a later time. See "Saving and Deleting Scripts" below.

Saving and Deleting Scripts

  1. Once you have entered a search, you may save it as a script.
  2. To save a script, select Save (or press the Alt+S hotkey), and the system prompts you to enter a name for the script in the Save Script pop-up. Enter the name and select Save, or select Cancel to cancel the save operation.

    When you save a script, the system only saves the contents of the Enter SQL Query field and the script name. It does not save your selection for Formatted Results or Text Results.

  3. Select the Delete button to delete the query from the Query Tool page.
  4. Once you save a script, you may select it from the drop-down list to perform that SQL search again. See "Performing SQL Searches" above.
  5. To delete a saved script, select the script in the drop-down list, and then press and hold the Alt and Shift keys while selecting Delete. You must press those keys in order to use Delete.