Commit 5f835a31 authored by Jeffrey Schlitt's avatar Jeffrey Schlitt

fixed page issues

parent 744b2ecf
......@@ -15,12 +15,12 @@ The documentation consists of the following sections:
.. toctree::
:maxdepth: 2
docs/admin/install_pro
docs/connections/configure_connections
docs/Object_Browser/using_browser
docs/Query_Panel/using_panel
docs/catalog/using_catalog
docs/discovery/using_discovery
docs/reference/reference
docs/admin/troubleshooting
docs/admin/install_team
aginity-pro/docs/connections/configure_connections
aginity-pro/docs/Object_Browser/using_browser
aginity-pro/docs/Query_Panel/using_panel
aginity-pro/docs/catalog/using_catalog
aginity-pro/docs/discovery/using_discovery
aginity-pro/docs/reference/reference
aginity-pro/docs/admin/troubleshooting
docs/admin/eula
......@@ -84,14 +84,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="docs/admin/install_pro.html">Installing Aginity Team</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/connections/configure_connections.html">Configuring Connections in Aginity Team</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/Object_Browser/using_browser.html">Using the Database Explorer in Aginity Team</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/Query_Panel/using_panel.html">Using the Query Panel in Aginity Team</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/catalog/using_catalog.html">Using the Catalog in Aginity Team</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/discovery/using_discovery.html">Using Discovery Panel in Aginity Team</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/reference/reference.html">Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/admin/troubleshooting.html">Troubleshooting</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/admin/install_team.html">Installing the Catalog Server for Aginity Team</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/admin/eula.html">End User License for Aginity Team</a></li>
</ul>
......
......@@ -36,7 +36,7 @@
<link rel="stylesheet" href="_static/theme_overrides.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Installing Aginity Team" href="docs/admin/install_pro.html" />
<link rel="next" title="Installing the Catalog Server for Aginity Team" href="docs/admin/install_team.html" />
</head>
<body class="wy-body-for-nav">
......@@ -84,14 +84,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="docs/admin/install_pro.html">Installing Aginity Team</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/connections/configure_connections.html">Configuring Connections in Aginity Team</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/Object_Browser/using_browser.html">Using the Database Explorer in Aginity Team</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/Query_Panel/using_panel.html">Using the Query Panel in Aginity Team</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/catalog/using_catalog.html">Using the Catalog in Aginity Team</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/discovery/using_discovery.html">Using Discovery Panel in Aginity Team</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/reference/reference.html">Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/admin/troubleshooting.html">Troubleshooting</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/admin/install_team.html">Installing the Catalog Server for Aginity Team</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/admin/eula.html">End User License for Aginity Team</a></li>
</ul>
......@@ -154,7 +147,7 @@
<div class="rst-breadcrumbs-buttons" role="navigation" aria-label="breadcrumb navigation">
<a href="docs/admin/install_pro.html" class="btn btn-neutral float-right" title="Installing Aginity Team" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="docs/admin/install_team.html" class="btn btn-neutral float-right" title="Installing the Catalog Server for Aginity Team" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>
......@@ -171,53 +164,12 @@
<p>The documentation consists of the following sections:</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="docs/admin/install_pro.html">Installing Aginity Team</a><ul>
<li class="toctree-l2"><a class="reference internal" href="docs/admin/install_pro.html#mac-install">Mac Install</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/admin/install_pro.html#windows-install">Windows Install</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/admin/install_pro.html#opening-for-the-first-time">Opening for the First Time</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/admin/install_team.html">Installing the Catalog Server for Aginity Team</a><ul>
<li class="toctree-l2"><a class="reference internal" href="docs/admin/install_team.html#pre-requisites">Pre-Requisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/admin/install_team.html#accessing-var-product-name-for-the-first-time">Accessing Aginity Team for the First Time</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/admin/install_team.html#stopping-var-product-name-services">Stopping Aginity Team Services</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="docs/connections/configure_connections.html">Configuring Connections in Aginity Team</a><ul>
<li class="toctree-l2"><a class="reference internal" href="docs/connections/configure_connections.html#setting-up-netezza-connections">Setting up Netezza Connections</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/connections/configure_connections.html#setting-up-redshift-connections">Setting up Redshift Connections</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/connections/configure_connections.html#setting-up-snowflake-connections">Setting up Snowflake Connections</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/connections/configure_connections.html#setting-up-hive-connections">Setting up Hive Connections</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/connections/configure_connections.html#setting-up-aginity-enterprise-aqe-connections">Setting up Aginity Enterprise (AQE) Connections</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="docs/Object_Browser/using_browser.html">Using the Database Explorer in Aginity Team</a><ul>
<li class="toctree-l2"><a class="reference internal" href="docs/Object_Browser/using_browser.html#viewing-the-database-data-dictionary">Viewing the Database Data Dictionary</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/Object_Browser/using_browser.html#quick-actions-from-explorer">Quick Actions from Explorer</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="docs/Query_Panel/using_panel.html">Using the Query Panel in Aginity Team</a><ul>
<li class="toctree-l2"><a class="reference internal" href="docs/Query_Panel/using_panel.html#writing-your-first-query">Writing your First Query</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/Query_Panel/using_panel.html#using-parameters-in-your-query">Using Parameters in your Query</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/Query_Panel/using_panel.html#common-actions-in-query-panel">Common Actions in Query Panel</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/Query_Panel/using_panel.html#interacting-with-query-results">Interacting with Query Results</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="docs/catalog/using_catalog.html">Using the Catalog in Aginity Team</a><ul>
<li class="toctree-l2"><a class="reference internal" href="docs/catalog/using_catalog.html#catalog-overview">Catalog Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/catalog/using_catalog.html#calling-catalog-items-from-sql">Calling Catalog Items from SQL</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/catalog/using_catalog.html#adding-items-to-catalog">Adding Items to Catalog</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/catalog/using_catalog.html#import-and-export-items-from-catalog">Import and Export Items from Catalog</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="docs/discovery/using_discovery.html">Using Discovery Panel in Aginity Team</a><ul>
<li class="toctree-l2"><a class="reference internal" href="docs/discovery/using_discovery.html#searching-query-execution-history">Searching Query Execution History</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/discovery/using_discovery.html#searching-the-amp-pro-catalog">Searching the Amp Pro Catalog</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/discovery/using_discovery.html#expanding-the-results">Expanding the results</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/discovery/using_discovery.html#doing-more-with-the-discovery-panel">Doing More with the Discovery Panel</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="docs/reference/reference.html">Reference</a><ul>
<li class="toctree-l2"><a class="reference internal" href="docs/reference/reference.html#video-reference">Video Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/reference/reference.html#shortcut-key-reference">Shortcut Key Reference</a></li>
<li class="toctree-l2"><a class="reference internal" href="docs/reference/reference.html#sql-reference-guides-for-supported-connections">SQL Reference Guides for Supported connections</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="docs/admin/troubleshooting.html">Troubleshooting</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/admin/eula.html">End User License for Aginity Team</a></li>
</ul>
</div>
......
No preview for this file type
......@@ -84,14 +84,7 @@
<ul>
<li class="toctree-l1"><a class="reference internal" href="docs/admin/install_pro.html">Installing Aginity Team</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/connections/configure_connections.html">Configuring Connections in Aginity Team</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/Object_Browser/using_browser.html">Using the Database Explorer in Aginity Team</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/Query_Panel/using_panel.html">Using the Query Panel in Aginity Team</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/catalog/using_catalog.html">Using the Catalog in Aginity Team</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/discovery/using_discovery.html">Using Discovery Panel in Aginity Team</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/reference/reference.html">Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/admin/troubleshooting.html">Troubleshooting</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/admin/install_team.html">Installing the Catalog Server for Aginity Team</a></li>
<li class="toctree-l1"><a class="reference internal" href="docs/admin/eula.html">End User License for Aginity Team</a></li>
</ul>
......
This diff is collapsed.
<?xml version="1.0" encoding="UTF-8"?>
<svg width="160px" height="160px" viewBox="0 0 160 160" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<!-- Generator: Sketch 54.1 (76490) - https://sketchapp.com -->
<title>Icon-Pro</title>
<desc>Created with Sketch.</desc>
<defs>
<linearGradient x1="13.1309141%" y1="17.8838845%" x2="100%" y2="129.649199%" id="linearGradient-1">
<stop stop-color="#6CA3BA" offset="0%"></stop>
<stop stop-color="#2C2D65" offset="100%"></stop>
</linearGradient>
</defs>
<g id="Icon-Pro" stroke="none" stroke-width="1" fill="none" fill-rule="evenodd">
<g id="Group-2" transform="translate(2.000000, 5.000000)">
<path d="M121.446443,146 C78.5,146 78.5,141.196156 35.5543454,141.196156 C20.0626455,141.196156 5,131.552156 5,116.693527 C5,75.5 10.0082626,75.5 10.0082626,34.3064727 C10.0082626,19.4478437 20.0626455,5 35.5543454,5 C78.5,5 78.5,9.80384372 121.446443,9.80384372 C136.938143,9.80384372 152,19.4478437 152,34.3064727 C152,75.5 146.992526,75.5 146.992526,116.693527 C146.992526,131.552156 136.938143,146 121.446443,146" id="Fill-12" fill="url(#linearGradient-1)" transform="translate(78.500000, 75.500000) rotate(-4.000000) translate(-78.500000, -75.500000) "></path>
<g id="icon/Logo/Aginity-New/grey-Copy" transform="translate(42.000000, 40.000000)" fill="#FFFFFF">
<path d="M70.7093726,61.9948838 C70.0737184,60.4239428 69.7368016,56.6478337 69.7368016,56.6478337 C69.2759691,51.5609474 69.7937359,44.8228303 69.988652,41.0529452 C69.9893218,41.0585468 69.9899916,41.0498332 69.9913312,41.0280492 C70.0047275,40.7429893 70.0676901,38.2353343 70.064341,36.6569244 C70.0636712,36.4135655 70.0616618,36.192613 70.0569731,36.0052702 L70.0569731,36.0058926 C70.0569731,35.5988421 70.0455862,35.1942812 70.0301805,34.7915875 C70.0315201,34.8239524 70.0362088,34.8563173 70.0375484,34.8886821 C69.5572913,22.2470881 60.8497002,10.5944898 47.2102634,6.22398745 C40.3560495,4.02877785 33.2667307,4.00076979 26.7936414,5.73789199 C26.8934438,5.71050633 26.9898971,5.67876386 27.0896995,5.652623 C26.9523875,5.68809988 26.8197642,5.73104557 26.683122,5.76776725 C26.3783563,5.85054664 26.0749302,5.93519322 25.7728438,6.02544142 C25.5149651,6.10261919 25.2590959,6.18353136 25.0045663,6.26631074 C24.9067734,6.29805321 24.806971,6.32543887 24.7098479,6.35842615 C24.6602816,6.37585338 24.6120549,6.39639263 24.5624886,6.41381987 C8.38244468,11.877259 -1.00500838,27.9663342 3.34275885,43.792756 C7.92964994,60.4868053 26.0809586,70.6238563 44.0507474,66.6311516 L44.0514172,66.6330188 C44.1378233,66.6149691 44.22222,66.5925627 44.3066166,66.5732682 C44.3930227,66.5533514 44.4780892,66.5359242 44.5631557,66.5166297 L44.5631557,66.5135177 C50.5794313,65.0875962 55.8120238,62.24011 59.9487994,58.4521753 C59.5449011,57.9579886 59.1523897,57.4538435 58.7799727,56.9341384 L58.7759538,56.9272919 C56.7805758,54.1513819 55.2982759,50.8358498 54.3498183,47.3068341 C51.3945958,51.4097039 46.8344973,54.5310467 41.2589597,55.7677582 L41.2596296,55.7677582 C40.9093165,55.8461808 40.5596732,55.9121553 40.2093601,55.9775075 C38.6868713,56.2519865 37.1483069,56.3584171 35.6171105,56.3341434 C33.3370612,56.2631897 30.8614261,55.8436912 28.7059624,55.119216 C19.85838,52.1404031 14.3491541,44.3902613 14.2895405,36.1303729 C14.2895405,36.0899168 14.2888707,36.0500831 14.2888707,36.009627 C14.2875311,33.706742 14.7095144,31.3646456 15.6023774,29.0735862 L15.6017075,29.0735862 C15.7015099,28.8165345 15.8120294,28.5657067 15.9198695,28.3130118 C19.2026314,20.8423282 27.1251997,15.6017088 36.3391707,15.6676833 C48.4165997,15.7554419 58.1309223,24.9234139 58.0364784,36.1459329 L58.0692993,36.1459329 L58.0384879,36.1465553 C58.0384879,36.7440606 58.0679597,37.202148 58.0780069,37.9764153 C58.435688,44.1251183 60.3486788,50.2707094 63.6863654,54.9138235 L63.6897145,54.9225372 C65.6375357,57.6349623 68.0126986,60.0305851 70.71875,62.0129335 C70.7167406,62.0073319 70.7127217,62.0004854 70.7093726,61.9948838" id="Fill-1"></path>
</g>
</g>
</g>
</svg>
Redshift,Hive,Netezza,Snowflake,Aginity Enterprise
Databases,Databases,Databases,Databases,Workspaces
Tables, Tables, Tables,Warehouses,Projects
Views, Views, Views,Tables,Tables (Sources)
Users,,,Views,Views (Notebooks or Views)
Groups,,,Scalar Functions,Columns
Libraries,,,Roles,
\ No newline at end of file
.. _objbrowse:
**********************************************************
Using the Database Explorer in |var_product_name|
**********************************************************
The Database Explorer panel in |var_product_name| can be toggled by using the **Database Explorer** and **Catalog** tabs on the left hand pane of the application as show below. The **Database Explorer** is used to navigate database objects based on the **Connections** defined in |var_product_name|. The **Catalog** browser is used to navigate SQL Analytics that you have personally stored.
Below is a quick start video of using the Database Explorer in |var_product_name|
.. raw:: html
<iframe width="560" height="315" src="https://www.youtube.com/embed/gOytEFeUsOw" frameborder="0" allowfullscreen>
</iframe>
|
Viewing the Database Data Dictionary
=====================================
Once you have established a connection to a database you can browse the database dictionary catalogs. You can toggle to the **Database Explorer** browser by clicking on the tab as shown below. The database data dictionaries typically contains the tables, columns, views and other database objects available to query from the query panel.
.. image:: ../../Pro_Images/Pro_Browser_DB.png
:scale: 30
:align: center
:alt: Browse the Database Catalog
Once you have selected the **Database Explorer** tab you can drill into each connection as shown below.
.. image:: ../../Pro_Images/pro_browser_navigate.png
:scale: 30
:align: center
:alt: Browse the Database Catalog
The following table will detail what objects are visible from the browser for each database connection type.
.. csv-table::
:file: db_capabilities.csv
:header-rows: 1
:align: center
Quick Actions from Explorer
===============================
Currently you can do the following quick actions from the **Database Explorer**
#. Drag and drop any object from the **Database Explorer** to the **Query Panel**
#. Copy the path of an object by right-clicking on the object and selecting **Copy Path**
.. seealso::
* :ref:`Use Catalog Browser <usecat>`
* :ref:`Use Query Panel <querypanel>`
Parameter Data Type, Action Taken
As Is, |var_product_name| will send the value exactly as written with no casting. This is often used when using the parameter to fill in database table or column names. See example 2 below.
Parameter Data Type, Action Taken
String, Upon completing the parameter value Pro will place single quotes '' around the value.
Integer, |var_product_name| will cast the variable as an integer datatype to the database.
Date, |var_product_name| will verify and cast the parameter as a date data type.
As Is, |var_product_name| will send the value exactly as written with no casting. This is often used when using the parameter to fill in database table or column names. See example 2 below.
Execution Type,Description
Run at cursor,When executing the query it will run the statement where the cursor is place up until the semicolon
Run all parts of the script in a sequence,Each statement in the window will be run sequentially and the output of each statement will be shown in the output and if the statement was a SELECT then a results panel will be displayed
Run entire script as a batch,
Abort Query,After executing a query you can direct |var_product_name| to send a request to the database to cancel the query.
.. _querypanel:
********************************************
Using the Query Panel in |var_product_name|
********************************************
You will spend most of your time in the Query Panel writing SQL and saving it to your catalog in |var_product_name|. The video below will give you an overview of creating your first query
.. raw:: html
<iframe width="560" height="315" src="https://www.youtube.com/embed/80PWV_fTgUI" frameborder="0" allowfullscreen>
</iframe>
|
Writing your First Query
=====================================
Each tab in the |var_product_name| application can be set to different database connections. Once you establish that connection as shown below you can use the query panel like a text editor using SQL syntax specific to that database platform.
.. image:: ../../Pro_Images/Pro_Query_panel_1stQuery.png
:scale: 30
:align: center
:alt: 1st Query
Once you write your code in |var_product_name| you have options to run it using the following scope:
.. image:: ../../Pro_Images/Pro_query_panel_scope.png
:scale: 30
:align: center
:alt: 1st Query
.. csv-table::
:file: run_scope.csv
:header-rows: 1
:align: center
:widths: 15,30
.. seealso::
:ref:`Note one of the greatest challenges in SQL is learning the different functional syntax from different database vendors. We are trying to make that easy by giving you links to the SQL reference manuals we support <sqlref>`
|
.. _useparam:
Using Parameters in your Query
=====================================
Parameters can be used in |var_product_name| by using the **$** in any part of a SQL statement. When you execute a query the |var_product_name| application will ask you to fill in the value of the parameter before it sends the query to the database.
.. code-block:: SQL
:linenos:
--sample parameter query
select *
from landing_dim_customer
where gender = $fill_in_gender_at_runtime
limit 100;
You will have datatype choices at runtime as shown in the table below.
.. csv-table::
:file: param_scope.csv
:header-rows: 1
:align: center
:widths: 15,30
Common Actions in Query Panel
=====================================
* Renaming Tabs
* Commenting SQL
* Keeping Connection
Renaming Tabs
----------------
You can rename the query tabs by double clicking and typing in a name as shown below.
.. image:: ../../Pro_Images/pro_query_panel_rename_tab.png
:scale: 40
:align: center
:alt: rename tab
Commenting SQL
----------------------------
In |var_product_name| you can use the typical SQL syntax to comment your code as shown below
.. code-block:: SQL
:linenos:
-- This is one way to comment your SQL code
SELECT AVG(LineTotal)
FROM sales.SalesOrderDetail
/* This is another way to comment your SQL code */
Keeping Connection
--------------------
The **Keep Connection** checkbox as show below will instruct |var_product_name| to maintain the connection to the database if the default behavior of the database is to disconnect after the execution of a query. You are still subject to an overall database connection timeout if you session connection exceeds the permitted database setting.
.. image:: ../../Pro_Images/Pro_Query_panel_keepconn.png
:scale: 50
:align: center
:alt: Keep Connection
Interacting with Query Results
=====================================
Once your query has been executed you can use the features of the result grid to interact with the result set. The typical actions you will do are listed below.
* Reordering the Result Grid
* Sorting the Result Grid
* Filtering the Result Grid
* Exporting results to CSV
Reordering the Result Grid
--------------------------
Once a query has executed successfully, you may rearrange the columns in the Result Grid in order
to more effectively perform subsequent analyses. Rearranging the Result Grid is simple: simply click,
hold, and drag the column header for the column you wish to move. As you move it left or right, the
grid will automatically adjust to reposition the column.
.. image:: ../../Pro_Images/pro_query_panel_results_sort_before.png
:scale: 50
:align: center
:alt: Before rearranging query results
Once you are satisfied with the new position of the column, you may release the drag and the column will
lock into place.
.. image:: ../../Pro_Images/pro_query_panel_results_rearrange_after.png
:scale: 50
:align: center
:alt: After rearranging query results columns
Sorting the Result Grid
-----------------------
After successfully executing a query, if the query has returned any rows you may sort the results in
order to permit various types of analysis of your results.
.. image:: ../../Pro_Images/pro_query_panel_results_sort_before.png
:scale: 50
:align: center
:alt: Before sorting query results
In order to sort your results, simply click on the header row in the results grid. If the results are
already being sorted by that column, then the sort order will toggle between ascending and descending.
.. image:: ../../Pro_Images/pro_query_panel_results_sort_after.png
:scale: 50
:align: center
:alt: After sorting query results by channel name
Filtering the Result Grid
-------------------------
Data in the Result Grid may be filtered to make it easier to locate and analyze certain subsets of
the resultant data, without requiring you to submit an entirely separate query.
To filter the result grid by values in a particular column, bring your mouse cursor to the column
header for the column to which you wish to apply a filter. In the right-hand side on the header row the
filter icon (three horizontal bars) will appear. Click on the filter icon and you will be presented
with a pop-up menu that will allow you to enter your filter criteria.
.. image:: ../../Pro_Images/pro_query_panel_results_filter_popup.png
:scale: 50
:align: center
:alt: Popup displayed for filtering results
By default, the filter criteria will select a "Contains" filter, but several other filter types exist
and you may select any of them. Once you have selected the filter type you wish to apply, type the
filter into the text box. The results will immediately begin to filter.
.. image:: ../../Pro_Images/pro_query_panel_results_filter_applied.png
:scale: 50
:align: center
:alt: Results filtered after entering criteria
When a column is being filtered, a funnel icon will appear in its header. To remove the filter, you
may re-enter the filter mode by clicking on the filter icon (three bars) in the header row, and simply
delete the filter text.
Multiple columns may have active filters at the same time. To accomplish this, simply perform these
steps on each column.
Exporting results to CSV
------------------------
Once you have successfully executed a query you can elect to export those results in Comma Separated
Value (CSV) format to a file outside of |var_product_name|. To do this, right-click anywhere in the results
panel. Doing this will display a context menu from which you will select the option "Export to CSV".
.. image:: ../../Pro_Images/pro_query_panel_results_export.png
:scale: 50
:align: center
:alt: Exporting your query results to a CSV file
After selecting this option, you will be presented with a screen that permits you to select the location
to which to save your results. Once you have identified the proper location, press the Save button to
complete the export.
CSV files may subsequently be imported into a large number of different programs for further review
and analysis.
.. seealso::
* :ref:`Adding Query to Catalog <addcat>`
* :ref:`Using Discovery Panel <usedisc>`
*******************************
Installing |var_product_name|
*******************************
The following sections will discussing installing |var_product_name| on both Windows and Mac. To start download the software if you have not from the `Aginity Web Site <https://www.aginity.com>`_
Mac Install
==============
To start the Mac install click on the Pro "dmg" file you downloaded.
.. image:: ../../Pro_Images/pro_install_mac.png
:scale: 30
:align: center
:alt: Installing on Mac
Drag the |var_product_name|.app icon into your Applications Directory. Once complete you can open the application from your Launchpad icon.
.. image:: ../../Pro_Images/pro_install_open_app_mac.png
:scale: 15
:align: center
:alt: Launching on Mac
Windows Install
==================
To start the Windows install click on the Pro "exe" file you downloaded.
You will be prompted to fill first choose whether to install as `Only for me <https://docs.microsoft.com/en-us/windows/desktop/Msi/installation-context>`_ or `Anyone who uses this computer (all users) <https://docs.microsoft.com/en-us/windows/desktop/Msi/installation-context>`_ on the machine. If you are installing the application on a VM or other shared infrastructure you should choose all users.
.. image:: ../../Pro_Images/pro_install_windows_1.png
:scale: 30
:align: center
:alt: Installing on Windows Pick Context
Secondly, pick the installation directory for the software.
.. image:: ../../Pro_Images/pro_install_windows_2.png
:scale: 30
:align: center
:alt: Picking Destination Folder
Once complete you should be able to launch |var_product_name|.
.. image:: ../../Pro_Images/pro_install_windows_3.png
:scale: 30
:align: center
:alt: Launching on Windows
Opening for the First Time
===========================
Once you have opened the application you will be presented with a clean instance of |var_product_name|.
.. image:: ../../Pro_Images/pro_install_first_open.png
:scale: 15
:align: center
:alt: Opening Amp
Once you open |var_product_name| you will commonly do these Actions.
.. seealso::
:ref:`Add Connections <newconn>`
Issue Number,Is this a Defect,Source of Error,Description of Error,Resolution
,,,,
\ No newline at end of file
Asset Folder,Asset Name,Asset SQL,In Query Panel,What is Executed
Personal View,OrderAverage,"
Select AVG(LineTotal)
from Sales.SalesOrderDetail","Select *
from (@{OrderAverage}) a;","Select *
from (
select AVG(lineTotal)
from Sales.SalesOrderDetail
) a;"
Relationships,ClientAddress,"clients c
join addresses a
on c.clientsid = a.clientsid","Select *
from @{ClientAddress};","Select *
from clients c
join addresses a
on c.clientsid = a.clientsid;"
Calculation,Residual,1-total,"Select item,
@{Residual}
from table;","Select item,
1-total
from table;"
Multi-Step Script,DailyRun,"create table xyz as...;
create table abc as...;
select * from xyz join abc...;","""@{DailyRun}""","
create table xyz as...;
create table abc as...;
select * from xyz join abc...;"
Using Parameters,CitySelect,"select *
from addresses
where city = $city;","""@{CitySelect}""","
select *
from addresses
where city = 'Chicago';"
\ No newline at end of file
.. _usecat:
******************************************
Using the Catalog in |var_product_name|
******************************************
.. raw:: html
<iframe width="560" height="315" src="https://www.youtube.com/embed/B4wzUg6HJ9Y" frameborder="0" allowfullscreen>
</iframe>
|
Catalog Overview
===========================================
The query catalog is a unique capability of |var_product_name| allowing you to easily save, manage and use items stored in it. Let's start with browsing the catalog.
The catalog is organized by any number of directories and sub-directories of queries as shown below.
.. image:: ../../Pro_Images/pro_catalog_browser_start.png
:scale: 30
:align: center
:alt: Browse the Database Catalog
.. seealso::
Click `Some link to best practice <https://www.aginity.com/main/blog/>`_ to see best practices for organizing catalogs.
Queries are given friendly names and can be used or accessed in several ways. The first way is to drag the catalog query into a **query panel** as shown in the two images below
.. figure:: ../../Pro_Images/pro_catalog_before_drag.png
:scale: 30
:align: center
:alt: Browse the Database Catalog
You can drag the query into the empty query panel
.. figure:: ../../Pro_Images/pro_catalog_post_drag.png
:scale: 30
:align: center
:alt: Browse the Database Catalog
After you drag the item it will present the full catalog query for edit or execution.
You can also edit queries within the catalogs. By right clicking on a query you can change the SQL itself, the description and folder options.
.. image:: ../../Pro_Images/pro_catalog_edit.png
:scale: 30
:align: center
:alt: Browse the Database Catalog
By previewing a query you can see key metadata items and statistics about the catalog as well as take action on the item.
.. image:: ../../Pro_Images/pro_catalog_preview.png
:scale: 30
:align: center
:alt: Browse the Database Catalog
Calling Catalog Items from SQL
================================
One of the most innovative features of |var_product_name| is the ability to call catalog items from within SQL statements
The video and following examples below will give you basic syntax required to call a catalog item.
.. raw:: html
<iframe width="560" height="315" src="https://www.youtube.com/embed/nvaviMx0xug" frameborder="0" allowfullscreen>
</iframe>
|
Single SQL SELECT Statement
--------------------------------
In this example we have a single SQL SELECT statement in the catalog called **OrderAverage**.
This is the code in the Catalog.
.. code-block:: SQL
:linenos:
SELECT AVG(LineTotal)
FROM sales.SalesOrderDetail
To call this from the query panel you would issue the following command. Note the highlighted reference to the object in the catalog.
.. code-block:: SQL
:linenos:
:emphasize-lines: 2
SELECT *
FROM (@{OrderAverage}) a;
This is the code passed to the database.
.. code-block:: SQL
:linenos:
SELECT *
FROM (
SELECT AVG(lineTotal)
FROM Sales.SalesOrderDetail
) a;
Using Catalog Item to Facilitate Relationships
--------------------------------------------------
In this example we will predefine a join in the catalog called **ClientAddress** and then use it in the context of another SQL statement.
This is the code in the Catalog.
.. code-block:: SQL
:linenos:
clients c
JOIN addresses a
ON c.clientsid = a.clientsid
To call this from the query panel you would issue the following command. Note the highlighted reference to the object in the catalog.
.. code-block:: SQL
:linenos:
:emphasize-lines: 2
SELECT *
FROM @{ClientAddress};
This is the code passed to the database.
.. code-block:: SQL
:linenos:
SELECT *
FROM clients c
JOIN addresses a
ON c.clientsid = a.clientsid;
Creating and Reusing Calculations
----------------------------------
In this example we will predefine a Calculations in the catalog called **Residual** and then use it in the context of another SQL statement.