Canvas Data Release Notes (2019-02-21)
In this Canvas Data release, the schema version has been updated to 4.2.2. An initial set of tables with Canvas Catalog data have been added. Additionally, several Canvas Outcomes tables include a new column.
Canvas Data is a service that provides institutions with optimized access to all their data for reporting and queries. Learn more about Canvas Data.
- Added Tables
- catalog_dim
- catalog_product_dim
- catalog_product_fact
- catalog_enrollment_dim
- catalog_user_registration_dim
- catalog_program_requirement_fact
- Added Columns
- learning_outcome_dim
- learning_outcome_fact
- learning_outcome_group_dim
- learning_outcome_group_fact
Added Tables |
catalog_dim
Attributes for catalogs in Canvas Catalog
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate id for the catalog |
parent_id | bigint | Self-referencing key that points to the parent catalog for this catalog. Null if this catalog has no parent |
name | varchar | Name of the catalog |
currency | varchar | Type of currency used in the catalog |
country | varchar | Country used in this catalog |
time_zone | varchar | Timezone used in this catalog |
created_at | timestamp | When the catalog was created |
updated_at | timestamp | When the catalog was last updated |
catalog_product_dim
Attributes for products in Canvas Catalog. A product can be either a course or a program listing.
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate id for the catalog product |
catalog_id | bigint | Foreign key to the catalog dim |
start_date | timestamp | The start date for the course or program |
end_date | timestamp | The end date for the course or program |
course_id | bigint | Foreign key to the course dim if this product is a course |
product_type | varchar | Can be either "Program" or "Course" |
title | varchar | The title of the course or program listing |
visibility | varchar | Can be one of “listed”, “unlisted”, or “hidden” |
enrollment_open | boolean | Whether the course or program is open for enrollment |
has_waitlist | boolean | Whether the course or program has a waitlist |
created_at | timestamp | The date when the product was created |
updated_at | timestamp | The date when the product was last updated |
catalog_product_fact
Facts for products in Canvas Catalog. A product can be either a course or a program listing
Name | Type | Description |
---|---|---|
catalog_product_id | bigint | Foreign key to the catalog product dim |
catalog_id | bigint | Foreign key to the catalog dim |
parent_catalog_id | bigint | Foreign key to the catalog dim. References the parent of the catalog that this product belongs to |
course_id | bigint | Foreign key to the course dim if this product is a course |
enrollment_term_id | bigint | Foreign key to the enrollment term dim |
enrollment_fee | double precision | Cost of the catalog product. Units are found in catalog_dim.currency |
credits | double precision | Number of credits the course is worth if the product is a course |
waitlist_capacity | int | The maximum capacity of the waitlist. Null if the waitlist has no maximum capacity |
enrollment_capacity | int | The maximum enrollment capacity for the course or program |
catalog_enrollment_dim
Attributes for an enrollment in a Canvas Catalog program or course.
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate key for the catalog enrollment |
catalog_product_id | bigint | Foreign key to the catalog product dim. Refers to the course or program associated with the enrollment |
user_id | bigint | Foreign key to the user dim. Refers to the user associated with this enrollment |
root_program_id | bigint | Foreign key to the catalog product dim. Refers to the root program associated with this enrollment |
status | varchar | The status of the enrollment. One of either “active” or “dropped” |
requirements_completed_at | timestamp | Time when the user completed all requirements for the course or program. Null if the requirements have not yet been met |
ends_at | timestamp | Time by which the user must complete the course or program requirements. Null if there is no required end date |
created_at | timestamp | Time when the enrollment was created |
updated_at | timestamp | Time when the enrollment was last updated |
catalog_user_registration_dim
Attributes for user registration in a Canvas Catalog. See catalog_enrollment for data about programs and courses the user is enrolled in.
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate key for the catalog user registration |
catalog_id | bigint | Foreign key to the catalog dim. Refers to the catalog that this registration belongs to |
user_id | bigint | Foreign key to the user dim. Refers to the registered user |
created_at | timestamp | Time when the user registration record was created |
updated_at | timestamp | Time when the user registration record was last updated |
catalog_program_requirement_fact
Facts for the courses or programs required for completion of a program
Name | Type | Description |
---|---|---|
id | bigint | Unique surrogate key for the program requirement |
catalog_id | bigint | Foreign key to the catalog dim. Refers to the catalog in which this requirement is defined |
catalog_program_id | bigint | Foreign key to the catalog product dim. This ID refers to the program that requires the program or course referred to by “catalog_product_id” |
catalog_product_id | bigint | Foreign key to the catalog product dim. This ID refers to the program or course required by the program referred to by “catalog_program_id” |
course_id | bigint | Foreign key to the course dim. Refers to the required course if the requirement refers to a course. |
Added Columns |
learning_outcome_dim
Name | Type | Description |
---|---|---|
outcome_import_id | bigint | Foreign key to the outcome import associated with this outcome, if this outcome was imported |
learning_outcome_fact
Name | Type | Description |
---|---|---|
outcome_import_id | bigint | Foreign key to the outcome import associated with this outcome, if this outcome was imported |
learning_outcome_group_dim
Name | Type | Description |
---|---|---|
outcome_import_id | bigint | Foreign key to the outcome import associated with this outcome, if this outcome was imported |
learning_outcome_group_fact
Name | Type | Description |
---|---|---|
outcome_import_id | bigint | Foreign key to the outcome import associated with this outcome, if this outcome was imported |