amps-python-client 5.3.4.1__zip → 5.3.4.2__zip

amps-python-client-5.3.4.1/docs/user-guide/html/_sources/chapters/views.rst.txt

@@ -1,175 +0,0 @@
-.. index:: Views, AMPS; Views,
-
-.. include:: ../macros.inc
-
-.. _#ug-views:
-
-.. _views:
-
-Aggregating and Analyzing Data in AMPS
-======================================
-
-AMPS contains a high-performance aggregation engine, which can be used
-to project one SOW topic onto another, similar to the ``CREATE VIEW``
-functionality found in most RDBMS software. The aggregation engine can
-join input from multiple topics, of the same or different message types,
-and can produce output in different message types.
-
-View topics are part of the AMPS SOW, which means that
-views support delta subscriptions and out of focus (OOF) tracking. A
-view can also be used as the underlying topic for another view.
-
-In addition, for the limited cases where a view is not practical, AMPS
-allows an individual subscription to request aggregation and projection
-of a single SOW topic.
-
-Notice that the features described in this chapter are designed for cases
-where an application needs to aggregate data across messages or to perform
-a calculation on an individual message that should not be preserved as a
-part of that message.
-
-To modify a message as it is published to AMPS, use *preprocessing or
-enrichment*.  To simply retrieve a subset of the fields in a message, use
-*select lists*.
-
-.. _#ug-views-understanding:
-
-Understanding Views
---------------------
-
-Views allow you to aggregate messages from one or more SOW topics in
-AMPS and present the aggregation as a new SOW topic. AMPS stores the
-contents of the view as serialized messages in memory, similar to a
-materialized view in RDBMS software.
-
-Views are often used to simplify subscriber implementation and can
-reduce the network traffic to subscribers. For example, if some clients
-will only process orders where the total cost of the order exceeds a
-certain value, you can both simplify subscriber code and reduce network
-traffic by creating a view that contains a calculated field for the
-total cost. Rather than receiving all messages and calculating the cost,
-subscribers can filter on the calculated field. You can also combine
-information from multiple topics. For example, you could create a view
-that contains orders from high-priority customers that exceed a certain
-dollar amount.
-
-AMPS sends messages to view topics the same way that AMPS sends messages
-to SOW topics: when a publish arrives for a message that is used to
-calculate the view, AMPS recalculates the values in the view as
-necessary and sends a message on the view topic. Likewise,
-you can query a view the same way that you query a SOW topic.
-
-Defining a view is straightforward. You set the name of the view, the
-SOW topic or topics from which messages originate and describe how you
-want to aggregate, or project, the messages. AMPS creates a topic and
-projects the messages as requested.
-
-A view requires one or more underlying topics. Any topic, view,
-or queue defined in the ``SOW`` section can be the underlying
-topic for a view. However, the underlying topic for the view
-must be defined in the AMPS configuration file before the
-view itself is defined.
-
-.. caution::
-
-   All message types that you specify in a view must support view
-   creation.
-
-Since AMPS uses the SOW topics of the underlying messages to determine
-when to update the view, the underlying topics used in a view must be
-in the SOW. Any topic, view, conflated topic, or queue defined
-in the ``SOW`` section can be the underlying topic for a view.
-However, the underlying topic or topics must be defined in the
-AMPS configuration file before the view is defined.
-
-AMPS updates each view after a publish or delta publish to a message in
-an underlying topic. Updates are processed for each view in the order in
-which AMPS processed the updates to the underlying topic. AMPS processes
-these updates asynchronously, after each SOW update is persisted. For
-additional performance, AMPS provides the ability to conflate updates to
-views that process high velocity updates, as described in
-:ref:`#inlineviewconflation`.
-
-As with a SOW topic, an incoming publish that does not change the value
-of the underlying message or the calculated value in the view is
-considered to be an update to the view topic.  If an application
-needs to see only changed fields, that application should use a
-delta subscription (with the ``no_empties`` option).
-
-.. tip::
-
-   When the underlying topic for a view is a queue,
-   the view will show only the messages in the queue
-   that are not currently leased to subscribers.    
-
-.. include:: ./joins.inc
-
-
-Constructing Fields
--------------------
-
-The AMPS expression language is used to construct fields in aggregates.
-
-The expression language is described in :ref:`#ug-amps-expressions`, and
-the available functions that you can use for constructing fields in a
-view are described in :ref:`#ug-amps-functions`.
-
-Using an expression to construct a field for a view is described in
-:ref:`#ug-constructing-view-fields`.
-
-Best Practices for Views
-------------------------
-
-When creating a view, consider the following best practices:
-
-* AMPS must compute and serialize each field in the view. Smaller
-  numbers of views, and less expensive calculations, may provide
-  better performance.
-
-* AMPS must determine the update to the view for each change
-  to an underlying topic.
-
-* For views that join multiple topics, consider the amount
-  of work produced by an update to each topic in the join.
-  You can estimate this by paying attention to the number
-  of matching messages on each side of the join.
-  
-  Consider a view that joins a large ``orders`` topic to 
-  an ``order_type`` topic with a much smaller number of
-  messages.  If, for each ``order_type``, there are
-  10000 matching messages in the ``orders`` topic,
-  then a publish that updates a message in the ``order_type``
-  topic would produce 10000 updates to a view joining these
-  two topics together. In cases like this, avoid making
-  unnecessary updates to an underlying topic with messages
-  that match a large number of messages on the other side
-  of the join. (For example, a change to update a value
-  in ``order_type`` would be a necessary change. Simply
-  republishing the same messages to ``order_type`` on
-  a periodic basis would produce a large number of updates
-  to the view without changing the results, and is more likely
-  to be unnecessary work.)
-
-* If an underlying message can have frequent updates
-  and subscribers only need to receive the final state
-  of the message in the view, consider using
-  the ``InlineConflation`` option to allow the view
-  to avoid processing intermediate changes where possible.
-
-* For topics that are the underlying topics of views,
-  avoid publishing updates that do not change the values
-  of the fields used in the view. Each update to an
-  underlying topic causes an update to the view. In
-  particular, an approach such as republishing a set
-  of lookup values every few minutes will produce a
-  large amount of work (while AMPS fully recalculates
-  the view) without a change in the results. In general,
-  unless the set of values that was republished is
-  significant, avoid republishing values to a topic
-  underlying a view.
-
-.. include:: ./view-examples.inc
-
-.. include:: ./aggregated_subscriptions.inc
-
-

amps-python-client-5.3.4.1/docs/user-guide/html/_sources/index.rst.txt

@@ -1,110 +0,0 @@
-.. _#ug-index:
-
-====================================================
-Advanced Message Processing System (AMPS) User Guide
-====================================================
-
-**Version** |version|
-
-**Publication Date** |today|
-
-.. toctree::
-   :maxdepth: 1
-   :numbered: 1
-   :hidden:
-
-   ./chapters/intro.rst
-   ./chapters/installing_and_starting.rst
-   ./chapters/pub_sub.rst
-   ./chapters/amps_expressions.rst
-   ./chapters/amps_functions.rst
-   ./chapters/constructing-fields.rst
-   ./chapters/sow.rst
-   ./chapters/sow_queries.rst
-   ./chapters/oof.rst
-   ./chapters/enrichment.rst
-   ./chapters/delta.rst
-   ./chapters/conflated_topics.rst
-   ./chapters/views.rst
-   ./chapters/txlog.rst
-   ./chapters/queues.rst
-   ./chapters/messageTypes.rst
-   ./chapters/acks.rst
-   ./chapters/transports.rst
-
-   ./chapters/daemon.rst
-   ./chapters/logging.rst
-   ./chapters/events.rst
-   ./chapters/utilities.rst
-   ./chapters/monitoring.rst
-   ./chapters/actions.rst
-   ./chapters/replication.rst
-   ./chapters/ha.rst
-   ./chapters/operation.rst
-   ./chapters/securing.rst
-   ./chapters/troubleshooting.rst
-
-   ./chapters/usecases.rst
-
-   ./chapters/distribution.rst
-   ./chapters/config-file-shortcuts.rst
-   ./chapters/spark.rst
-   ./chapters/auxiliary_modules.rst
-   ./chapters/amps-statistics.rst
-   ./chapters/file_format_versions.rst
-   ./chapters/glossary.rst
-
-Overview and Features
----------------------
-
-1. :ref:`intro`
-2. :ref:`installing_and_starting`
-3. :ref:`pub_sub`
-4. :ref:`amps_expressions`
-5. :ref:`amps_functions`
-6. :ref:`constructing-fields`
-7. :ref:`sow`
-8. :ref:`sow_queries`
-9. :ref:`oof`
-10. :ref:`enrichment`
-11. :ref:`delta`
-12. :ref:`conflated_topics`
-13. :ref:`views`
-14. :ref:`txlog`
-15. :ref:`queues`
-16. :ref:`messageTypes`
-17. :ref:`acks`
-18. :ref:`transports`
-
-Deployment and Operations
--------------------------
-
-19. :ref:`daemon`
-20. :ref:`logging`
-21. :ref:`events`
-22. :ref:`utilities`
-23. :ref:`monitoring`
-24. :ref:`actions`
-25. :ref:`replication`
-26. :ref:`ha`
-27. :ref:`operation`
-28. :ref:`securing`
-29. :ref:`troubleshooting`
-
-Use Cases
--------------------------
-
-30. :ref:`usecases`
-
-
-Appendices
--------------------------
-
-31. :ref:`distribution`
-32. :ref:`config-file-shortcuts`
-33. :ref:`spark`
-34. :ref:`auxiliary_modules`
-35. :ref:`amps-statistics`
-36. :ref:`file_format_versions`
-37. :ref:`glossary`
-

amps-python-client-5.3.4.1/docs/user-guide/html/_static/custom.css

@@ -1,192 +0,0 @@
-.sphinxsidebar {
-    overflow: scroll !important;
-    height: 100%;
-}
-
-.logo {
-    margin:auto;
-    width: 75%;
-}
-
-
-div.body h2 {
-	border-top: 1.5ex solid #7ccadb !important;
-	padding-top: .75ex;
-	border-bottom: .5px solid grey !important;
-	padding-bottom: .75ex;
-	font-weight: 570;
-}
-
-div.body h3 {
-	border-top: .5px solid darkgrey !important;
-	padding-top: 1.25ex;
-	font-weight: 570;
-}
-
-div.body h4 {
-	border-top: .25px solid grey !important;
-	padding-top: 1.25ex;
-	font-weight: 525;
-	font-style: italic;
-}
-
-div.body h5 {
-        border-top: .25px solid lightgrey !important;
-	padding-top: 1ex;
-	font-weight: 525;
-	font-style: italic;
-}
-
-/*
-div.tip#title:before {
-	content: url("../_images/tip.svg");
-	width: 25%;
-	border-radius: 2em;
-}
-*/
-
-div.tip:before {
-	content: url("../_images/tip.png");
-	border-radius: 20em;
-        margin-right: 1em;
-        /*border-bottom-style: groove;*/
-	display: flex;
-	align-items: center;
-	float: left;
-}
-
-div.tip {
-	background: ivory;
-	border-style: ridge;
-}
-
-
-div.caution:before {
-	content: url("../_images/caution.png");
-	border-radius: 20em;
-	margin-right: 1em;
-	display: flex;
-	align-items: center;
-	float: left;
-}
-
-div.caution {
-	background: mistyrose;
-	border-style: ridge;
-}
-
-
-div.req::before {
-	content: "Required";
-        display: table-cell;
-	border-radius: 25em;
-        border: 2px solid #73AD21;
-        background: #e6ffe6;
-        background-image: linear-gradient(0deg, #00FF00, transparent);
-        padding: 2px; 
-        margin: 1px;
-        font-size: x-small;
-        font-family: 'Tahoma', sans-serif;
-}
-
-div.req
-{
-	font-family:'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
-	background: #d1d1e0;
-}
-
-
-div.important:before {
-	content: url("../_images/important.png");
-        border-radius: 20em;
-        margin-right: 1em;
-	display: flex;
-	align-items: center;
-	float: left;
-}
-
-div.important {
-	background-color: #e6fff2;
-	border-style: ridge;
-}
-
-
-
-div.warning:before {
-	content: url("../_images/warning.png");
-	border-radius: 20em;
-        margin-right: 1em;
-	display: flex;
-	align-items: center;
-	float: left;
-}
-
-div.warning {
-	background: #f7bcbc;
-	border-style: ridge;
-}
-
-
-
-
-div.bodywrapper:before {
-   display: block;
-   content: "PRE-RELEASE DOCUMENTATION: DO NOT USE";
-   color: white;
-   font-size: 20px;
-   font-weight: 900;
-   text-align: center;
-   background: darkred;
-   margin: 10px;
-   padding: 10px;
-   border-radius: 5px;
-   width: 100%;
-   position: relative;
-}
-
-div.bodywrapper:after {
-   display: block;
-   content: "PRE-RELEASE DOCUMENTATION: DO NOT USE";
-   color: white;
-   font-size: 20px;
-   font-weight: 900;
-   text-align: center;
-   background: darkred;
-   margin: 10px;
-   padding: 10px;
-   border-radius: 5px;
-   width: 100%;
-   position: relative;
-}
-
-
-div.bodywrapper:before {
-   display: block;
-   content: "PRE-RELEASE DOCUMENTATION: DO NOT USE";
-   color: white;
-   font-size: 20px;
-   font-weight: 900;
-   text-align: center;
-   background: darkred;
-   margin: 10px;
-   padding: 10px;
-   border-radius: 5px;
-   width: 100%;
-   position: relative;
-}
-
-div.bodywrapper:after {
-   display: block;
-   content: "PRE-RELEASE DOCUMENTATION: DO NOT USE";
-   color: white;
-   font-size: 20px;
-   font-weight: 900;
-   text-align: center;
-   background: darkred;
-   margin: 10px;
-   padding: 10px;
-   border-radius: 5px;
-   width: 100%;
-   position: relative;
-}
-

amps-python-client-5.3.4.1/docs/user-guide/html/_static/custom.css.backup

@@ -1,161 +0,0 @@
-.sphinxsidebar {
-    overflow: scroll !important;
-    height: 100%;
-}
-
-.logo {
-    margin:auto;
-    width: 75%;
-}
-
-
-div.body h2 {
-	border-top: 1.5ex solid #7ccadb !important;
-	padding-top: .75ex;
-	border-bottom: .5px solid grey !important;
-	padding-bottom: .75ex;
-	font-weight: 570;
-}
-
-div.body h3 {
-	border-top: .5px solid darkgrey !important;
-	padding-top: 1.25ex;
-	font-weight: 570;
-}
-
-div.body h4 {
-	border-top: .25px solid grey !important;
-	padding-top: 1.25ex;
-	font-weight: 525;
-	font-style: italic;
-}
-
-div.body h5 {
-        border-top: .25px solid lightgrey !important;
-	padding-top: 1ex;
-	font-weight: 525;
-	font-style: italic;
-}
-
-/*
-div.tip#title:before {
-	content: url("../_images/tip.svg");
-	width: 25%;
-	border-radius: 2em;
-}
-*/
-
-div.tip:before {
-	content: url("../_images/tip.png");
-	border-radius: 20em;
-        margin-right: 1em;
-        /*border-bottom-style: groove;*/
-	display: flex;
-	align-items: center;
-	float: left;
-}
-
-div.tip {
-	background: ivory;
-	border-style: ridge;
-}
-
-
-div.caution:before {
-	content: url("../_images/caution.png");
-	border-radius: 20em;
-	margin-right: 1em;
-	display: flex;
-	align-items: center;
-	float: left;
-}
-
-div.caution {
-	background: mistyrose;
-	border-style: ridge;
-}
-
-
-div.req::before {
-	content: "Required";
-        display: table-cell;
-	border-radius: 25em;
-        border: 2px solid #73AD21;
-        background: #e6ffe6;
-        background-image: linear-gradient(0deg, #00FF00, transparent);
-        padding: 2px; 
-        margin: 1px;
-        font-size: x-small;
-        font-family: 'Tahoma', sans-serif;
-}
-
-div.req
-{
-	font-family:'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
-	background: #d1d1e0;
-}
-
-
-div.important:before {
-	content: url("../_images/important.png");
-        border-radius: 20em;
-        margin-right: 1em;
-	display: flex;
-	align-items: center;
-	float: left;
-}
-
-div.important {
-	background-color: #e6fff2;
-	border-style: ridge;
-}
-
-
-
-div.warning:before {
-	content: url("../_images/warning.png");
-	border-radius: 20em;
-        margin-right: 1em;
-	display: flex;
-	align-items: center;
-	float: left;
-}
-
-div.warning {
-	background: #f7bcbc;
-	border-style: ridge;
-}
-
-
-
-
-div.bodywrapper:before {
-   display: block;
-   content: "PRE-RELEASE DOCUMENTATION: DO NOT USE";
-   color: white;
-   font-size: 20px;
-   font-weight: 900;
-   text-align: center;
-   background: darkred;
-   margin: 10px;
-   padding: 10px;
-   border-radius: 5px;
-   width: 100%;
-   position: relative;
-}
-
-div.bodywrapper:after {
-   display: block;
-   content: "PRE-RELEASE DOCUMENTATION: DO NOT USE";
-   color: white;
-   font-size: 20px;
-   font-weight: 900;
-   text-align: center;
-   background: darkred;
-   margin: 10px;
-   padding: 10px;
-   border-radius: 5px;
-   width: 100%;
-   position: relative;
-}
-