-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathfeldera.html
More file actions
2495 lines (2225 loc) · 327 KB
/
feldera.html
File metadata and controls
2495 lines (2225 loc) · 327 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
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!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 package — Feldera Python SDK 0.286.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=7d6409a9"></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="feldera.rest package" href="feldera.rest.html" />
<link rel="prev" title="feldera" href="modules.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="index.html" 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 class="current">
<li class="toctree-l1 current"><a class="reference internal" href="modules.html">feldera</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">feldera package</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#module-feldera.pipeline_builder">feldera.pipeline_builder module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#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="#module-feldera.pipeline">feldera.pipeline module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#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="#module-feldera.enums">feldera.enums module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#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.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.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.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.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.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.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.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.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.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.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.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.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.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.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.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="#module-feldera.output_handler">feldera.output_handler module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#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="#module-feldera.runtime_config">feldera.runtime_config module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#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.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.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="#module-feldera.stats">feldera.stats module</a><ul>
<li class="toctree-l4"><a class="reference internal" href="#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.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.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.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.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.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.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.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.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.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.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.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="#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>
</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="index.html">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="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="modules.html">feldera</a></li>
<li class="breadcrumb-item active">feldera package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/feldera.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-package">
<h1>feldera package<a class="headerlink" href="#feldera-package" title="Link to this heading"></a></h1>
<section id="module-feldera.pipeline_builder">
<span id="feldera-pipeline-builder-module"></span><h2>feldera.pipeline_builder module<a class="headerlink" href="#module-feldera.pipeline_builder" title="Link to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="feldera.pipeline_builder.PipelineBuilder">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">feldera.pipeline_builder.</span></span><span class="sig-name descname"><span class="pre">PipelineBuilder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client:</span> <span class="pre">~feldera.rest.feldera_client.FelderaClient</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sql:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">udf_rust:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">udf_toml:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compilation_profile:</span> <span class="pre">~feldera.enums.CompilationProfile</span> <span class="pre">=</span> <span class="pre">CompilationProfile.OPTIMIZED</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">runtime_config:</span> <span class="pre">~feldera.runtime_config.RuntimeConfig</span> <span class="pre">=</span> <span class="pre"><feldera.runtime_config.RuntimeConfig</span> <span class="pre">object></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">runtime_version:</span> <span class="pre">str</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/feldera/pipeline_builder.html#PipelineBuilder"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline_builder.PipelineBuilder" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<p>A builder for creating a Feldera Pipeline.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>client</strong> – The <a class="reference internal" href="feldera.rest.html#feldera.rest.feldera_client.FelderaClient" title="feldera.rest.feldera_client.FelderaClient"><code class="xref py py-class docutils literal notranslate"><span class="pre">FelderaClient</span></code></a> instance</p></li>
<li><p><strong>name</strong> – The name of the pipeline</p></li>
<li><p><strong>description</strong> – The description of the pipeline</p></li>
<li><p><strong>sql</strong> – The SQL code of the pipeline</p></li>
<li><p><strong>udf_rust</strong> – Rust code for UDFs</p></li>
<li><p><strong>udf_toml</strong> – Rust dependencies required by UDFs (in the TOML format)</p></li>
<li><p><strong>compilation_profile</strong> – The <a class="reference internal" href="#feldera.enums.CompilationProfile" title="feldera.enums.CompilationProfile"><code class="xref py py-class docutils literal notranslate"><span class="pre">CompilationProfile</span></code></a> to use</p></li>
<li><p><strong>runtime_config</strong> – The <a class="reference internal" href="#feldera.runtime_config.RuntimeConfig" title="feldera.runtime_config.RuntimeConfig"><code class="xref py py-class docutils literal notranslate"><span class="pre">RuntimeConfig</span></code></a> to use. Enables
configuring the runtime behavior of the pipeline such as:
fault tolerance, storage and <a class="reference internal" href="#feldera.runtime_config.Resources" title="feldera.runtime_config.Resources"><code class="xref py py-class docutils literal notranslate"><span class="pre">Resources</span></code></a></p></li>
</ul>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline_builder.PipelineBuilder.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client:</span> <span class="pre">~feldera.rest.feldera_client.FelderaClient</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">name:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sql:</span> <span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">udf_rust:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">udf_toml:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description:</span> <span class="pre">str</span> <span class="pre">=</span> <span class="pre">''</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">compilation_profile:</span> <span class="pre">~feldera.enums.CompilationProfile</span> <span class="pre">=</span> <span class="pre">CompilationProfile.OPTIMIZED</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">runtime_config:</span> <span class="pre">~feldera.runtime_config.RuntimeConfig</span> <span class="pre">=</span> <span class="pre"><feldera.runtime_config.RuntimeConfig</span> <span class="pre">object></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">runtime_version:</span> <span class="pre">str</span> <span class="pre">|</span> <span class="pre">None</span> <span class="pre">=</span> <span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/feldera/pipeline_builder.html#PipelineBuilder.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline_builder.PipelineBuilder.__init__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline_builder.PipelineBuilder.create">
<span class="sig-name descname"><span class="pre">create</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">wait</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#feldera.pipeline.Pipeline" title="feldera.pipeline.Pipeline"><span class="pre">Pipeline</span></a></span></span><a class="reference internal" href="_modules/feldera/pipeline_builder.html#PipelineBuilder.create"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline_builder.PipelineBuilder.create" title="Link to this definition"></a></dt>
<dd><p>Create the pipeline if it does not exist.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>wait</strong> – Whether to wait for the pipeline to be created. True by default</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The created pipeline</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline_builder.PipelineBuilder.create_or_replace">
<span class="sig-name descname"><span class="pre">create_or_replace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">wait</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#feldera.pipeline.Pipeline" title="feldera.pipeline.Pipeline"><span class="pre">Pipeline</span></a></span></span><a class="reference internal" href="_modules/feldera/pipeline_builder.html#PipelineBuilder.create_or_replace"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline_builder.PipelineBuilder.create_or_replace" title="Link to this definition"></a></dt>
<dd><p>Creates a pipeline if it does not exist and replaces it if it exists.</p>
<p>If the pipeline exists and is running, it will be stopped and replaced.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>wait</strong> – Whether to wait for the pipeline to be created. True by default</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The created pipeline</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
<section id="module-feldera.pipeline">
<span id="feldera-pipeline-module"></span><h2>feldera.pipeline module<a class="headerlink" href="#module-feldera.pipeline" title="Link to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">feldera.pipeline.</span></span><span class="sig-name descname"><span class="pre">Pipeline</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="feldera.rest.html#feldera.rest.feldera_client.FelderaClient" title="feldera.rest.feldera_client.FelderaClient"><span class="pre">FelderaClient</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="feldera.rest.html#feldera.rest.feldera_client.FelderaClient" title="feldera.rest.feldera_client.FelderaClient"><span class="pre">FelderaClient</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.__init__" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.activate">
<span class="sig-name descname"><span class="pre">activate</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">wait</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout_s</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#feldera.enums.PipelineStatus" title="feldera.enums.PipelineStatus"><span class="pre">PipelineStatus</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.activate"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.activate" title="Link to this definition"></a></dt>
<dd><p>Activates the pipeline when starting from STANDBY mode. Only applicable
when the pipeline is starting from a checkpoint in object store.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>wait</strong> – Set True to wait for the pipeline to activate. True by
default</p></li>
<li><p><strong>timeout_s</strong> – The maximum time (in seconds) to wait for the
pipeline to pause.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.all">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">all</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="feldera.rest.html#feldera.rest.feldera_client.FelderaClient" title="feldera.rest.feldera_client.FelderaClient"><span class="pre">FelderaClient</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="#feldera.pipeline.Pipeline" title="feldera.pipeline.Pipeline"><span class="pre">Pipeline</span></a><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.all"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.all" title="Link to this definition"></a></dt>
<dd><p>Get all pipelines.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>client</strong> – The FelderaClient instance.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A list of Pipeline objects.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.approve">
<span class="sig-name descname"><span class="pre">approve</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.approve"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.approve" title="Link to this definition"></a></dt>
<dd><p>Approves the pipeline to proceed with bootstrapping.</p>
<p>This method is used when a pipeline has been started with
<cite>bootstrap_policy=BootstrapPolicy.AWAIT_APPROVAL</cite> and is currently in the
AWAITINGAPPROVAL state. The pipeline will wait for explicit user approval
before proceeding with the bootstrapping process.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.bootstrap_policy">
<span class="sig-name descname"><span class="pre">bootstrap_policy</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#feldera.enums.BootstrapPolicy" title="feldera.enums.BootstrapPolicy"><span class="pre">BootstrapPolicy</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.bootstrap_policy"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.bootstrap_policy" title="Link to this definition"></a></dt>
<dd><p>Return the bootstrap policy of the pipeline.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.checkpoint">
<span class="sig-name descname"><span class="pre">checkpoint</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">wait</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout_s</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.checkpoint"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.checkpoint" title="Link to this definition"></a></dt>
<dd><p>Checkpoints this pipeline.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>wait</strong> – If true, will block until the checkpoint completes.</p></li>
<li><p><strong>timeout_s</strong> – The maximum time (in seconds) to wait for the
checkpoint to complete (defaults to <cite>None</cite> = no timeout is enforced).</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The checkpoint sequence number.</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="feldera.rest.html#feldera.rest.errors.FelderaAPIError" title="feldera.rest.errors.FelderaAPIError"><strong>FelderaAPIError</strong></a> – If enterprise features are not enabled.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.checkpoint_status">
<span class="sig-name descname"><span class="pre">checkpoint_status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">seq</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#feldera.enums.CheckpointStatus" title="feldera.enums.CheckpointStatus"><span class="pre">CheckpointStatus</span></a></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.checkpoint_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.checkpoint_status" title="Link to this definition"></a></dt>
<dd><p>Checks the status of the given checkpoint.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>seq</strong> – The checkpoint sequence number.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.checkpoints">
<span class="sig-name descname"><span class="pre">checkpoints</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">CheckpointMetadata</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.checkpoints"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.checkpoints" title="Link to this definition"></a></dt>
<dd><p>Returns the list of checkpoints for this pipeline.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.clear_storage">
<span class="sig-name descname"><span class="pre">clear_storage</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">wait</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout_s</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">poll_interval_s</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">0.25</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.clear_storage"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.clear_storage" title="Link to this definition"></a></dt>
<dd><p>Clears the storage of the pipeline.
Once started, this action cannot be canceled, and will delete all the pipeline storage.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>wait</strong> – Set <cite>True</cite> to wait for the pipeline storage to become cleared,
or set <cite>False</cite> to immediately return. Default is <cite>True</cite>.</p></li>
<li><p><strong>timeout_s</strong> – Timeout waiting for storage to become cleared.
<cite>None</cite> = no timeout is enforced (default). Not used if <cite>wait=False</cite>.</p></li>
<li><p><strong>poll_interval_s</strong> – Polling interval at which to check while waiting
if storage is cleared (default is every 0.25 seconds). Not used if <cite>wait=False</cite>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.commit_transaction">
<span class="sig-name descname"><span class="pre">commit_transaction</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">transaction_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wait</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout_s</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.commit_transaction"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.commit_transaction" title="Link to this definition"></a></dt>
<dd><p>Commit the currently active transaction.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>transaction_id</strong> – If provided, the function verifies that the currently active transaction matches this ID.
If the active transaction ID does not match, the function raises an error.</p></li>
<li><p><strong>wait</strong> – If True, the function blocks until the transaction either commits successfully or the timeout is reached.
If False, the function initiates the commit and returns immediately without waiting for completion. The default value is True.</p></li>
<li><p><strong>timeout_s</strong> – Maximum time (in seconds) to wait for the transaction to commit when <cite>wait</cite> is True.
If None, the function will wait indefinitely.</p></li>
</ul>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>RuntimeError</strong> – If there is currently no transaction in progress.</p></li>
<li><p><strong>ValueError</strong> – If the provided <cite>transaction_id</cite> does not match the current transaction.</p></li>
<li><p><strong>TimeoutError</strong> – If the transaction does not commit within the specified timeout (when <cite>wait</cite> is True).</p></li>
<li><p><a class="reference internal" href="feldera.rest.html#feldera.rest.errors.FelderaAPIError" title="feldera.rest.errors.FelderaAPIError"><strong>FelderaAPIError</strong></a> – If the pipeline fails to commit a transaction.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.completion_token_status">
<span class="sig-name descname"><span class="pre">completion_token_status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#feldera.enums.CompletionTokenStatus" title="feldera.enums.CompletionTokenStatus"><span class="pre">CompletionTokenStatus</span></a></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.completion_token_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.completion_token_status" title="Link to this definition"></a></dt>
<dd><p>Returns the status of the completion token.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.created_at">
<span class="sig-name descname"><span class="pre">created_at</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">datetime</span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.created_at"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.created_at" title="Link to this definition"></a></dt>
<dd><p>Return the creation time of the pipeline.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.delete">
<span class="sig-name descname"><span class="pre">delete</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">clear_storage</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.delete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.delete" title="Link to this definition"></a></dt>
<dd><p>Deletes the pipeline.</p>
<p>The pipeline must be stopped, and the storage cleared before it can be
deleted.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>clear_storage</strong> – True if the storage should be cleared before
deletion. False by default</p>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="feldera.rest.html#feldera.rest.errors.FelderaAPIError" title="feldera.rest.errors.FelderaAPIError"><strong>FelderaAPIError</strong></a> – If the pipeline is not in STOPPED state or the
storage is still bound.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.deployment_config">
<span class="sig-name descname"><span class="pre">deployment_config</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Mapping</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.deployment_config"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.deployment_config" title="Link to this definition"></a></dt>
<dd><p>Return the deployment config of the pipeline.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.deployment_desired_status">
<span class="sig-name descname"><span class="pre">deployment_desired_status</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#feldera.enums.DeploymentDesiredStatus" title="feldera.enums.DeploymentDesiredStatus"><span class="pre">DeploymentDesiredStatus</span></a></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.deployment_desired_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.deployment_desired_status" title="Link to this definition"></a></dt>
<dd><p>Return the desired deployment status of the pipeline.
This is the next state that the pipeline should transition to.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.deployment_error">
<span class="sig-name descname"><span class="pre">deployment_error</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Mapping</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.deployment_error"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.deployment_error" title="Link to this definition"></a></dt>
<dd><p>Return the deployment error of the pipeline.
Returns an empty string if there is no error.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.deployment_location">
<span class="sig-name descname"><span class="pre">deployment_location</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.deployment_location"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.deployment_location" title="Link to this definition"></a></dt>
<dd><p>Return the deployment location of the pipeline.
Deployment location is the location where the pipeline can be reached
at runtime (a TCP port number or a URI).</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.deployment_resources_desired_status">
<span class="sig-name descname"><span class="pre">deployment_resources_desired_status</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#feldera.enums.DeploymentResourcesDesiredStatus" title="feldera.enums.DeploymentResourcesDesiredStatus"><span class="pre">DeploymentResourcesDesiredStatus</span></a></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.deployment_resources_desired_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.deployment_resources_desired_status" title="Link to this definition"></a></dt>
<dd><p>Return the desired status of the the deployment resources.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.deployment_resources_status">
<span class="sig-name descname"><span class="pre">deployment_resources_status</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#feldera.enums.DeploymentResourcesStatus" title="feldera.enums.DeploymentResourcesStatus"><span class="pre">DeploymentResourcesStatus</span></a></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.deployment_resources_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.deployment_resources_status" title="Link to this definition"></a></dt>
<dd><p>Return the status of the deployment resources.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.deployment_runtime_desired_status">
<span class="sig-name descname"><span class="pre">deployment_runtime_desired_status</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#feldera.enums.DeploymentRuntimeDesiredStatus" title="feldera.enums.DeploymentRuntimeDesiredStatus"><span class="pre">DeploymentRuntimeDesiredStatus</span></a></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.deployment_runtime_desired_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.deployment_runtime_desired_status" title="Link to this definition"></a></dt>
<dd><p>Return the deployment runtime desired status.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.deployment_runtime_status">
<span class="sig-name descname"><span class="pre">deployment_runtime_status</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#feldera.enums.DeploymentRuntimeStatus" title="feldera.enums.DeploymentRuntimeStatus"><span class="pre">DeploymentRuntimeStatus</span></a></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.deployment_runtime_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.deployment_runtime_status" title="Link to this definition"></a></dt>
<dd><p>Return the deployment runtime status.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.deployment_runtime_status_details">
<span class="sig-name descname"><span class="pre">deployment_runtime_status_details</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.deployment_runtime_status_details"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.deployment_runtime_status_details" title="Link to this definition"></a></dt>
<dd><p>Return the deployment runtime status details.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.deployment_status_since">
<span class="sig-name descname"><span class="pre">deployment_status_since</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">datetime</span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.deployment_status_since"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.deployment_status_since" title="Link to this definition"></a></dt>
<dd><p>Return the timestamp when the current deployment status of the pipeline
was set.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.description">
<span class="sig-name descname"><span class="pre">description</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.description"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.description" title="Link to this definition"></a></dt>
<dd><p>Return the description of the pipeline.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.dismiss_error">
<span class="sig-name descname"><span class="pre">dismiss_error</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.dismiss_error"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.dismiss_error" title="Link to this definition"></a></dt>
<dd><p>Dismisses the <cite>deployment_error</cite> of the pipeline.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.errors">
<span class="sig-name descname"><span class="pre">errors</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">Mapping</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.errors"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.errors" title="Link to this definition"></a></dt>
<dd><p>Returns a list of all errors in this pipeline.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.execute">
<span class="sig-name descname"><span class="pre">execute</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.execute"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.execute" title="Link to this definition"></a></dt>
<dd><p>Executes an ad-hoc SQL query on the current pipeline, discarding its
result. Unlike the <a class="reference internal" href="#feldera.pipeline.Pipeline.query" title="feldera.pipeline.Pipeline.query"><code class="xref py py-meth docutils literal notranslate"><span class="pre">query()</span></code></a> method which returns a generator for
retrieving query results lazily, this method processes the query
eagerly and fully before returning.</p>
<p>This method is suitable for SQL operations like <code class="docutils literal notranslate"><span class="pre">INSERT</span></code> and
<code class="docutils literal notranslate"><span class="pre">DELETE</span></code>, where the user needs confirmation of successful query
execution, but does not require the query result. If the query fails,
an exception will be raised.</p>
<dl class="simple">
<dt>Important:</dt><dd><p>If you try to <code class="docutils literal notranslate"><span class="pre">INSERT</span></code> or <code class="docutils literal notranslate"><span class="pre">DELETE</span></code> data from a table while the
pipeline is paused, it will block until the pipeline is resumed.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>query</strong> – The SQL query to be executed.</p>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><a class="reference internal" href="feldera.rest.html#feldera.rest.errors.FelderaAPIError" title="feldera.rest.errors.FelderaAPIError"><strong>FelderaAPIError</strong></a> – If the pipeline is not in a RUNNING state.</p></li>
<li><p><a class="reference internal" href="feldera.rest.html#feldera.rest.errors.FelderaAPIError" title="feldera.rest.errors.FelderaAPIError"><strong>FelderaAPIError</strong></a> – If the query is invalid.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.foreach_chunk">
<span class="sig-name descname"><span class="pre">foreach_chunk</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">view_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">callback</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="pre">DataFrame</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">int</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.foreach_chunk"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.foreach_chunk" title="Link to this definition"></a></dt>
<dd><p>Run the given callback on each chunk of the output of the specified view.</p>
<p>The callback will only receive changes from the point in time when the listener is created.
In order to receive all changes since the pipeline started, you can create the pipeline in the <cite>PAUSED</cite> state
using <a class="reference internal" href="#feldera.pipeline.Pipeline.start_paused" title="feldera.pipeline.Pipeline.start_paused"><code class="xref py py-meth docutils literal notranslate"><span class="pre">start_paused()</span></code></a>, attach listeners and unpause the pipeline using <a class="reference internal" href="#feldera.pipeline.Pipeline.resume" title="feldera.pipeline.Pipeline.resume"><code class="xref py py-meth docutils literal notranslate"><span class="pre">resume()</span></code></a>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>view_name</strong> – The name of the view.</p></li>
<li><p><strong>callback</strong> – <p>The callback to run on each chunk. The callback should take two arguments:</p>
<ul>
<li><p><strong>chunk</strong> -> The chunk as a pandas DataFrame</p></li>
<li><p><strong>seq_no</strong> -> The sequence number. The sequence number is a monotonically increasing integer that
starts from 0. Note that the sequence number is unique for each chunk, but not necessarily contiguous.</p></li>
</ul>
</p></li>
</ul>
</dd>
</dl>
<p>Please note that the callback is run in a separate thread, so it should be thread-safe.
Please note that the callback should not block for a long time, as by default, backpressure is enabled and
will block the pipeline.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<ul class="simple">
<li><p>The callback must be thread-safe as it will be run in a separate thread.</p></li>
</ul>
</div>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.generate_completion_token">
<span class="sig-name descname"><span class="pre">generate_completion_token</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">table_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">connector_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.generate_completion_token"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.generate_completion_token" title="Link to this definition"></a></dt>
<dd><p>Returns a completion token that can be passed to <a class="reference internal" href="#feldera.pipeline.Pipeline.completion_token_status" title="feldera.pipeline.Pipeline.completion_token_status"><code class="xref py py-meth docutils literal notranslate"><span class="pre">Pipeline.completion_token_status()</span></code></a> to
check whether the pipeline has finished processing all inputs received from the connector before
the token was generated.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.get">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="feldera.rest.html#feldera.rest.feldera_client.FelderaClient" title="feldera.rest.feldera_client.FelderaClient"><span class="pre">FelderaClient</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#feldera.pipeline.Pipeline" title="feldera.pipeline.Pipeline"><span class="pre">Pipeline</span></a></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.get"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.get" title="Link to this definition"></a></dt>
<dd><p>Get the pipeline if it exists.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>name</strong> – The name of the pipeline.</p></li>
<li><p><strong>client</strong> – The FelderaClient instance.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.get_samply_profile">
<span class="sig-name descname"><span class="pre">get_samply_profile</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">output_path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bytes</span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.get_samply_profile"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.get_samply_profile" title="Link to this definition"></a></dt>
<dd><p>Returns the gzip file of the samply profile as bytes.</p>
<p>The gzip file contains the samply profile that can be inspected by the samply tool.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>output_path</strong> – Optional path to save the samply profile file. If None,
the samply profile is only returned as bytes.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The samply profile as bytes (GZIP file)</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="feldera.rest.html#feldera.rest.errors.FelderaAPIError" title="feldera.rest.errors.FelderaAPIError"><strong>FelderaAPIError</strong></a> – If the pipeline does not exist or if there’s an error</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.id">
<span class="sig-name descname"><span class="pre">id</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.id"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.id" title="Link to this definition"></a></dt>
<dd><p>Return the ID of the pipeline.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.input_connector_stats">
<span class="sig-name descname"><span class="pre">input_connector_stats</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">table_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">connector_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#feldera.stats.InputEndpointStatus" title="feldera.stats.InputEndpointStatus"><span class="pre">InputEndpointStatus</span></a></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.input_connector_stats"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.input_connector_stats" title="Link to this definition"></a></dt>
<dd><p>Get the status of the specified input connector.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.input_json">
<span class="sig-name descname"><span class="pre">input_json</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">table_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">list</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">update_format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'raw'</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">wait</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.input_json"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.input_json" title="Link to this definition"></a></dt>
<dd><p>Push this JSON data to the specified table of the pipeline.</p>
<p>The pipeline must either be in RUNNING or PAUSED states to push data.
An error will be raised if the pipeline is in any other state.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>table_name</strong> – The name of the table to push data into.</p></li>
<li><p><strong>data</strong> – The JSON encoded data to be pushed to the pipeline. The data should be in the form:
<cite>{‘col1’: ‘val1’, ‘col2’: ‘val2’}</cite> or <cite>[{‘col1’: ‘val1’, ‘col2’: ‘val2’}, {‘col1’: ‘val1’, ‘col2’: ‘val2’}]</cite></p></li>
<li><p><strong>update_format</strong> – The update format of the JSON data to be pushed to the pipeline. Must be one of:
“raw”, “insert_delete”. <a class="reference external" href="https://docs.feldera.com/formats/json#the-insertdelete-format">https://docs.feldera.com/formats/json#the-insertdelete-format</a></p></li>
<li><p><strong>force</strong> – <cite>True</cite> to push data even if the pipeline is paused. <cite>False</cite> by default.</p></li>
<li><p><strong>wait</strong> – If True, blocks until this input has been processed by the pipeline</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The completion token to this input.</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>ValueError</strong> – If the update format is invalid.</p></li>
<li><p><a class="reference internal" href="feldera.rest.html#feldera.rest.errors.FelderaAPIError" title="feldera.rest.errors.FelderaAPIError"><strong>FelderaAPIError</strong></a> – If the pipeline is not in a valid state to push data.</p></li>
<li><p><strong>RuntimeError</strong> – If the pipeline is paused and <cite>force</cite> is not set to <cite>True</cite>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.input_pandas">
<span class="sig-name descname"><span class="pre">input_pandas</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">table_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">df</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFrame</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">force</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.input_pandas"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.input_pandas" title="Link to this definition"></a></dt>
<dd><p>Push all rows in a pandas DataFrame to the pipeline.</p>
<p>The pipeline must either be in RUNNING or PAUSED states to push data.
An error will be raised if the pipeline is in any other state.</p>
<p>The dataframe must have the same columns as the table in the pipeline.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>table_name</strong> – The name of the table to insert data into.</p></li>
<li><p><strong>df</strong> – The pandas DataFrame to be pushed to the pipeline.</p></li>
<li><p><strong>force</strong> – <cite>True</cite> to push data even if the pipeline is paused. <cite>False</cite> by default.</p></li>
</ul>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><strong>ValueError</strong> – If the table does not exist in the pipeline.</p></li>
<li><p><strong>RuntimeError</strong> – If the pipeline is not in a valid state to push data.</p></li>
<li><p><strong>RuntimeError</strong> – If the pipeline is paused and force is not set to <cite>True</cite>.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.is_complete">
<span class="sig-name descname"><span class="pre">is_complete</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.is_complete"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.is_complete" title="Link to this definition"></a></dt>
<dd><p>Check if the pipeline has completed processing all input records.</p>
<p>Returns True if (1) all input connectors attached to the
pipeline have finished reading their input data sources and issued
end-of-input notifications to the pipeline, and (2) all inputs received
from these connectors have been fully processed and corresponding
outputs have been sent out through the output connectors.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.last_successful_checkpoint_sync">
<span class="sig-name descname"><span class="pre">last_successful_checkpoint_sync</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">UUID</span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.last_successful_checkpoint_sync"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.last_successful_checkpoint_sync" title="Link to this definition"></a></dt>
<dd><p>Returns the UUID of the last successfully synced checkpoint.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>The UUID of the last successfully synced checkpoint.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.listen">
<span class="sig-name descname"><span class="pre">listen</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">view_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#feldera.output_handler.OutputHandler" title="feldera.output_handler.OutputHandler"><span class="pre">OutputHandler</span></a></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.listen"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.listen" title="Link to this definition"></a></dt>
<dd><p>Follow the change stream (i.e., the output) of the provided view.
Returns an output handle to read the changes.</p>
<p>When the pipeline is stopped, the handle is dropped.</p>
<p>The handle will only receive changes from the point in time when the listener is created.
In order to receive all changes since the pipeline started, you can create the pipeline in the <cite>PAUSED</cite> state
using <a class="reference internal" href="#feldera.pipeline.Pipeline.start_paused" title="feldera.pipeline.Pipeline.start_paused"><code class="xref py py-meth docutils literal notranslate"><span class="pre">start_paused()</span></code></a>, attach listeners and unpause the pipeline using <a class="reference internal" href="#feldera.pipeline.Pipeline.resume" title="feldera.pipeline.Pipeline.resume"><code class="xref py py-meth docutils literal notranslate"><span class="pre">resume()</span></code></a>.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>view_name</strong> – The name of the view to listen to.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.logs">
<span class="sig-name descname"><span class="pre">logs</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Generator</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.logs"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.logs" title="Link to this definition"></a></dt>
<dd><p>Gets the pipeline logs.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.modify">
<span class="sig-name descname"><span class="pre">modify</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">sql</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">udf_rust</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">udf_toml</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">program_config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Mapping</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">runtime_config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Mapping</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">description</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.modify"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.modify" title="Link to this definition"></a></dt>
<dd><p>Modify the pipeline.</p>
<p>Modify the values of pipeline attributes: SQL code, UDF Rust code,
UDF Rust dependencies (TOML), program config, runtime config, and
description. Only the provided attributes will be modified. Other
attributes will remain unchanged.</p>
<p>The pipeline must be in the STOPPED state to be modified.</p>
<dl class="field-list simple">
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="feldera.rest.html#feldera.rest.errors.FelderaAPIError" title="feldera.rest.errors.FelderaAPIError"><strong>FelderaAPIError</strong></a> – If the pipeline is not in a STOPPED state.</p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.name">
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">name</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#feldera.pipeline.Pipeline.name" title="Link to this definition"></a></dt>
<dd><p>Return the name of the pipeline.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.output_connector_stats">
<span class="sig-name descname"><span class="pre">output_connector_stats</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">view_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">connector_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#feldera.stats.OutputEndpointStatus" title="feldera.stats.OutputEndpointStatus"><span class="pre">OutputEndpointStatus</span></a></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.output_connector_stats"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.output_connector_stats" title="Link to this definition"></a></dt>
<dd><p>Get the status of the specified output connector.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.pause">
<span class="sig-name descname"><span class="pre">pause</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">wait</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout_s</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.pause"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.pause" title="Link to this definition"></a></dt>
<dd><p>Pause the pipeline.</p>
<p>The pipeline can only transition to the PAUSED state from the RUNNING
state. If the pipeline is already paused, it will remain in the PAUSED
state.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>wait</strong> – Set True to wait for the pipeline to pause. True by default</p></li>
<li><p><strong>timeout_s</strong> – The maximum time (in seconds) to wait for the
pipeline to pause.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.pause_connector">
<span class="sig-name descname"><span class="pre">pause_connector</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">table_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">connector_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.pause_connector"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.pause_connector" title="Link to this definition"></a></dt>
<dd><p>Pause the specified input connector.</p>
<p>Connectors allow feldera to fetch data from a source or write data to a sink.
This method allows users to <strong>PAUSE</strong> a specific <strong>INPUT</strong> connector.
All connectors are RUNNING by default.</p>
<dl class="simple">
<dt>Refer to the connector documentation for more information:</dt><dd><p><a class="reference external" href="https://docs.feldera.com/connectors/#input-connector-orchestration">https://docs.feldera.com/connectors/#input-connector-orchestration</a></p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>table_name</strong> – The name of the table that the connector is attached to.</p></li>
<li><p><strong>connector_name</strong> – The name of the connector to pause.</p></li>
</ul>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="feldera.rest.html#feldera.rest.errors.FelderaAPIError" title="feldera.rest.errors.FelderaAPIError"><strong>FelderaAPIError</strong></a> – If the connector is not found, or if the pipeline is not running.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.platform_version">
<span class="sig-name descname"><span class="pre">platform_version</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.platform_version"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.platform_version" title="Link to this definition"></a></dt>
<dd><p>Return the Feldera platform witch which the program was compiled.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.program_code">
<span class="sig-name descname"><span class="pre">program_code</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.program_code"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.program_code" title="Link to this definition"></a></dt>
<dd><p>Return the program SQL code of the pipeline.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.program_config">
<span class="sig-name descname"><span class="pre">program_config</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Mapping</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.program_config"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.program_config" title="Link to this definition"></a></dt>
<dd><p>Return the program config of the pipeline.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.program_error">
<span class="sig-name descname"><span class="pre">program_error</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Mapping</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.program_error"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.program_error" title="Link to this definition"></a></dt>
<dd><p>Return the program error of the pipeline.
If there are no errors, the <cite>exit_code</cite> field inside both
<cite>sql_compilation</cite> and <cite>rust_compilation</cite> will be 0.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.program_info">
<span class="sig-name descname"><span class="pre">program_info</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Mapping</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.program_info"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.program_info" title="Link to this definition"></a></dt>
<dd><p>Return the program info of the pipeline.
This is the output returned by the SQL compiler, including: the list of
input and output connectors, the generated Rust code for the pipeline,
and the SQL program schema.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.program_status">
<span class="sig-name descname"><span class="pre">program_status</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="#feldera.enums.ProgramStatus" title="feldera.enums.ProgramStatus"><span class="pre">ProgramStatus</span></a></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.program_status"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.program_status" title="Link to this definition"></a></dt>
<dd><p>Return the program status of the pipeline.</p>
<p>Program status is the status of compilation of this SQL program.
We first compile the SQL program to Rust code, and then compile the
Rust code to a binary.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.program_status_since">
<span class="sig-name descname"><span class="pre">program_status_since</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">datetime</span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.program_status_since"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.program_status_since" title="Link to this definition"></a></dt>
<dd><p>Return the timestamp when the current program status was set.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.program_version">
<span class="sig-name descname"><span class="pre">program_version</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">int</span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.program_version"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.program_version" title="Link to this definition"></a></dt>
<dd><p>Return the program version of the pipeline.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.query">
<span class="sig-name descname"><span class="pre">query</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Generator</span><span class="p"><span class="pre">[</span></span><span class="pre">Mapping</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.query"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.query" title="Link to this definition"></a></dt>
<dd><p>Executes an ad-hoc SQL query on this pipeline and returns a generator
that yields the rows of the result as Python dictionaries. For
<code class="docutils literal notranslate"><span class="pre">INSERT</span></code> and <code class="docutils literal notranslate"><span class="pre">DELETE</span></code> queries, consider using <a class="reference internal" href="#feldera.pipeline.Pipeline.execute" title="feldera.pipeline.Pipeline.execute"><code class="xref py py-meth docutils literal notranslate"><span class="pre">execute()</span></code></a>
instead. All floating-point numbers are deserialized as Decimal objects
to avoid precision loss.</p>
<dl class="simple">
<dt>Note:</dt><dd><p>You can only <code class="docutils literal notranslate"><span class="pre">SELECT</span></code> from materialized tables and views.</p>
</dd>
<dt>Important:</dt><dd><p>This method is lazy. It returns a generator and is not evaluated
until you consume the result.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>query</strong> – The SQL query to be executed.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A generator that yields the rows of the result as Python
dictionaries.</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><a class="reference internal" href="feldera.rest.html#feldera.rest.errors.FelderaAPIError" title="feldera.rest.errors.FelderaAPIError"><strong>FelderaAPIError</strong></a> – If the pipeline is not in a RUNNING or PAUSED
state.</p></li>
<li><p><a class="reference internal" href="feldera.rest.html#feldera.rest.errors.FelderaAPIError" title="feldera.rest.errors.FelderaAPIError"><strong>FelderaAPIError</strong></a> – If querying a non materialized table or view.</p></li>
<li><p><a class="reference internal" href="feldera.rest.html#feldera.rest.errors.FelderaAPIError" title="feldera.rest.errors.FelderaAPIError"><strong>FelderaAPIError</strong></a> – If the query is invalid.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.query_hash">
<span class="sig-name descname"><span class="pre">query_hash</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.query_hash"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.query_hash" title="Link to this definition"></a></dt>
<dd><p>Executes an ad-hoc SQL query on this pipeline and returns the result
as a hash of the result set. This is useful for quickly checking
if the result set has changed without retrieving the entire result.</p>
<dl class="simple">
<dt>Note:</dt><dd><p>For a stable hash, the query must be deterministic which means
it should be sorted.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>query</strong> – The SQL query to be executed.</p>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><a class="reference internal" href="feldera.rest.html#feldera.rest.errors.FelderaAPIError" title="feldera.rest.errors.FelderaAPIError"><strong>FelderaAPIError</strong></a> – If the pipeline is not in a RUNNING or PAUSED
state.</p></li>
<li><p><a class="reference internal" href="feldera.rest.html#feldera.rest.errors.FelderaAPIError" title="feldera.rest.errors.FelderaAPIError"><strong>FelderaAPIError</strong></a> – If querying a non materialized table or view.</p></li>
<li><p><a class="reference internal" href="feldera.rest.html#feldera.rest.errors.FelderaAPIError" title="feldera.rest.errors.FelderaAPIError"><strong>FelderaAPIError</strong></a> – If the query is invalid.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.query_parquet">
<span class="sig-name descname"><span class="pre">query_parquet</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">path</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.query_parquet"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.query_parquet" title="Link to this definition"></a></dt>
<dd><p>Executes an ad-hoc SQL query on this pipeline and saves the result to
the specified path as a parquet file. If the extension isn’t <cite>parquet</cite>,
it will be automatically appended to <cite>path</cite>.</p>
<dl class="simple">
<dt>Note:</dt><dd><p>You can only <code class="docutils literal notranslate"><span class="pre">SELECT</span></code> from materialized tables and views.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>query</strong> – The SQL query to be executed.</p></li>
<li><p><strong>path</strong> – The path of the parquet file.</p></li>
</ul>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><ul class="simple">
<li><p><a class="reference internal" href="feldera.rest.html#feldera.rest.errors.FelderaAPIError" title="feldera.rest.errors.FelderaAPIError"><strong>FelderaAPIError</strong></a> – If the pipeline is not in a RUNNING or PAUSED
state.</p></li>
<li><p><a class="reference internal" href="feldera.rest.html#feldera.rest.errors.FelderaAPIError" title="feldera.rest.errors.FelderaAPIError"><strong>FelderaAPIError</strong></a> – If querying a non materialized table or view.</p></li>
<li><p><a class="reference internal" href="feldera.rest.html#feldera.rest.errors.FelderaAPIError" title="feldera.rest.errors.FelderaAPIError"><strong>FelderaAPIError</strong></a> – If the query is invalid.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.query_tabular">
<span class="sig-name descname"><span class="pre">query_tabular</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">query</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Generator</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span></span></span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.query_tabular"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.query_tabular" title="Link to this definition"></a></dt>
<dd><p>Executes a SQL query on this pipeline and returns the result as a
formatted string.</p>
<dl class="simple">
<dt>Note:</dt><dd><p>You can only <code class="docutils literal notranslate"><span class="pre">SELECT</span></code> from materialized tables and views.</p>
</dd>
<dt>Important:</dt><dd><p>This method is lazy. It returns a generator and is not evaluated
until you consume the result.</p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>query</strong> – The SQL query to be executed.</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>A generator that yields a string representing the query result
in a human-readable, tabular format.</p>
</dd>
<dt class="field-odd">Raises<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><a class="reference internal" href="feldera.rest.html#feldera.rest.errors.FelderaAPIError" title="feldera.rest.errors.FelderaAPIError"><strong>FelderaAPIError</strong></a> – If the pipeline is not in a RUNNING or PAUSED
state.</p></li>
<li><p><a class="reference internal" href="feldera.rest.html#feldera.rest.errors.FelderaAPIError" title="feldera.rest.errors.FelderaAPIError"><strong>FelderaAPIError</strong></a> – If querying a non materialized table or view.</p></li>
<li><p><a class="reference internal" href="feldera.rest.html#feldera.rest.errors.FelderaAPIError" title="feldera.rest.errors.FelderaAPIError"><strong>FelderaAPIError</strong></a> – If the query is invalid.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.rebalance">
<span class="sig-name descname"><span class="pre">rebalance</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.rebalance"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.rebalance" title="Link to this definition"></a></dt>
<dd><p>Initiate rebalancing.</p>
<p>Initiate immediate rebalancing of the pipeline. Normally rebalancing is initiated automatically
when the drift in the size of joined relations exceeds a threshold. This method forces the balancer
to reevaluate and apply an optimal partitioning policy regardless of the threshold.</p>
<p>This operation is a no-op unless the <cite>adaptive_joins</cite> feature is enabled in <cite>dev_tweaks</cite>.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.refresh">
<span class="sig-name descname"><span class="pre">refresh</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">field_selector</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#feldera.enums.PipelineFieldSelector" title="feldera.enums.PipelineFieldSelector"><span class="pre">PipelineFieldSelector</span></a></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.refresh"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.refresh" title="Link to this definition"></a></dt>
<dd><p>Calls the backend to get the updated, latest version of the pipeline.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>field_selector</strong> – Choose what pipeline information to refresh; see PipelineFieldSelector enum definition.</p>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><p><strong>FelderaConnectionError</strong> – If there is an issue connecting to the backend.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.restart">
<span class="sig-name descname"><span class="pre">restart</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">bootstrap_policy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#feldera.enums.BootstrapPolicy" title="feldera.enums.BootstrapPolicy"><span class="pre">BootstrapPolicy</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout_s</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">dismiss_error</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.restart"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.restart" title="Link to this definition"></a></dt>
<dd><p>Restarts the pipeline.</p>
<p>This method forcibly <strong>STOPS</strong> the pipeline regardless of its current
state and then starts it again. No checkpoints are made when stopping
the pipeline.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>bootstrap_policy</strong> – The bootstrap policy to use.</p></li>
<li><p><strong>timeout_s</strong> – The maximum time (in seconds) to wait for the
pipeline to restart.</p></li>
<li><p><strong>dismiss_error</strong> – Set True to dismiss any deployment error before starting;
set False to make it fail in that case. True by default.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.resume">
<span class="sig-name descname"><span class="pre">resume</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">wait</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout_s</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.resume"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.resume" title="Link to this definition"></a></dt>
<dd><p>Resumes the pipeline from the PAUSED state. If the pipeline is already
running, it will remain in the RUNNING state.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>wait</strong> – Set True to wait for the pipeline to resume. True by default</p></li>
<li><p><strong>timeout_s</strong> – The maximum time (in seconds) to wait for the
pipeline to resume.</p></li>
</ul>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="feldera.pipeline.Pipeline.resume_connector">
<span class="sig-name descname"><span class="pre">resume_connector</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">table_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">connector_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/feldera/pipeline.html#Pipeline.resume_connector"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#feldera.pipeline.Pipeline.resume_connector" title="Link to this definition"></a></dt>
<dd><p>Resume the specified connector.</p>
<p>Connectors allow feldera to fetch data from a source or write data to a sink.
This method allows users to <strong>RESUME / START</strong> a specific <strong>INPUT</strong> connector.
All connectors are RUNNING by default.</p>
<dl class="simple">
<dt>Refer to the connector documentation for more information:</dt><dd><p><a class="reference external" href="https://docs.feldera.com/connectors/#input-connector-orchestration">https://docs.feldera.com/connectors/#input-connector-orchestration</a></p>
</dd>
</dl>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>table_name</strong> – The name of the table that the connector is attached to.</p></li>
<li><p><strong>connector_name</strong> – The name of the connector to resume.</p></li>
</ul>
</dd>
<dt class="field-even">Raises<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="feldera.rest.html#feldera.rest.errors.FelderaAPIError" title="feldera.rest.errors.FelderaAPIError"><strong>FelderaAPIError</strong></a> – If the connector is not found, or if the pipeline is not running.</p>
</dd>
</dl>