Query Sandbox

The GoToAssist query sandbox is a controlled test area or scratch space separate from your actual data, where you can safely test unverified PQL queries, develop untested add-on applications, or give third-party apps a trial run without impacting the data in your Search Index.

Caution: Make sure to run all tests from the Sandbox. Any statements in the Search field at the top of the page run against the real data in your Search Index.

• Insert sample data
• Test PQL statements
• Reset the sandbox

Insert sample data

To verify that a query is collecting information completely, insert a known chunk of fictitious or sample data into the Sandbox so that when you run a new query against it, you can tell if the results are complete.

To insert sample data for testing:

1. In the Sandbox test field, type an INSERT statement, and then click Execute to put a known chunk of data in the Sandbox. For example, the following statement adds the sample database used in examples throughout the GoToAssist documentation:

INSERT INTO / values {
   network => {
    device => {
      interface => {
         mac_address => '00:01:02:03:04:05', 
         ip_address => '10.10.10.20', 
         name => 'eth0', 
         status => 'up'}, 
       interface => {
         mac_address => '00:A1:A2:A3:A4:A5', 
         ip_address => '10.10.10.30', 
         name => 'eth1', 
         status => 'down'}}}, 
    network => {
  device => {
      interface => {
         name => 'eth0', 
         status => 'up'}, 
       interface => {
         name => 'eth1', 
         status => 'up'}}}}

Note: GoToAssist ignores any extra whitespace.

The results are displayed beneath the Sandbox test field:

2. Back in the Sandbox test field, overwrite the INSERT statement by typing your query over it, and click Execute.

3. Since the data is controlled, you can tell if the results of your query or PQL statement are complete, and modify it if not.

Test PQL statements

Note: For all testing, make sure to stay within the Sandbox test field. Any statements in the Search field at the top of the page will run against the real data in your Search Index.

To execute any PQL statement:

1. In the Sandbox test field, type a PQL statement, making sure to overwrite any text already in the field:

• SELECT
• INSERT
• MERGE
• UPDATE
• DELETE

2. Click Execute to run the PQL statement or query.

The results are displayed underneath the Sandbox test field.

Reset the Sandbox

The Sandbox retains what you input from one transaction to the next, until you either Reset, or close the Sandbox page. Exiting the Sandbox page removes anything you did within it.

To reset the Sandbox test field:

• Click the Reset button to erase any data in the field and make it ready for a new operation.

Related topics

• GoToAssist APIs
• Developing applications
• Writing crawler plugins
• For developers
• Developer sandbox
• Developer tools
• Learn about GoToAssist Query Language

| Views: 1763 | Last Updated: Thu, May 09 2013 2:29 PM

Is this article helpful?