Skip to content

Commit e4f920a

Browse files
kesmit13kesmit13
committed
Add scheduled jobs to doc
1 parent 3a83154 commit e4f920a

File tree

151 files changed

+5811
-24
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

151 files changed

+5811
-24
lines changed

‎docs/_sources/api.rst.txt‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,72 @@ Region objects are accessed from the :attr:`WorkspaceManager.regions` attribute.
229229
.. autosummary::
230230
:toctree: generated/
231231
Region
232+
Organization
233+
............
234+
Organization objects are retrieved from :attr:`WorkspaceManager.organization`.
235+
They provide access to organization-level resources and operations.
236+
.. currentmodule:: singlestoredb.management.organization
237+
.. autosummary::
238+
:toctree: generated/
239+
Organization
240+
Organization.get_secret
241+
Organization.jobs
242+
Organization.inference_apis
243+
Secret
244+
......
245+
Secret objects are retrieved from :meth:`Organization.get_secret`.
246+
They represent organization-wide secrets that can be used in various operations.
247+
.. autosummary::
248+
:toctree: generated/
249+
Secret
250+
Jobs Management
251+
...............
252+
The jobs management functionality allows you to schedule and manage notebook executions.
253+
JobsManager
254+
^^^^^^^^^^^
255+
JobsManager objects are accessed through :attr:`Organization.jobs` and provide
256+
methods for creating, monitoring, and managing scheduled notebook jobs.
257+
.. currentmodule:: singlestoredb.management.job
258+
.. autosummary::
259+
:toctree: generated/
260+
JobsManager
261+
JobsManager.schedule
262+
JobsManager.run
263+
JobsManager.wait
264+
JobsManager.get
265+
JobsManager.get_executions
266+
JobsManager.get_parameters
267+
JobsManager.delete
268+
JobsManager.modes
269+
JobsManager.runtimes
270+
Job
271+
^^^
272+
Job objects represent scheduled notebook executions and are returned by
273+
:meth:`JobsManager.schedule`, :meth:`JobsManager.run`, and :meth:`JobsManager.get`.
274+
.. autosummary::
275+
:toctree: generated/
276+
Job
277+
Job.wait
278+
Job.get_executions
279+
Job.get_parameters
280+
Job.delete
281+
Supporting Classes
282+
^^^^^^^^^^^^^^^^^^
283+
The following classes are used as parameters and return values in the jobs API.
284+
.. autosummary::
285+
:toctree: generated/
286+
Mode
287+
TargetType
288+
Status
289+
Parameter
290+
Runtime
291+
JobMetadata
292+
ExecutionMetadata
293+
Execution
294+
ExecutionsData
295+
ExecutionConfig
296+
Schedule
297+
TargetConfig
232298
Stage Files
233299
...........
234300
To interact with files in your Stage, use the

‎docs/_sources/generated/singlestoredb.management.job.Execution.rst.txt‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
singlestoredb.management.job.Execution
2+
======================================
3+
.. currentmodule:: singlestoredb.management.job
4+
.. autoclass:: Execution
5+
.. automethod:: __init__
6+
.. rubric:: Methods
7+
.. autosummary::
8+
~Execution.__init__
9+
~Execution.from_dict
10+
.. rubric:: Attributes
11+
.. autosummary::
12+
~Execution.execution_id
13+
~Execution.job_id
14+
~Execution.status
15+
~Execution.snapshot_notebook_path
16+
~Execution.scheduled_start_time
17+
~Execution.started_at
18+
~Execution.finished_at
19+
~Execution.execution_number

‎docs/_sources/generated/singlestoredb.management.job.ExecutionConfig.rst.txt‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
singlestoredb.management.job.ExecutionConfig
2+
============================================
3+
.. currentmodule:: singlestoredb.management.job
4+
.. autoclass:: ExecutionConfig
5+
.. automethod:: __init__
6+
.. rubric:: Methods
7+
.. autosummary::
8+
~ExecutionConfig.__init__
9+
~ExecutionConfig.from_dict
10+
.. rubric:: Attributes
11+
.. autosummary::
12+
~ExecutionConfig.create_snapshot
13+
~ExecutionConfig.max_duration_in_mins
14+
~ExecutionConfig.notebook_path

‎docs/_sources/generated/singlestoredb.management.job.ExecutionMetadata.rst.txt‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
singlestoredb.management.job.ExecutionMetadata
2+
==============================================
3+
.. currentmodule:: singlestoredb.management.job
4+
.. autoclass:: ExecutionMetadata
5+
.. automethod:: __init__
6+
.. rubric:: Methods
7+
.. autosummary::
8+
~ExecutionMetadata.__init__
9+
~ExecutionMetadata.from_dict
10+
.. rubric:: Attributes
11+
.. autosummary::
12+
~ExecutionMetadata.start_execution_number
13+
~ExecutionMetadata.end_execution_number

‎docs/_sources/generated/singlestoredb.management.job.ExecutionsData.rst.txt‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
singlestoredb.management.job.ExecutionsData
2+
===========================================
3+
.. currentmodule:: singlestoredb.management.job
4+
.. autoclass:: ExecutionsData
5+
.. automethod:: __init__
6+
.. rubric:: Methods
7+
.. autosummary::
8+
~ExecutionsData.__init__
9+
~ExecutionsData.from_dict
10+
.. rubric:: Attributes
11+
.. autosummary::
12+
~ExecutionsData.executions
13+
~ExecutionsData.metadata

‎docs/_sources/generated/singlestoredb.management.job.Job.delete.rst.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
singlestoredb.management.job.Job.delete
2+
=======================================
3+
.. currentmodule:: singlestoredb.management.job
4+
.. automethod:: Job.delete

‎docs/_sources/generated/singlestoredb.management.job.Job.get_executions.rst.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
singlestoredb.management.job.Job.get\_executions
2+
================================================
3+
.. currentmodule:: singlestoredb.management.job
4+
.. automethod:: Job.get_executions

‎docs/_sources/generated/singlestoredb.management.job.Job.get_parameters.rst.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
singlestoredb.management.job.Job.get\_parameters
2+
================================================
3+
.. currentmodule:: singlestoredb.management.job
4+
.. automethod:: Job.get_parameters

‎docs/_sources/generated/singlestoredb.management.job.Job.rst.txt‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
singlestoredb.management.job.Job
2+
================================
3+
.. currentmodule:: singlestoredb.management.job
4+
.. autoclass:: Job
5+
.. automethod:: __init__
6+
.. rubric:: Methods
7+
.. autosummary::
8+
~Job.__init__
9+
~Job.delete
10+
~Job.from_dict
11+
~Job.get_executions
12+
~Job.get_parameters
13+
~Job.wait
14+
.. rubric:: Attributes
15+
.. autosummary::
16+
~Job.completed_executions_count
17+
~Job.created_at
18+
~Job.description
19+
~Job.enqueued_by
20+
~Job.execution_config
21+
~Job.job_id
22+
~Job.job_metadata
23+
~Job.name
24+
~Job.schedule
25+
~Job.target_config
26+
~Job.terminated_at

‎docs/_sources/generated/singlestoredb.management.job.Job.wait.rst.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
singlestoredb.management.job.Job.wait
2+
=====================================
3+
.. currentmodule:: singlestoredb.management.job
4+
.. automethod:: Job.wait

0 commit comments

Comments
 (0)