In this production release (February 20th), we have updated the schema to version v1.14.0. Changes to the schema for this release include adding in multiple brand new tables in order to supply "modules" data.
< BACK TO TABLE OF CONTENTS
Module Dim:
Column Name | Column Type | Description |
---|
id | BIGINT | Unique surrogate ID for the module. |
canvas_id | BIGINT | The ID for this module inside of Canvas. |
course_id | BIGINT | The course that owns this module. |
require_sequential_progress | ENUM | Should module items be completed sequentially? Valid values are 'required', 'not_required', 'unspecified'. |
workflow_state | ENUM | Workflow state for submission lifetime values. Possible values are 'locked', 'completed', 'unlocked' and 'started'. |
position | INT | Position of the module on the modules page. |
name | TEXT | The name of the module in Canvas. |
created_at | timestamp | Timestamp when the module was created. |
deleted_at | timestamp | Timestamp when the module was deleted. |
unlock_at | timestamp | Timestamp when the module will unlock. |
updated_at | timestamp | Timestamp when the module was last updated. |
Module Fact:
Column Name | Column Type | Description |
---|
module_id | BIGINT | Unique surrogate ID for the module. |
account_id | BIGINT | Foreign key to the account the module belongs to. |
course_id | BIGINT | Foreign key to the course associated with this assignment. |
enrollment_term_id | BIGINT | Foreign key to the enrollment_term associated with the module_fact course. |
wiki_id | BIGINT | Foreign key to the wiki associated with the module_fact course. |
Module Item Dim:
Column Name | Column Type | Description |
---|
id | BIGINT | Unique surrogate ID for the module_item. |
canvas_id | BIGINT | Original primary key for module_item in the Canvas table. |
assignment_id | BIGINT | Key into assignments table for 'Assignment' type items. |
course_id | BIGINT | The course that owns this module. |
discussion_topic_id | BIGINT | Key into discussion_topics table for 'Discussion' type items. |
file_id | BIGINT | Key into file table for 'File' type items. |
module_id | BIGINT | Parent module for this module item. |
quiz_id | BIGINT | Key into quizzes table for 'Quiz' type items. |
wiki_page_id | BIGINT | Key into wiki_pages table for 'Page' type items. |
content_type | ENUM | The type of content linked to this item. One of: 'Assignment', 'Attachment', 'DiscussionTopic', 'ContextExternalTool', 'ContextModuleSubHeader', 'ExternalUrl', 'LearningOutcome', 'Quiz', 'Rubric' or 'WikiPage'. |
workflow_state | ENUM | State of the module item. Active, Unpublished, or deleted. |
position | INT | Position of the module item within the module context. |
title | TEXT | Title of the module item. |
url | TEXT | Url for external url type module items. |
created_at | TIMESTAMP | Timestamp when the module item was created. |
updated_at | TIMESTAMP | Timestamp when the module item was last updated. |
Module Item Fact:
Column Name | Column Type | Description |
---|
module_item_id | BIGINT | Unique surrogate ID for the module_item. |
account_id | BIGINT | Foreign key to the account the module belongs to. |
assignment_id | BIGINT | Key into assignments table for 'Assignment', 'DiscussionTopic', 'File', 'Quiz' type items. |
assignment_group_id | BIGINT | Key into assignment_groups for 'Assignment', 'File' type items. |
course_id | BIGINT | The course that owns this module. |
discussion_topic_id | BIGINT | Key into discussion_topics table for 'DiscussionTopic' type items. |
discussion_topic_editor_id | BIGINT | Key into users table for user who edited 'DiscussionTopic' type items. |
enrollment_rollup_id | BIGINT | Key into enrollment_rollup table for user associated with 'DiscussionTopic', 'File' type items. |
enrollment_term_id | BIGINT | Foreign key to the enrollment_term associated with the module course. |
file_id | BIGINT | Key into file table for 'File' type items. |
module_id | BIGINT | Parent module for this module item. |
quiz_id | BIGINT | Key into quizzes table for 'File', 'Quiz' type items. |
user_id | BIGINT | Key into users table for 'DiscussionTopic', 'File', 'WikiPage' type items. |
wiki_id | BIGINT | Key into wiki table for 'WikiPage' type items. |
wiki_page_id | BIGINT | Key into wiki_pages table for 'WikiPage' type items. |
Module Progression Dim:
Column Name | Column Type | Description |
---|
id | BIGINT | Unique surrogate ID for the module progression. |
canvas_id | BIGINT | Original primary key for module progression in the Canvas table. |
module_id | BIGINT | Parent module for this module progression. |
user_id | BIGINT | User being tracked in the module progression. |
collapsed | ENUM | Collapsed state of the module progression. Values are collapsed, not_collapsed, unspecified. |
is_current | ENUM | The current state of the module progression. Values are current, not_current, unspecified |
workflow_state | ENUM | The workflow state of the module progression. Values are locked, completed, unlocked, and started. |
current_position | INT | Represents the users current position in the module. |
lock_version | INT | Lock version of the module progression. |
created_at | TIMESTAMP | Timestamp when the module progression was created. |
completed_at | TIMESTAMP | Timestamp when the module progression was completed. |
evaluated_at | TIMESTAMP | Timestamp when the module progression was evaluated. |
updated_at | TIMESTAMP | Timestamp when the module progression was last updated. |
Module Progression Fact:
Column Name | Column Type | Description |
---|
module_progression_id | BIGINT | Unique surrogate ID for the module progression. |
account_id | BIGINT | Foreign key to the account the module belongs to. |
course_id | BIGINT | Foreign key to the course associated with this module. |
enrollment_term_id | BIGINT | Foreign key to the enrollment_term associated with the module course. |
module_id | BIGINT | Parent module for this module progression. |
user_id | BIGINT | User being tracked in the module progression. |
wiki_id | BIGINT | Foreign key to the wiki associated with the module course. |
Module Completion Requirement Dim:
Column Name | Column Type | Description |
---|
id | BIGINT | Unique surrogate ID for the module completion requirement. |
module_id | BIGINT | Module that contains the completion requirement. |
module_item_id | BIGINT | Item that is the subject of the completion requirement. |
requirement_type | ENUM | Type of completion event that must be achieved to consider item complete. Values are: must_view,must_mark_done,min_score,must_submit. |
Module Completion Requirement Fact:
Column Name | Column Type | Description |
---|
module_completion_requirement_id | BIGINT | Unique surrogate ID for the module completion requirement. |
account_id | BIGINT | Foreign key to the account the module and the module item belong to. |
assignment_id | BIGINT | Assignment associated with the module item. |
assignment_group_id | BIGINT | Assignment group associated with the module item. |
course_id | BIGINT | Foreign key to the course associated with this module and the module item. |
discussion_topic_id | BIGINT | Discussion topic associated with the module item. |
discussion_topic_editor_id | BIGINT | Editor of the discussion topic associated with the module item. |
enrollment_rollup_id | BIGINT | Enrollment rollup associated with the module item. |
enrollment_term_id | BIGINT | Foreign key to the enrollment term associated with this module and the module item. |
file_id | BIGINT | File associated with the module item. |
module_id | BIGINT | Module that contains the completion requirement. |
module_item_id | BIGINT | Item that is the subject of the completion requirement. |
quiz_id | BIGINT | Quiz associated with the module item. |
user_id | BIGINT | User associated with the module item. |
wiki_id | BIGINT | Foreign key to the wiki associated with this module and the module item. |
wiki_page_id | BIGINT | Wiki page associated with the module_item. |
min_score | DOUBLE | For min_score type requirements, the score that must be attained for completion.. |
Module Prerequisite Dim:
Column Name | Column Type | Description |
---|
id | BIGINT | Unique surrogate ID for the module prerequisite. |
module_id | BIGINT | Module that contains the prerequisite. |
prerequisite_module_id | BIGINT | Module that must be completed to fulfill the prerequisite. |
Module Prerequisite Fact:
Column Name | Column Type | Description |
---|
module_prerequisite_id | BIGINT | Unique surrogate ID for the module prerequisite. |
account_id | BIGINT | Foreign key to the account the module belongs to. |
course_id | BIGINT | Foreign key to the course associated with this assignment. |
enrollment_term_id | BIGINT | Foreign key to the enrollment_term associated with the module_fact course. |
module_id | BIGINT | Module that contains the prerequisite. |
prerequisite_module_id | BIGINT | Module that must be completed to fulfill the prerequisite. |
prerequisite_wiki_id | BIGINT | Foreign key to the wiki associated with the module_fact course. |
wiki_id | BIGINT | Foreign key to the wiki associated with the module_fact course. |
Module Progression Completion Requirement Dim:
Column Name | Column Type | Description |
---|
id | BIGINT | Unique surrogate ID for the module progression completion requirement. |
module_progression_id | BIGINT | Module progression referenced by completion requirement. |
module_item_id | BIGINT | Item that the user has not completed. |
requirement_type | ENUM | Type of completion event that must be achieved to consider item complete. Values are: must_view, must_mark_done, min_score, must_submit. |
completion_status | ENUM | Denotes if the completion event is complete or not. Possible values are 'complete' and 'incomplete'. |
Module Progression Completion Requirement Fact:
Column Name | Column Type | Description |
---|
module_progression_completion_requirement_id | BIGINT | Unique surrogate ID for the module progression completion requirement. |
account_id | BIGINT | Key to the account associated with the module progression and the module item. |
assignment_id | BIGINT | Key to the assignment associated with the module item. |
assignment_group_id | BIGINT | Key to the assignment group associated with the module item. |
course_id | BIGINT | Key to the course associated with the module progression and the module item. |
discussion_topic_id | BIGINT | Key to the discussion topic associated with the module item. |
discussion_topic_editor_id | BIGINT | Key to the user editing the discussion topic associated with the module item. |
enrollment_rollup_id | BIGINT | Key to the enrollment rollup associated with the module item. |
enrollment_term_id | BIGINT | Key to the enrollment term associated with the module progression and the module item. |
file_id | BIGINT | Key to the file associated with the module item. |
module_id | BIGINT | Parent module for this module progression and module item. |
module_item_id | BIGINT | Item that the user has completed. |
module_progression_id | BIGINT | Module progression referenced by the completion requirement. |
quiz_id | BIGINT | Key to the quiz associated with the module item. |
user_id | BIGINT | Key to the user associated with the module progression and the module item. |
wiki_id | BIGINT | Key to the wiki associated with the module progression and the module item. |
wiki_page_id | BIGINT | Key to the wiki page associated with the module item. |
min_score | DOUBLE | For min_score type requirements, the score that must be attained for completion. |
score | DOUBLE | For min_score type requirements, the score that the user has currently achieved. |