feat: mpe_submit docs

This commit is contained in:
Allan Bowe
2022-06-17 18:42:10 +00:00
parent d8e1c514bc
commit b743f856fc
8 changed files with 38 additions and 7 deletions

View File

@ -0,0 +1,29 @@
---
layout: article
title: MPE_DATACATALOG_LIBS
description: The MPE_DATACATALOG_LIBS table catalogs library attributes such as engine, paths, permissions, owners & schemas
---
# MPE_DATACATALOG_LIBS
The `MPE_DATACATALOG_LIBS` table catalogs library attributes such as engine, paths, permissions, owners & schemas.
More frequently changing attributes (such as size and number of tables) are stored in [MPE_DATASTATUS_LIBS](/mpe_datastatus_libs).
To ignore additional librefs, or to trigger a scan, see the Refresh Data Catalog [instructions](https://docs.datacontroller.io/admin-services/#refresh-data-catalog).
## Columns
- `TX_FROM num`: SCD2 open datetime
- 🔑 `TX_TO num`: SCD2 close datetime
- 🔑 `LIBREF char(8)`: SAS Libref (8 chars)
- `ENGINE char(32)`: The engine used to connect to the library
- `LIBNAME char(256)`: The Library Name (from metadata if SAS 9)
- `PATHS char(8192)`: The directories used (BASE engine only)
- `PERMS char(500)`: The directory permissions (BASE engine only)
- `OWNERS char(500)`: The directory owners (BASE engine only)
- `SCHEMAS char(500)`: The library schema (DB engines)
- `LIBID char(17)`: The Library Id (from metadata if SAS 9)

View File

@ -0,0 +1,28 @@
---
layout: article
title: MPE_DATACATALOG_TABS
description: The MPE_DATACATALOG_TABS table catalogs attributes such as number of variables, compression status, and primary key fields.
---
# MPE_DATACATALOG_TABS
The `MPE_DATACATALOG_TABS` table catalogs attributes such as number of variables, compression status, and primary key fields.
More frequently changing attributes (such as size modification date and number of observations) are stored in [MPE_DATASTATUS_TABS](/mpe_datastatus_tabs).
To trigger a scan, see the Refresh Data Catalog [instructions](https://docs.datacontroller.io/admin-services/#refresh-data-catalog).
## Columns
- `TX_FROM num`: SCD2 open datetime
- 🔑 `TX_TO num`: SCD2 close datetime
- 🔑 `LIBREF char(8)`: SAS Libref (8 chars)
- 🔑 `DSN char(64)`: The library member name
- `MEMTYPE char(8)`: The member type
- `DBMS_MEMTYPE char(32)`: The DBMS Member Type
- `MEMLABEL char(512)`: The Data Set Label
- `TYPEMEM char(8)`: The Data Set Type
- `NVAR num`: The number of variables
- `COMPRESS char(8)`: The compression routine
- `PK_FIELDS char(512)`: The list of primary key fields. These are deduced from the table constraints. A Primary key column is identified by being in a constraint (or index) that is both UNIQUE and NOT NULL.

View File

@ -0,0 +1,31 @@
---
layout: article
title: MPE_DATACATALOG_VARS
description: The MPE_DATACATALOG_VARS table catalogs variable attributes such as primary key status, not null constraints and index usage.
---
# MPE_DATACATALOG_VARS
The `MPE_DATACATALOG_VARS` table catalogs variable attributes such as primary key status, not null constraints and index usage.
To trigger a scan, see the Refresh Data Catalog [instructions](https://docs.datacontroller.io/admin-services/#refresh-data-catalog).
## Columns
- `TX_FROM num`: SCD2 open datetime
- 🔑 `TX_TO num`: SCD2 close datetime
- 🔑 `LIBREF char(8)`: SAS Libref (8 chars)
- 🔑 `DSN char(64)`: The library member name
- 🔑 `NAME char(64)`: The variable name
- `MEMTYPE char(8)`: The member type
- `TYPE char(16)`: The column type
- `LENGTH num`: The column length
- `VARNUM num`: The column position in the table
- `LABEL char(256)`: The column label
- `FORMAT char(49)`: The SAS format associated with the column
- `IDXUSAGE char(9)`: The column index type
- `NOTNULL char(3)`: The NOT NULL status
- `PK_IND num`: A flag to say whether the column is part of the primary key (1=PK, 0=Not PK). A Primary key column is identified by being in a constraint (or index) that is both UNIQUE and NOT NULL.

View File

@ -0,0 +1,20 @@
---
layout: article
title: MPE_DATASTATUS_LIBS
description: The MPE_DATASTATUS_LIBS table captures frequently changing SAS library attributes such as size (if filesystem based) and the number of tables.
---
# MPE_DATASTATUS_LIBS
The `MPE_DATASTATUS_LIBS` table captures frequently changing SAS library attributes such as size (if filesystem based) and the number of tables.
To trigger a scan, see the Refresh Data Catalog [instructions](https://docs.datacontroller.io/admin-services/#refresh-data-catalog).
## Columns
- `TX_FROM num`: SCD2 open datetime
- 🔑 `TX_TO num`: SCD2 close datetime
- 🔑 `LIBREF char(8)`: SAS Libref (8 chars)
- `LIBSIZE num`: The size of the library (in bytes), displayed with the SIZEKMG. format. Only applicable to BASE engine libraries.
- `TABLE_CNT num`: The number of tables in the library.

View File

@ -0,0 +1,24 @@
---
layout: article
title: MPE_DATASTATUS_TABS
description: The MPE_DATASTATUS_TABS table captures frequently changing SAS table attributes such as size (if filesystem based), modification date, and the number of observations.
---
# MPE_DATASTATUS_TABS
The `MPE_DATASTATUS_TABS` table captures frequently changing SAS table attributes such as size (if filesystem based), modification date, and the number of observations.
To trigger a scan, see the Refresh Data Catalog [instructions](https://docs.datacontroller.io/admin-services/#refresh-data-catalog).
## Columns
- `TX_FROM num`: SCD2 open datetime
- 🔑 `TX_TO num`: SCD2 close datetime
- 🔑 `LIBREF char(8)`: SAS Libref (8 chars)
- 🔑 `DSN char(64)`: The library member name
- `FILESIZE num`: The size of the table (in bytes), displayed with the SIZEKMG. format. Only applicable to BASE engine libraries.
- `CRDATE num`: Creation date of the table
- `MODATE num`: Modification date of the table
- `NOBS num`: Number of Observations. Note - if the table is a SAS dataset then this _includes_ deleted rows. To remove deleted rows from a SAS dataset, it must be re-created.

30
docs/tables/mpe_submit.md Normal file
View File

@ -0,0 +1,30 @@
---
layout: article
title: MPE_SUBMIT
description: The MPE_SUBMIT table tracks the status of submitted modifications - ie SUBMITTED, APPROVED, or REJECTED.
og_title: MPE_SUBMIT Table Documentation
og_image: /img/mpe_submit.png
---
# MPE_SUBMIT
The MPE_SUBMIT table tracks the status of submitted modifications - ie SUBMITTED, APPROVED, or REJECTED. It is unique on TABLE_ID.
![submits](img/mpe_submit.png)
## Columns
- 🔑 `TABLE_ID char(32)`: A unique code for the submission, and corresponds to the folder in which the staged data resides.
- `SUBMIT_STATUS_CD char(10)`: Either SUBMITTED, APPROVED, or REJECTED. Remains SUBMITTED until the final approval, or first rejection.
- `BASE_LIB char(8)`: The LIBREF of the table being updated
- `BASE_DS char(32)`: The name of the dataset (or format catalog) being updated
- `SUBMITTED_BY_NM (100)`: The username of the submitter
- `SUBMITTED_ON_DTTM num`: The timestamp of the submission
- `SUBMITTED_REASON_TXT char(400)`: The description provided by the submitter
- `INPUT_OBS num`: The number of observations staged
- `INPUT_VARS num`: The number of variables staged
- `NUM_OF_APPROVALS_REQUIRED num`: Taken from MPE_TABLES at the time of submission
- `NUM_OF_APPROVALS_REMAINING num`: Decreased by 1 with every approval, set to 0 on rejection.
- `REVIEWED_BY_NM char(100)`: User id that made the final approval / rejection
- `REVIEWED_ON_DTTM num`: Timestamp of the final approval / rejection