Skip to content

E
edx-platform
Commit 6d76d6ab by Mark Hoeber
Options

Wiki data update 

Wiki data update
parent 3d366eb0
Showing with 186 additions and 89 deletions
docs/data/source/internal_data_formats/wiki_data.rst
......@@ -2,133 +2,230 @@
Wiki Data
##############################
The following sections detail how edX stores Wiki data internally, and is useful for developers and researchers who are examining database exports. This information includes demographic information collected at signup, course enrollment, course progress, and certificate status.
The following sections detail how edX stores Wiki data internally, and is useful for developers and researchers who are examining database exports.
Conventions to keep in mind:
* edX currently uses an external application called Django Wiki for Wiki functionality within courses.
EdX currently uses an external application called Django Wiki for Wiki functionality within courses.
****************
Notification Type
article
****************
The `notifications` table stores . It has the following fields::
+------------------------------+--------------+------+-----+
| Field | Type | Null | Key |
+------------------------------+--------------+------+-----+
| key | varchar(128) | NO | PRI |
| label | varchar(128) | YES | |
| content_type | ForeignKey | YES | |
+------------------------------+--------------+------+-----+
`key`
.. list-table::
:widths: 15 15 15 15
:header-rows: 1
* - Field
- Type
- Null
- Key
* - id
- int(11)
- NO
- PRI
* - current_revision
- int(11)
- NO
-
* - created
- datetime
- NO
-
* - modified
- datetime
- NO
-
* - owner_id
- int(11)
- NO
- Foreign
* - group_read
- boolean
- NO
-
* - group_write
- boolean
- NO
-
* - other_read
- boolean
- NO
-
* - other_write
- boolean
- NO
-
`id`
----
Primary key . . .
The primary key.
`label`
`current_revision_id`
----------
The label for the notification . . .
The ID of the revision that is displayed for this article.
`content_type`
`created`
------------
A foreign key . . .
The date the article was created.
`modified`
------------
The date the article was last modified.
****************
Settings
****************
`owner_id`
------------
The user ID of the article owner.
The `Settings` table stores . It has the following fields::
`group_read`
------------
Whether the group has read access to the article.
+------------------------------+--------------+------+-----+
| Field | Type | Null | Key |
+------------------------------+--------------+------+-----+
| user | ForeignKey | NO | PRI |
| interval | smallint(6) | NO | |
+------------------------------+--------------+------+-----+
`group_write`
------------
Whether the group has write access to the article.
`user`
----
Primary key . . .
`other_read`
------------
Whether others have read access to the article.
`interval`
----------
The . . .
`other_write`
------------
Whether others have read access to the article.
****************
Subscriptions
****************
The `Subscriptions` table stores . It has the following fields::
+------------------------------+--------------+------+-----+
| Field | Type | Null | Key |
+------------------------------+--------------+------+-----+
| settings | ForeignKey | NO | PRI |
| notification_type | ForeignKey | NO | |
| object_id | varchar(64) | YES | |
| send_emails | boolean | NO | |
+------------------------------+--------------+------+-----+
`settings`
****************
article_revision
****************
.. list-table::
:widths: 15 15 15 15
:header-rows: 1
* - Field
- Type
- Null
- Key
* - id
- int(11)
- NO
- PRI
* - revision_number
- int(11)
- NO
-
* - user_message
- varchar(255)
- YES
-
* - automatic_log
- varchar(255)
- YES
-
* - ip_address
- ??
- YES
-
* - user_id_modified
- int(11)
- NO
-
* - created
- datetime
- NO
-
* - previous_revision_id
- int(11)
- NO
- Foreign
* - deleted
- boolean
- NO
-
* - locked
- boolean
- NO
-
* - article_id
- int(11)
- NO
- Foreign
* - content
- longtext
- NO
-
* - title
- varchar(512)
- NO
-
`id`
----
Primary key . . .
The primary key.
`notification type`
`revision_number`
----------
The . . .
The ID of the revision.
`object_id`
----
Primary key . . .
`send_emails`
----------
The . . .
`user_message`
------------
The message the user added when saving the revision.
****************
Notification
****************
`automatic_log`
------------
???
The `Notification` table stores . It has the following fields::
`user`
------------
The ID of the user who made the revision.
+------------------------------+--------------+------+-----+
| Field | Type | Null | Key |
+------------------------------+--------------+------+-----+
| subscription | ForeignKey | NO | PRI |
| message | text | NO | |
| url | URLField | YES | |
| is_viewed | boolean | NO | |
| is_emailed | boolean | NO | |
| created | datetime | NO | |
+------------------------------+--------------+------+-----+
`subscription`
----
Primary key . . .
`modified`
------------
The date the article was last modified.
`message`
----------
The . . .
`url`
----
Primary key . . .
`created`
------------
The date the article was created.
`is_viewed`
----------
The . . .
`is_emailed`
`previous_revision`
------------
The ID of the revision previous to this one.
`deleted`
------------
Whether or not the revision was deleted.
`locked`
------------
Whether or not the revision is locked.
`article_id`
----------
The . . .
The ID of the revision that is displayed for this article.
`created`
`content`
------------
The content of the article revision.
`title`
----------
The . . .
The title of the article revision.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment