PyPI - amps-python-client - Versions diffs - 5.3.4.1__zip - Mend

amps-python-client 5.3.4.1__zip

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (550) hide show

amps-python-client-5.3.4.1/docs/user-guide/html/chapters/file_format_versions.html ADDED Viewed

@@ -0,0 +1,229 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <title>36. File Format Versions &#8212; AMPS User Guide develop documentation</title>
+    <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
+    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../',
+        VERSION:     'develop',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true,
+        SOURCELINK_SUFFIX: '.txt'
+      };
+    </script>
+    <script type="text/javascript" src="../_static/jquery.js"></script>
+    <script type="text/javascript" src="../_static/underscore.js"></script>
+    <script type="text/javascript" src="../_static/doctools.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="next" title="37. Glossary of AMPS Terminology" href="glossary.html" />
+    <link rel="prev" title="35. The AMPS Statistics Database" href="amps-statistics.html" />
+  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+  </head>
+  <body role="document">
+  <div class="document">
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+            <p class="logo"><a href="../index.html">
+              <img class="logo" src="../_static/flag_logo.png" alt="Logo"/>
+            </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="../index.html">Documentation overview</a><ul>
+      <li>Previous: <a href="amps-statistics.html" title="previous chapter">35. The AMPS Statistics Database</a></li>
+      <li>Next: <a href="glossary.html" title="next chapter">37. Glossary of AMPS Terminology</a></li>
+  </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <form class="search" action="../search.html" method="get">
+      <div><input type="text" name="q" /></div>
+      <div><input type="submit" value="Go" /></div>
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+  <div class="section" id="file-format-versions">
+<span id="ug-appendix-file-format-versions"></span><span id="id1"></span><h1>36. File Format Versions<a class="headerlink" href="#file-format-versions" title="Permalink to this headline">¶</a></h1>
+<p>This chapter includes a simple cross-reference to the file format versions in
+recent AMPS releases. Using this guide, you can quickly determine whether your
+installation will need to run <code class="docutils literal"><span class="pre">amps_upgrade</span></code> when changing versions.</p>
+<table border="1" class="docutils" id="id2">
+<caption><span class="caption-text"><em>AMPS file format versions</em></span><a class="headerlink" href="#id2" title="Permalink to this table">¶</a></caption>
+<colgroup>
+<col width="20%" />
+<col width="20%" />
+<col width="20%" />
+<col width="20%" />
+<col width="20%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">AMPS version</th>
+<th class="head">SOW version</th>
+<th class="head">Journal version</th>
+<th class="head">Acks version</th>
+<th class="head">Queue Metadata version</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>3.8</td>
+<td>v1.0</td>
+<td>v3</td>
+<td>v1.0</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-odd"><td>3.9</td>
+<td>v1.0</td>
+<td>v3</td>
+<td>v1.0</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-even"><td>4.0</td>
+<td>v3.0</td>
+<td>v7</td>
+<td>v1.0</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-odd"><td>4.3</td>
+<td>v3.0</td>
+<td>v7</td>
+<td>v1.0</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-even"><td>5.0</td>
+<td>v3.0</td>
+<td>v8</td>
+<td>v1.0</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-odd"><td>5.2</td>
+<td>v3.0</td>
+<td>v8</td>
+<td>v1.0</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-even"><td>5.2.1</td>
+<td>v3.0</td>
+<td>v8</td>
+<td>v1.0</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-odd"><td>5.2.2</td>
+<td>v3.0</td>
+<td>v8</td>
+<td>v1.0</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-even"><td>5.2.3</td>
+<td>v3.0</td>
+<td>v8</td>
+<td>v1.0</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-odd"><td>5.2.4</td>
+<td>v3.0</td>
+<td>v8</td>
+<td>v1.0</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-even"><td>5.3.0</td>
+<td>v3.0</td>
+<td>v8</td>
+<td>v1.0</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-odd"><td>5.3.1</td>
+<td>v3.0</td>
+<td>v8</td>
+<td>v1.0</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-even"><td>5.3.2</td>
+<td>v3.0</td>
+<td>v8</td>
+<td>v1.0</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-odd"><td>5.3.3</td>
+<td>v3.0</td>
+<td>v8</td>
+<td>v1.0</td>
+<td>&#160;</td>
+</tr>
+<tr class="row-even"><td>5.3.4</td>
+<td>v3.0</td>
+<td>v8</td>
+<td>v1.0</td>
+<td>v001</td>
+</tr>
+</tbody>
+</table>
+<p>The <code class="docutils literal"><span class="pre">amps_upgrade</span></code> tool is provided for versions of AMPS 5.0 and earlier.
+The <code class="docutils literal"><span class="pre">amps_upgrade</span></code> tool updates the format of the data in the files that
+AMPS maintains. If there has been no version change to the format of the data,
+it is not necessary to run the tool to upgrade an AMPS instance.</p>
+<p>Notice that, while this chart describes the format of the files, AMPS versions
+may also change or extend the content of the files. In these cases, AMPS
+is guaranteed to be forward-compatible. That is, a given version of AMPS can
+process a file of the same file format version created on an earlier version
+of AMPS. However, later versions of AMPS may include changes in the content
+of the file that are not recognized by earlier versions of AMPS. This means
+that downgrading a file between major/minor versions of AMPS is not
+supported.</p>
+<div class="admonition caution">
+<p class="first admonition-title">Caution</p>
+<p>The contents of AMPS files are not guaranteed to be backward
+compatible across changes to the major or minor version number.
+That is, while an AMPS instance of version X.4 can successfully
+load a SOW file created by version X.3, the version X.3 instance
+may not be able to process a file created or updated by the
+X.4 version.</p>
+<p class="last">Contact 60East support for guidance if you intend to downgrade
+an instance of AMPS to an earlier version.</p>
+</div>
+</div>
+          </div>
+        </div>
+      </div>
+    <div class="clearer"></div>
+  </div>
+    <div class="footer">
+      &copy;2023 60East Technologies, Inc. (version develop).
+      |
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.5.3</a>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
+    </div>
+  </body>
+</html>

amps-python-client-5.3.4.1/docs/user-guide/html/chapters/glossary.html ADDED Viewed

@@ -0,0 +1,215 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    <title>37. Glossary of AMPS Terminology &#8212; AMPS User Guide develop documentation</title>
+    <link rel="stylesheet" href="../_static/alabaster.css" type="text/css" />
+    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '../',
+        VERSION:     'develop',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true,
+        SOURCELINK_SUFFIX: '.txt'
+      };
+    </script>
+    <script type="text/javascript" src="../_static/jquery.js"></script>
+    <script type="text/javascript" src="../_static/underscore.js"></script>
+    <script type="text/javascript" src="../_static/doctools.js"></script>
+    <link rel="index" title="Index" href="../genindex.html" />
+    <link rel="search" title="Search" href="../search.html" />
+    <link rel="prev" title="36. File Format Versions" href="file_format_versions.html" />
+  <link rel="stylesheet" href="../_static/custom.css" type="text/css" />
+  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+  </head>
+  <body role="document">
+  <div class="document">
+      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+        <div class="sphinxsidebarwrapper">
+            <p class="logo"><a href="../index.html">
+              <img class="logo" src="../_static/flag_logo.png" alt="Logo"/>
+            </a></p><div class="relations">
+<h3>Related Topics</h3>
+<ul>
+  <li><a href="../index.html">Documentation overview</a><ul>
+      <li>Previous: <a href="file_format_versions.html" title="previous chapter">36. File Format Versions</a></li>
+  </ul></li>
+</ul>
+</div>
+<div id="searchbox" style="display: none" role="search">
+  <h3>Quick search</h3>
+    <form class="search" action="../search.html" method="get">
+      <div><input type="text" name="q" /></div>
+      <div><input type="submit" value="Go" /></div>
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
+    </form>
+</div>
+<script type="text/javascript">$('#searchbox').show(0);</script>
+        </div>
+      </div>
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body" role="main">
+  <div class="section" id="glossary-of-amps-terminology">
+<span id="glossary"></span><h1>37. Glossary of AMPS Terminology<a class="headerlink" href="#glossary-of-amps-terminology" title="Permalink to this headline">¶</a></h1>
+<table border="1" class="docutils">
+<colgroup>
+<col width="26%" />
+<col width="74%" />
+</colgroup>
+<thead valign="bottom">
+<tr class="row-odd"><th class="head">Term</th>
+<th class="head">Definition</th>
+</tr>
+</thead>
+<tbody valign="top">
+<tr class="row-even"><td>Acknowledgment</td>
+<td><p class="first">A networking technique in which the receiver of a message
+is responsible for informing the sender that the message
+was received.</p>
+<p>In AMPS:</p>
+<ul class="last simple">
+<li>Commands to the AMPS server from an application are asynchronous:
+AMPS responds with acknowledgment messages to indicate the results
+of the command.</li>
+<li>An application acknowledges messages from an AMPS queue to indicate
+that the message has been fully processed, and AMPS can remove the
+message from the queue.</li>
+</ul>
+</td>
+</tr>
+<tr class="row-odd"><td>Authentication</td>
+<td>The process of establishing a proven identity for a connection to AMPS.</td>
+</tr>
+<tr class="row-even"><td>Conflation</td>
+<td>The process of merging a group of messages into a single message. For
+example, when a particular record in the SOW is updated hundreds or
+thousands of times a second, conflation can enable an application to
+receive the most recent update every 300ms, reducing the network traffic
+to the application while still guaranteeing that the application has
+recent data.</td>
+</tr>
+<tr class="row-odd"><td>Conflated Topic</td>
+<td>A copy of a SOW topic that conflates updates on a specified interval.
+This helps to conserve bandwidth and processing resources for
+subscribers to the conflated topic.</td>
+</tr>
+<tr class="row-even"><td>Delta</td>
+<td>A message that contains only the differences between the previous state
+of a stored message and the new state of the stored message. AMPS
+supports delta messaging for both publish (changing a subset of fields
+in a message) and subscribe (receiving only the fields of a message that
+have changed).</td>
+</tr>
+<tr class="row-odd"><td>Entitlement</td>
+<td>The process of assigning permissions to a connection based on the
+identity established for that connection.</td>
+</tr>
+<tr class="row-even"><td>Expression</td>
+<td>A text string that produces a specific value. AMPS uses expressions in
+filters and when constructing fields for enrichment or projecting views.</td>
+</tr>
+<tr class="row-odd"><td>Filter</td>
+<td>A text string that is used to match a subset of messages from a larger
+set of messages. In AMPS, every filter is an AMPS expression that
+returns TRUE or FALSE.</td>
+</tr>
+<tr class="row-even"><td>Message Expiration</td>
+<td>The process where the lifespan of records stored is limited.</td>
+</tr>
+<tr class="row-odd"><td>Message Type</td>
+<td>The data format used to encapsulate messages. Each message within AMPS
+has a single, defined message type. Each connection to AMPS uses a
+single, defined message type.</td>
+</tr>
+<tr class="row-even"><td>OOF (Out of Focus)</td>
+<td>Notification to a subscriber that a message which was previously a
+result of a SOW or a SOW subscribe filter result has either expired,
+been deleted from the SOW or has been updated such that it no longer
+matches the filter criteria.</td>
+</tr>
+<tr class="row-odd"><td>Replication</td>
+<td>The process of duplicating the messages stored into an AMPS instance to
+one or more additional AMPS instances.</td>
+</tr>
+<tr class="row-even"><td>Replication Destination</td>
+<td>An instance of AMPS that is receiving messages directly from another
+AMPS instance (the <em>replication source</em>).</td>
+</tr>
+<tr class="row-odd"><td>Replication Source</td>
+<td>An instance of AMPS which receives a published message from an
+application, and then sends the message directly to one or more other
+AMPS instances (the <em>replication destinations</em>).</td>
+</tr>
+<tr class="row-even"><td>Slow Client</td>
+<td>A client that is being sent messages at a rate which is faster than it
+can consume, to the point where AMPS detects that the network buffer to
+the client has filled.</td>
+</tr>
+<tr class="row-odd"><td>SOW (State of the World)</td>
+<td>The last value cache used to store the current state of messages
+belonging to a topic.</td>
+</tr>
+<tr class="row-even"><td>SOW Key</td>
+<td>A value used to identify a unique message in AMPS. For a given topic,
+you can configure AMPS to generate the SOW key based on content in the
+message, provide the SOW key on each message published or use a SOW key
+generator module to programmatically create the SOW key.</td>
+</tr>
+<tr class="row-odd"><td>Topic</td>
+<td>A label which is affixed to every message by a publisher which is used to
+aggregate and group messages.</td>
+</tr>
+<tr class="row-even"><td>Transport</td>
+<td>The protocols used to transfer messages between AMPS
+subscribers, publishers and replication destinations.</td>
+</tr>
+<tr class="row-odd"><td>Transaction Log</td>
+<td>A history of all messages published which can be used to recreate an up
+to date state of all messages processed. Applications can query and
+replay messages from the transaction log.</td>
+</tr>
+<tr class="row-even"><td>View</td>
+<td>A topic constructed by AMPS from the contents of one or more SOW topics.
+A view can aggregate or transform the underlying topics and can be of a
+different message format than the underlying topics.</td>
+</tr>
+</tbody>
+</table>
+</div>
+          </div>
+        </div>
+      </div>
+    <div class="clearer"></div>
+  </div>
+    <div class="footer">
+      &copy;2023 60East Technologies, Inc. (version develop).
+      |
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.5.3</a>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>
+    </div>
+  </body>
+</html>