This chapter provides a quick introduction to using the core Query Console features.
To begin using Query Console, open a browser and enter the URL:
http://your_host:8000/qconsole
If the application does not appear, you may not have sufficient privileges. To use Query Console, you must be a member of the qconsole-user
role. If your privileges are insufficient, contact your MarkLogic Server administrator.
Query Console does not grant extra access to databases or documents. To perform operations such as document insertion or deletion or database exploration from Query Console, you must have appropriate security privileges.
You should see a page similar to the following:
You should only have one Query Console session active at a time for any given MarkLogic user. Query Console saves state to MarkLogic Server. If a user has multiple Query Console sessions active concurrently, the state can become inconsistent. For example, do not log into Query Console as the same user in multiple browsers or browser tabs.
This section walks you through creating a new query.
The following example assumes an empty workspace named Workspace
, populated only with the default initial XQuery query, named Query 1
. This is the configuration you see the first time you launch Query Console.
hello
. Notice the name changes in the tab and in the workspace panel on the right.You can also rename a query by double-clicking its name in the workspace panel.
The Query Type determines what query language MarkLogic Server assumes for you query when it is evaluated. The supported query langages are:
The following example shows a native SPARQL query with the Query Type set appropriately.
Follow this procedure to evaluate a query and view the results. You should already have entered your query in the query editor and selected the appropriate Query Type. If not, refer to Creating a Query.
Query Console supports two modes for displaying query results, Auto and Raw. The default mode is Auto. In Auto mode, your query results are formatted for readability based on the query and the output type. For example:
In Auto mode, you can override the default rendering using the format dropdown at the far right of the results pane.
For example, strings are rendered as text by default, but if you know the string contains serialized JSON, you can change the rendering to JSON to get syntax highlighting and tree controls. The choices on the format dropdown depend on the type of data returned by your query.
Raw mode always displays plain text, but it is not necessarily the query results exactly as returned from MarkLogic Server. Slight formatting changes are still applied to improve readability. For example, even in Raw mode, an XQuery sequence displays as line items rather than a comma separated list of values.
Each time you modify a query and evaluate it, Query Console saves the contents and time of execution in the Query History. Query Console maintains a separate history for each query.
Query Console adds a history entry for each unique version of a query. If the query text is unchanged between runs or if the changes create a duplicate of an existing history entry for the query, Query Console does not create a new entry.
Query Console saves at most 50 history entries.
To remove a history entry, click the delete (X) button in the upper right corner of the entry.
To close the history dropdown, click on the Query History dropdown again, or simply move the mouse outside the dropdown.
You can use Query Console to profile the performance of a query. Query Console profiles your query as if you passed your query to prof:invoke,
and then displays a performance report in the results pane.
Profiling must be enabled on an App Server before you can profile a query. It is enabled by default when you create an App Server. For details, see MarkLogic Server Profiling Requirements Capabilities in the Query Performance and Tuning Guide.
Profiling is not available for Server-Side JavaScript queries.
Your Query Console query appears as the .main
module in the profiling report.
For details on profiling queries and the meaning of the profile report columns, see Profiling Requests to Evaluate Performance in Query Performance and Tuning Guide.
Use the Explore feature to browse the contents of a database. To explore a database:
For each document in the database, the summary includes the document URI, the type and name of the root node, a link to the document properties, and a link to any collections to which the document belongs.
In Query Console, you organize your queries in workspaces. You can create multiple workspaces. However, only one workspace is active at a time. When you create a new query, Query Console automatically saves it in the active workspace.
Use the workspace panel on the upper right of the page to interact with or change the active workspace. The workspace panel shows the name of the active workspace and lists the queries it contains:
To see a list of available workspaces or to create, clone, delete, import or export a workspace, use the dropdown menu to the right of the workspace name:
To rename a workspace, double-click on the workspace name at the top of the workspace panel:
To create a new workspace that contains the same queries as an existing workspace:
When you clone a workspace, all the queries in the original workspace are copied to the new workspace. Query histories are not copied.
To delete a workspace and all of the queries it contains:
If you delete the last workspace, Query Console automatically creates a workspace with the default initial contents.
Export a workspace to share it with another user or use it on a different MarkLogic Server instance. Exporting a workspace saves the workspace and queries to an external file which can be imported back into Query Console. Query history is not exported.
To import a previously exported workspace into Query Console:
To cancel the import, click anywhere outside the dialog box.
Import
to load the workspace. A loading progress window displays.If a workspace already exists with same name as the imported workspace, the imported workspace name is modified by appending a unique number to the name.