Skip to content

Commit

Permalink
Update doc: Add detailed descriptions for new tables and fields (#133)
Browse files Browse the repository at this point in the history
  • Loading branch information
@feba-rajan
feba-rajan authored Oct 25, 2024
1 parent 288cd62 commit 532f39a
Showing 1 changed file with 65 additions and 61 deletions.
126 changes: 65 additions & 61 deletions docs/data-operations-manual/Reference/Performance-db-tables.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@ The [performance database](https://datasette.planning.data.gov.uk/performance/)
### Table columns
| Column name | Column type | Column description |
| :-------- | :--------- | :---------- |
| organisation | TEXT | |
| organisation_name | TEXT | |
| organisation | TEXT | Unique code that identifies organization |
| organisation_name | TEXT | Name of the Organisation |
| cohort | TEXT | |
| dataset | TEXT | |
| collection | TEXT | |
| pipeline | TEXT | |
| endpoint | TEXT | |
| endpoint_url | TEXT | |
| resource | TEXT | |
| resource_start_date | TEXT | |
| resource_end_date | TEXT | |
| dataset | TEXT | Name of Dataset, representing the type of data collected |
| collection | TEXT | Name of Collection, within which the dataset belongs |
| pipeline | TEXT | Name of Pipeline, process the dataset |
| endpoint | TEXT | Unique hash for accessing the data |
| endpoint_url | TEXT | URL linking to the dataset’s csv file or API endpoint |
| resource | TEXT | Unique hash for the resource |
| resource_start_date | TEXT | Start date of the resource |
| resource_end_date | TEXT | End date of the resource |
| latest_log_entry_date | TEXT | |
| mapping_field | TEXT | |
| non_mapping_field | TEXT | |
Expand All @@ -30,21 +30,23 @@ The [performance database](https://datasette.planning.data.gov.uk/performance/)
### Table columns
| Column name | Column type | Column description |
| :-------- | :--------- | :---------- |
| organisation | TEXT | |
| organisation | TEXT | Unique code that identifies organization |
| name | TEXT | |
| collection | TEXT | |
| pipeline | TEXT | |
| endpoint | TEXT | |
| endpoint_url | TEXT | |
| organisation_name | TEXT | Name of the Organisation |
| dataset | TEXT | Name of Dataset, representing the type of data collected |
| collection | TEXT | Name of Collection, within which the dataset belongs |
| pipeline | TEXT | Name of Pipeline, process the dataset |
| endpoint | TEXT | Unique hash for accessing the data |
| endpoint_url | TEXT | URL linking to the dataset’s csv file or API endpoint |
| licence | TEXT | |
| latest_status | TEXT | |
| latest_exception | TEXT | |
| resource | TEXT | |
| resource | TEXT | Unique hash for the resource |
| latest_log_entry_date | TEXT | |
| endpoint_entry_date | TEXT | |
| endpoint_end_date | TEXT | |
| resource_start_date | TEXT | |
| resource_end_date | TEXT | |
| endpoint_entry_date | TEXT | Entry date of the endpoint |
| endpoint_end_date | TEXT | End date of the endpoint |
| resource_start_date | TEXT | Start date of the resource |
| resource_end_date | TEXT | End date of the resource |



Expand All @@ -54,14 +56,14 @@ The [performance database](https://datasette.planning.data.gov.uk/performance/)
### Table columns
| Column name | Column type | Column description |
| :-------- | :--------- | :---------- |
| endpoint | TEXT | |
| endpoint_url | TEXT | |
| organisation | TEXT | |
| dataset | TEXT | |
| endpoint | TEXT | Unique hash for accessing the data |
| endpoint_url | TEXT | URL linking to the dataset’s csv file or API endpoint |
| organisation | TEXT | Unique code that identifies organization |
| dataset | TEXT | Name of Dataset, representing the type of data collected |
| latest_status | TEXT | |
| latest_exception | TEXT | |
| entry_date | TEXT | |
| end_date | TEXT | |
| entry_date | TEXT | Entry date of endpoint |
| end_date | TEXT | End date of endpoint |
| latest_resource_start_date | TEXT | |


Expand All @@ -72,17 +74,17 @@ The [performance database](https://datasette.planning.data.gov.uk/performance/)
### Table columns
| Column name | Column type | Column description |
| :-------- | :--------- | :---------- |
| organisation | TEXT | |
| organisation_name | TEXT | |
| dataset | TEXT | |
| active_endpoint_count | INTEGER | |
| error_endpoint_count | INTEGER | |
| count_issue_error_internal | INTEGER | |
| count_issue_error_external | INTEGER | |
| count_issue_warning_internal | INTEGER | |
| count_issue_warning_external | INTEGER | |
| count_issue_notice_internal | INTEGER | |
| count_issue_notice_external | INTEGER | |
| organisation | TEXT | Unique code that identifies organization |
| organisation_name | TEXT | Name of Organisation |
| dataset | TEXT | Name of Dataset, representing the type of data collected |
| active_endpoint_count | INTEGER | Count for the active endpoint |
| error_endpoint_count | INTEGER | Count of endpoints with errors |
| count_issue_error_internal | INTEGER | Count of internal issues |
| count_issue_error_external | INTEGER | Count of external issues |
| count_issue_warning_internal | INTEGER | Count of internal warnings |
| count_issue_warning_external | INTEGER | Count of external warnings |
| count_issue_notice_internal | INTEGER | Count of internal notice |
| count_issue_notice_external | INTEGER | Count of external notice |



Expand All @@ -92,22 +94,24 @@ The [performance database](https://datasette.planning.data.gov.uk/performance/)
### Table columns
| Column name | Column type | Column description |
| :-------- | :--------- | :---------- |
| organisation | TEXT | |
| organisation | TEXT | Unique code that identifies organization |
| name | TEXT | |
| collection | TEXT | |
| pipeline | TEXT | |
| endpoint | TEXT | |
| endpoint_url | TEXT | |
| organisation_name | TEXT | Name of Organisation |
| dataset | TEXT | Name of Dataset, representing the type of data collected |
| collection | TEXT | Name of Collection, within which the dataset belongs |
| pipeline | TEXT | Name of Pipeline, process the dataset |
| endpoint | TEXT | Unique hash for accessing the data |
| endpoint_url | TEXT | URL linking to the dataset’s csv file or API endpoint |
| licence | TEXT | |
| latest_status | TEXT | |
| days_since_200 | INTEGER | |
| latest_exception | TEXT | |
| resource | TEXT | |
| resource | TEXT | Unique hash for the resource |
| latest_log_entry_date | TEXT | |
| endpoint_entry_date | TEXT | |
| endpoint_end_date | TEXT | |
| resource_start_date | TEXT | |
| resource_end_date | TEXT | |
| endpoint_entry_date | TEXT | Entry date of endpoint |
| endpoint_end_date | TEXT | End date of endpoint |
| resource_start_date | TEXT | Start date of the resource |
| resource_end_date | TEXT | End date of the resource |
| rn | INTEGER | |


Expand All @@ -118,23 +122,23 @@ The [performance database](https://datasette.planning.data.gov.uk/performance/)
### Table columns
| Column name | Column type | Column description |
| :-------- | :--------- | :---------- |
| organisation | TEXT | |
| organisation_name | TEXT | |
| organisation | TEXT | Unique code that identifies organization |
| organisation_name | TEXT | Name of Organisation |
| cohort | TEXT | |
| dataset | TEXT | |
| collection | TEXT | |
| pipeline | TEXT | |
| endpoint | TEXT | |
| endpoint_url | TEXT | |
| resource | TEXT | |
| resource_start_date | TEXT | |
| resource_end_date | TEXT | |
| dataset | TEXT | Name of Dataset, representing the type of data collected |
| collection | TEXT | Name of Collection, within which the dataset belongs |
| pipeline | TEXT | Name of Pipeline, process the dataset |
| endpoint | TEXT | Unique hash for accessing the data |
| endpoint_url | TEXT | URL linking to the dataset’s csv file or API endpoint |
| resource | TEXT | Unique hash for the resource |
| resource_start_date | TEXT | Start date of the resource |
| resource_end_date | TEXT | End date of the resource |
| latest_log_entry_date | TEXT | |
| count_issues | INTEGER | |
| count_issues | INTEGER | The total number of issues recorded |
| date | TEXT | |
| issue_type | TEXT | |
| severity | TEXT | |
| responsibility | TEXT | |
| issue_type | TEXT | The type of issue noted |
| severity | TEXT | The level of importance of the issue |
| responsibility | TEXT | Who is accountable for addressing or resolving the issue |
| fields | TEXT | |


Expand Down

0 comments on commit 532f39a

Please sign in to comment.