-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathindex.html
More file actions
223 lines (203 loc) · 16.6 KB
/
index.html
File metadata and controls
223 lines (203 loc) · 16.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Feldera Python SDK Documentation — Feldera Python SDK 0.281.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=f33ff867"></script>
<script src="_static/doctools.js?v=9a2dae69"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Introduction" href="introduction.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home">
Feldera Python SDK
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="pandas.html">Pandas Compatibility</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">API Reference:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="modules.html">feldera</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">Feldera Python SDK</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Feldera Python SDK Documentation</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="feldera-python-sdk-documentation">
<h1>Feldera Python SDK Documentation<a class="headerlink" href="#feldera-python-sdk-documentation" title="Link to this heading"></a></h1>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="introduction.html">Introduction</a><ul>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="introduction.html#key-concepts">Key Concepts</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="pandas.html">Pandas Compatibility</a><ul>
<li class="toctree-l2"><a class="reference internal" href="pandas.html#using-pandas-dataframes-as-input-output">Using Pandas DataFrames as Input / Output</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples.html#connecting-to-feldera-sandbox">Connecting to Feldera Sandbox</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#connecting-to-feldera-on-localhost">Connecting to Feldera on localhost</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#tls-with-self-signed-certificates">TLS with Self Signed Certificates</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#setting-http-connection-timeouts">Setting HTTP Connection Timeouts</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#creating-a-pipeline-overwriting-existing-pipelines">Creating a Pipeline (OVERWRITING existing pipelines)</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#creating-a-pipeline-with-fault-tolerance-enabled">Creating a Pipeline with Fault Tolerance Enabled</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#runtime-configuration-of-a-pipeline">Runtime configuration of a Pipeline</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#starting-a-pipeline">Starting a Pipeline</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#analyzing-existing-feldera-pipeline-for-errors">Analyzing Existing Feldera Pipeline for Errors</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#using-pandas-dataframes">Using Pandas DataFrames</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#using-completion-tokens">Using Completion Tokens</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#executing-ad-hoc-sql-queries">Executing ad-hoc SQL Queries</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#iterating-over-output-chunks">Iterating over Output Chunks</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#waiting-for-completion">Waiting for Completion</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#end-to-end-example-with-kafka-sink">End-to-End Example with Kafka Sink</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#retrieve-a-support-bundle-for-a-pipeline">Retrieve a support-bundle for a pipeline</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#specifying-data-sources-sinks">Specifying Data Sources / Sinks</a></li>
</ul>
</li>
</ul>
</div>
<div class="toctree-wrapper compound">
<p class="caption" role="heading"><span class="caption-text">API Reference:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="modules.html">feldera</a><ul>
<li class="toctree-l2"><a class="reference internal" href="feldera.html">feldera package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="feldera.html#module-feldera.pipeline_builder">feldera.pipeline_builder module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.pipeline_builder.PipelineBuilder"><code class="docutils literal notranslate"><span class="pre">PipelineBuilder</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="feldera.html#module-feldera.pipeline">feldera.pipeline module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.pipeline.Pipeline"><code class="docutils literal notranslate"><span class="pre">Pipeline</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="feldera.html#module-feldera.enums">feldera.enums module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.enums.BootstrapPolicy"><code class="docutils literal notranslate"><span class="pre">BootstrapPolicy</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.enums.BuildMode"><code class="docutils literal notranslate"><span class="pre">BuildMode</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.enums.CheckpointStatus"><code class="docutils literal notranslate"><span class="pre">CheckpointStatus</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.enums.CompilationProfile"><code class="docutils literal notranslate"><span class="pre">CompilationProfile</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.enums.CompletionTokenStatus"><code class="docutils literal notranslate"><span class="pre">CompletionTokenStatus</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.enums.DeploymentDesiredStatus"><code class="docutils literal notranslate"><span class="pre">DeploymentDesiredStatus</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.enums.DeploymentResourcesDesiredStatus"><code class="docutils literal notranslate"><span class="pre">DeploymentResourcesDesiredStatus</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.enums.DeploymentResourcesStatus"><code class="docutils literal notranslate"><span class="pre">DeploymentResourcesStatus</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.enums.DeploymentRuntimeDesiredStatus"><code class="docutils literal notranslate"><span class="pre">DeploymentRuntimeDesiredStatus</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.enums.DeploymentRuntimeStatus"><code class="docutils literal notranslate"><span class="pre">DeploymentRuntimeStatus</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.enums.FaultToleranceModel"><code class="docutils literal notranslate"><span class="pre">FaultToleranceModel</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.enums.PipelineFieldSelector"><code class="docutils literal notranslate"><span class="pre">PipelineFieldSelector</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.enums.PipelineStatus"><code class="docutils literal notranslate"><span class="pre">PipelineStatus</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.enums.ProgramStatus"><code class="docutils literal notranslate"><span class="pre">ProgramStatus</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.enums.StorageStatus"><code class="docutils literal notranslate"><span class="pre">StorageStatus</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.enums.TransactionStatus"><code class="docutils literal notranslate"><span class="pre">TransactionStatus</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="feldera.html#module-feldera.output_handler">feldera.output_handler module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.output_handler.OutputHandler"><code class="docutils literal notranslate"><span class="pre">OutputHandler</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="feldera.html#module-feldera.runtime_config">feldera.runtime_config module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.runtime_config.Resources"><code class="docutils literal notranslate"><span class="pre">Resources</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.runtime_config.RuntimeConfig"><code class="docutils literal notranslate"><span class="pre">RuntimeConfig</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.runtime_config.Storage"><code class="docutils literal notranslate"><span class="pre">Storage</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="feldera.html#module-feldera.stats">feldera.stats module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.stats.CommitProgressSummary"><code class="docutils literal notranslate"><span class="pre">CommitProgressSummary</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.stats.CompletedWatermark"><code class="docutils literal notranslate"><span class="pre">CompletedWatermark</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.stats.ConnectorError"><code class="docutils literal notranslate"><span class="pre">ConnectorError</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.stats.ConnectorHealth"><code class="docutils literal notranslate"><span class="pre">ConnectorHealth</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.stats.ConnectorTransactionPhase"><code class="docutils literal notranslate"><span class="pre">ConnectorTransactionPhase</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.stats.GlobalPipelineMetrics"><code class="docutils literal notranslate"><span class="pre">GlobalPipelineMetrics</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.stats.InputEndpointMetrics"><code class="docutils literal notranslate"><span class="pre">InputEndpointMetrics</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.stats.InputEndpointStatus"><code class="docutils literal notranslate"><span class="pre">InputEndpointStatus</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.stats.OutputEndpointMetrics"><code class="docutils literal notranslate"><span class="pre">OutputEndpointMetrics</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.stats.OutputEndpointStatus"><code class="docutils literal notranslate"><span class="pre">OutputEndpointStatus</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.stats.PipelineStatistics"><code class="docutils literal notranslate"><span class="pre">PipelineStatistics</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="feldera.html#feldera.stats.TransactionInitiators"><code class="docutils literal notranslate"><span class="pre">TransactionInitiators</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="feldera.html#subpackages">Subpackages</a><ul>
<li class="toctree-l4"><a class="reference internal" href="feldera.rest.html">feldera.rest package</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</section>
<section id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Link to this heading"></a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
</ul>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="introduction.html" class="btn btn-neutral float-right" title="Introduction" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>© Copyright 2024, Feldera.</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>