Skip to content

Commit 0b51617

Browse files
author
Alex Meadows
committed
Updated for v0.9.0
Updated documentation with all the changes that were made for v0.9.0 of the Python implementation.
1 parent e5b0c7a commit 0b51617

4 files changed

Lines changed: 29 additions & 6 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,3 +164,4 @@ venv.bak/
164164
.idea/modules.xml
165165
.idea/process_tracker.iml
166166
.idea/vcs.xml
167+
/.idea/inspectionProfiles/

docs/source/model/extract.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ This table tracks the valid types of files and their formats that available.
9999
- Integer
100100
- Auto incrementing unique sequence
101101
* - extract_filetype_code
102-
- String(5)
102+
- String(25)
103103
- The file extension used by the filetype (i.e. csv)
104104
* - extract_filetype
105105
- String(75)

docs/source/model/overview.rst

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,26 @@ Support is also enabled for Oracle, MS-SQL, and Snowflake, but has not been full
77
should Just Work (tm) until they can be tested thru the build stack and not just locally their status must remain
88
'available but untested'.
99

10-
Each subsection of the Model section covers a specific topic of the data store.
10+
Each subsection of the Model section covers a specific topic of the data store.
11+
12+
New with version 0.9.0, all tables are now equipped with stock audit fields:
13+
14+
.. list-table:: stock audit fields
15+
:widths: 25 25 50
16+
:header-rows: 1
17+
18+
* - Column Name
19+
- Column Type
20+
- Column Description
21+
* - created_date_time
22+
- timestamp (with timezone, if available)
23+
- The date/time that the record was created.
24+
* - created_by
25+
- integer
26+
- The id of the actor who created the record. Implied foreign key to the :ref:`actor_lkup` table.
27+
* - update_date_time
28+
- timestamp (with timezone, if available)
29+
- The date/time that the record was last updated.
30+
* - updated_by
31+
- integer
32+
- The id of the actor who updated the record. Implied foreign key to the :ref:`actor_lkup` table.

docs/source/python/process_tracker.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Those variables will be used to populate the data store backend as explained in
4343
- :ref:`process_tracking`
4444
- Yes
4545
* - process_type
46-
- The type of process being run.
46+
- The type of process being run. Optional if process already exists.
4747
- :ref:`process_type_lkup`
4848
- Yes
4949
* - actor_name
@@ -93,7 +93,7 @@ Those variables will be used to populate the data store backend as explained in
9393
- The general frequency at which the process should run.
9494
- :ref:`schedule_frequency_lkup`
9595
- No
96-
* - process_run_id
96+
* - process_tracking_id
9797
- When recreating a Process Tracking instance, provide the process_tracking_id and it will re-instantiate as it was
9898
originally created, with the current status, objects, etc.
9999
- :ref:`process_tracking`, plus all other objects created on instantiation of ProcessTracker
@@ -107,7 +107,7 @@ Re-initializing An Instance
107107
To set up a previous instance, pass the process tracking id to ProcessTracker. Instead of creating a new instance of
108108
the given process, it will retrieve the specific tracking record and all of it's ancillary data.::
109109

110-
restored_process_run = ProcessTracker(process_run_id=123)
110+
restored_process_run = ProcessTracker(process_tracking_id=123)
111111

112112
This should ideally only be used when a process is still running - like when switching between services within your
113113
cloud provider.
@@ -518,7 +518,7 @@ Processes can have an optional schedule frequency. To find all processes of a g
518518

519519
process_run.find_process_by_schedule_frequency(frequency="hourly")
520520

521-
This will return a list of process ids with the given frequency.
521+
This will return a list of process objects with the given frequency.
522522

523523
Finding Process Filters
524524
***********************

0 commit comments

Comments
 (0)