docs.feldera.com/python/_modules/feldera/rest/pipeline.html at main · feldera/docs.feldera.com

History

212 lines (180 loc) · 21.4 KB

Raw

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

<!DOCTYPE html>

<head>

<title>feldera.rest.pipeline — Feldera Python SDK 0.281.0 documentation</title>

<!--[if lt IE 9]>

<![endif]-->

</head>

Feldera Python SDK

</a>

</form>

</div>

</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">

Contents:

<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>

API Reference:

<ul>

<li class="toctree-l1"><a class="reference internal" href="../../../modules.html">feldera</a></li>

</ul>

</div>

</nav>

<a href="../../../index.html">Feldera Python SDK</a>

</nav>

<li class="breadcrumb-item"><a href="../../index.html">Module code</a></li>

<li class="breadcrumb-item active">feldera.rest.pipeline</li>

</li>

</ul>

<hr/>

</div>

<h1>Source code for feldera.rest.pipeline</h1><div class="highlight"><pre>

from typing import Mapping, Any, Optional

from feldera.rest.sql_table import SQLTable

from feldera.rest.sql_view import SQLView

class Pipeline:

"""

Represents a Feldera pipeline

"""

def __init__(

self,

name: str,

sql: str,

udf_rust: str,

udf_toml: str,

program_config: Mapping[str, Any],

runtime_config: Mapping[str, Any],

description: Optional[str] = None,

):

"""

Initializes a new pipeline

:param name: The name of the pipeline

:param sql: The SQL code of the pipeline

:param udf_rust: Rust code for UDFs

:param udf_toml: Rust dependencies required by UDFs (in the TOML format)

:param program_config: The program config of the pipeline

:param runtime_config: The configuration of the pipeline

:param description: Optional. The description of the pipeline

"""

self.name: str = name

self.program_code: str = sql.strip()

self.udf_rust: str = udf_rust

self.udf_toml: str = udf_toml

self.description: Optional[str] = description

self.program_config: Mapping[str, Any] = program_config

self.runtime_config: Mapping[str, Any] = runtime_config

self.id: Optional[str] = None

self.tables: list[SQLTable] = []

self.views: list[SQLView] = []

self.deployment_status: Optional[str] = None

self.deployment_status_since: Optional[str] = None

self.created_at: Optional[str] = None

self.version: Optional[int] = None

self.program_version: Optional[int] = None

self.deployment_config: Optional[dict] = None

self.deployment_desired_status: Optional[str] = None

self.deployment_desired_status_since: Optional[str] = None

self.deployment_id: Optional[str] = None

self.deployment_initial: Optional[str] = None

self.bootstrap_policy: Optional[str] = None

self.deployment_error: Optional[dict] = None

self.deployment_location: Optional[str] = None

self.program_info: Optional[dict] = (

None # info about input & output connectors and the schema

)

self.program_status: Optional[str] = None

self.program_status_since: Optional[str] = None

self.platform_version: Optional[str] = None

self.program_error: Optional[dict] = None

self.storage_status: Optional[str] = None

self.deployment_resources_desired_status: Optional[str] = None

self.deployment_resources_desired_status_since: Optional[str] = None

self.deployment_resources_status: Optional[str] = None

self.deployment_resources_status_since: Optional[str] = None

self.deployment_runtime_desired_status: Optional[str] = None

self.deployment_runtime_desired_status_since: Optional[str] = None

self.deployment_runtime_status: Optional[str] = None

self.deployment_runtime_status_details: Optional[dict] = None

self.deployment_runtime_status_since: Optional[str] = None</div>

@classmethod

def from_dict(cls, d: Mapping[str, Any]):

pipeline = cls("", "", "", "", {}, {})

pipeline.__dict__ = d

pipeline.tables = []

pipeline.views = []

info = d.get("program_info")

if info is not None:

for i in info["schema"]["inputs"]:

tbl = SQLTable.from_dict(i)

pipeline.tables.append(tbl)

for output in info["schema"]["outputs"]:

v = SQLView.from_dict(output)

pipeline.views.append(v)

return pipeline</div>

</div>

</pre></div>

</div>

<hr/>

</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>

provided by <a href="https://readthedocs.org">Read the Docs</a>.

</footer>

</div>

</section>

</div>

jQuery(function () {

SphinxRtdTheme.Navigation.enable(true);

});

</script>

</body>

</html>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FilesExpand file tree

pipeline.html

Latest commit

History

pipeline.html

File metadata and controls