docs.feldera.com/python/_modules/feldera/pipeline_builder.html at main · feldera/docs.feldera.com

History

254 lines (212 loc) · 21.9 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

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

<!DOCTYPE html>

<head>

<title>feldera.pipeline_builder — Feldera Python SDK 0.276.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.pipeline_builder</li>

</li>

</ul>

<hr/>

</div>

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

import os

from typing import Optional

from feldera.enums import CompilationProfile, PipelineFieldSelector

from feldera.pipeline import Pipeline

from feldera.rest.errors import FelderaAPIError

from feldera.rest.feldera_client import FelderaClient

from feldera.rest.pipeline import Pipeline as InnerPipeline

from feldera.runtime_config import RuntimeConfig

class PipelineBuilder:

"""

A builder for creating a Feldera Pipeline.

:param client: The :class:`.FelderaClient` instance

:param name: The name of the pipeline

:param description: The description 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 compilation_profile: The :class:`.CompilationProfile` to use

:param runtime_config: The :class:`.RuntimeConfig` to use. Enables

configuring the runtime behavior of the pipeline such as:

fault tolerance, storage and :class:`.Resources`

"""

def __init__(

self,

client: FelderaClient,

name: str,

sql: str,

udf_rust: str = "",

udf_toml: str = "",

description: str = "",

compilation_profile: CompilationProfile = CompilationProfile.OPTIMIZED,

runtime_config: RuntimeConfig = RuntimeConfig.default(),

runtime_version: Optional[str] = None,

):

self.client: FelderaClient = client

self.name: str | None = name

self.description: str = description

self.sql: str = sql

self.udf_rust: str = udf_rust

self.udf_toml: str = udf_toml

self.compilation_profile: CompilationProfile = compilation_profile

self.runtime_config: RuntimeConfig = runtime_config

self.runtime_version: Optional[str] = os.environ.get(

"FELDERA_RUNTIME_VERSION", runtime_version

)</div>

def create(self, wait: bool = True) -> Pipeline:

"""

Create the pipeline if it does not exist.

:param wait: Whether to wait for the pipeline to be created. True by default

:return: The created pipeline

"""

if self.name is None or self.sql is None:

raise ValueError("Name and SQL are required to create a pipeline")

try:

if (

self.client.get_pipeline(self.name, PipelineFieldSelector.STATUS)

is not None

):

raise RuntimeError(f"Pipeline with name {self.name} already exists")

except FelderaAPIError as err:

if err.error_code != "UnknownPipelineName":

raise err

inner = InnerPipeline(

self.name,

description=self.description,

sql=self.sql,

udf_rust=self.udf_rust,

udf_toml=self.udf_toml,

program_config={

"profile": self.compilation_profile.value,

"runtime_version": self.runtime_version,

},

runtime_config=self.runtime_config.to_dict(),

)

inner = self.client.create_pipeline(inner, wait=wait)

pipeline = Pipeline(self.client)

pipeline._inner = inner

return pipeline</div>

def create_or_replace(self, wait: bool = True) -> Pipeline:

"""

Creates a pipeline if it does not exist and replaces it if it exists.

If the pipeline exists and is running, it will be stopped and replaced.

:param wait: Whether to wait for the pipeline to be created. True by default

:return: The created pipeline

"""

raise ValueError("Name and SQL are required to create a pipeline")

try:

# shutdown the pipeline if it exists and is running

p = Pipeline.get(self.name, self.client)

p.stop(force=True)

p.clear_storage()

p.dismiss_error()

except FelderaAPIError:

# pipeline doesn't exist, no worries

pass

inner = InnerPipeline(

self.name,

description=self.description,

sql=self.sql,

udf_rust=self.udf_rust,

udf_toml=self.udf_toml,

program_config={

"runtime_version": self.runtime_version,

},

)

inner = self.client.create_or_update_pipeline(inner, wait=wait)

pipeline._inner = inner

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_builder.html

Latest commit

History

pipeline_builder.html

File metadata and controls