Add Performance DB Table Construction Documentation #139
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 tasks
ssadhu-sl
previously requested changes
Nov 1, 2024
|
|
||
| ### 1. Table: [endpoint_dataset_issue_type_summary](https://datasette.planning.data.gov.uk/performance/endpoint_dataset_issue_type_summary) | ||
|
|
||
| **Purpose**: To summarize issues associated with each dataset and endpoint. |
There was a problem hiding this comment.
Maybe include something about the organisation. And say dataset and its associated endpoints
|
|
||
| ### 2. Table: [endpoint_dataset_resource_summary](https://datasette.planning.data.gov.uk/performance/endpoint_dataset_resource_summary) | ||
|
|
||
| **Purpose**: To summarize resources associated with endpoints, including mapping and non-mapping fields. |
There was a problem hiding this comment.
Explain mapping and non-mapping fields
| **Purpose**: To summarize resources associated with endpoints, including mapping and non-mapping fields. | ||
|
|
||
| **Base Tables**: | ||
| - `provision`: Contains information about organizations, cohorts, and datasets sourced from the [digital_land](https://datasette.planning.data.gov.uk/digital-land). |
There was a problem hiding this comment.
provision table -detail about datasets provisioned for a particular Organisation.
|
|
||
| **Base Tables**: | ||
| - `endpoint`: Contains information about endpoints sourced from the [digital_land](https://datasette.planning.data.gov.uk/digital-land). | ||
| - `source`: Provides a link between endpoints and organizations sourced from the [digital_land](https://datasette.planning.data.gov.uk/digital-land). |
There was a problem hiding this comment.
Not sure if source means this, can you confirm from someone in DM?
| **Base Tables**: | ||
| - `endpoint`: Contains information about endpoints sourced from the [digital_land](https://datasette.planning.data.gov.uk/digital-land). | ||
| - `source`: Provides a link between endpoints and organizations sourced from the [digital_land](https://datasette.planning.data.gov.uk/digital-land). | ||
| - `log`: Contains logs related to endpoint performance sourced from the [digital_land](https://datasette.planning.data.gov.uk/digital-land). |
|
|
||
| ### 4. Table: [provision_summary](https://datasette.planning.data.gov.uk/performance/provision_summary) | ||
|
|
||
| **Purpose**: To summarize provision metrics across organizations and datasets, counting various types of issues and endpoints. |
There was a problem hiding this comment.
explain what provision metrics means and type of issues might be confusing (user might think it like invalid org etc etc)
| **Purpose**: To summarize provision metrics across organizations and datasets, counting various types of issues and endpoints. | ||
|
|
||
| **Base Tables**: | ||
| - `provision`: Contains information about datasets sourced from the [digital_land](https://datasette.planning.data.gov.uk/digital-land). |
| - `issue_type`: Defines types of issues sourced from the [digital_land](https://datasette.planning.data.gov.uk/digital-land). | ||
| - `column_field`: This is a mapping table that connects specific columns from an endpoint to their corresponding fields sourced according to the dataset's specification e.g UID -> reference, sourced from the [digital_land](https://datasette.planning.data.gov.uk/digital-land). | ||
| - `endpoint`: Contains information about endpoints sourced from the [digital_land](https://datasette.planning.data.gov.uk/digital-land). | ||
| - `source`: Provides a link between endpoints and organizations sourced from the [digital_land](https://datasette.planning.data.gov.uk/digital-land). |
| - `column_field`: This is a mapping table that connects specific columns from an endpoint to their corresponding fields sourced according to the dataset's specification e.g UID -> reference, sourced from the [digital_land](https://datasette.planning.data.gov.uk/digital-land). | ||
| - `endpoint`: Contains information about endpoints sourced from the [digital_land](https://datasette.planning.data.gov.uk/digital-land). | ||
| - `source`: Provides a link between endpoints and organizations sourced from the [digital_land](https://datasette.planning.data.gov.uk/digital-land). | ||
| - `log`: Contains logs related to endpoint performance sourced from the [digital_land](https://datasette.planning.data.gov.uk/digital-land). |
greg-slater
reviewed
Nov 5, 2024
|
|
||
| ### 1. Table: [endpoint_dataset_issue_type_summary](https://datasette.planning.data.gov.uk/performance/endpoint_dataset_issue_type_summary) | ||
|
|
||
| **Purpose**: To summarize issues associated with each dataset and its associated endpoint for various organisation. |
There was a problem hiding this comment.
Would be useful to confirm here if there are any restrictions on resources. Does the table only include active resources, and does it include resources even when they don't have any issues?
There was a problem hiding this comment.
- Includes only active resources(exclude where end_date = '')
- Excludes resources without issues(count_issue=0)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What type of PR is this? (check all applicable)
Description
This pull request introduces comprehensive documentation for the Performance Database, specifically focusing on how the tables are built, the base tables utilized.