Wiki data update

Wiki data update
This commit is contained in:
Mark Hoeber
2013-12-13 14:25:15 -05:00
parent 3d366eb06f
commit 6d76d6abe8

View File

@@ -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::
.. list-table::
:widths: 15 15 15 15
:header-rows: 1
+------------------------------+--------------+------+-----+
| Field | Type | Null | Key |
+------------------------------+--------------+------+-----+
| key | varchar(128) | NO | PRI |
| label | varchar(128) | YES | |
| content_type | ForeignKey | YES | |
+------------------------------+--------------+------+-----+
* - 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
-
`key`
`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`
------------
A foreign key . . .
****************
Settings
****************
The `Settings` table stores . It has the following fields::
+------------------------------+--------------+------+-----+
| Field | Type | Null | Key |
+------------------------------+--------------+------+-----+
| user | ForeignKey | NO | PRI |
| interval | smallint(6) | NO | |
+------------------------------+--------------+------+-----+
`user`
----
Primary key . . .
`interval`
----------
The . . .
****************
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`
----
Primary key . . .
`notification type`
----------
The . . .
`object_id`
----
Primary key . . .
`send_emails`
----------
The . . .
****************
Notification
****************
The `Notification` table stores . It has the following fields::
+------------------------------+--------------+------+-----+
| 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 . . .
`message`
----------
The . . .
`url`
----
Primary key . . .
`is_viewed`
----------
The . . .
`is_emailed`
----------
The . . .
`created`
------------
The date the article was created.
`modified`
------------
The date the article was last modified.
`owner_id`
------------
The user ID of the article owner.
`group_read`
------------
Whether the group has read access to the article.
`group_write`
------------
Whether the group has write access to the article.
`other_read`
------------
Whether others have read access to the article.
`other_write`
------------
Whether others have read access to the article.
****************
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`
----
The primary key.
`revision_number`
----------
The . . .
The ID of the revision.
`user_message`
------------
The message the user added when saving the revision.
`automatic_log`
------------
???
`user`
------------
The ID of the user who made the revision.
`modified`
------------
The date the article was last modified.
`created`
------------
The date the article was created.
`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 ID of the revision that is displayed for this article.
`content`
------------
The content of the article revision.
`title`
----------
The title of the article revision.