Note: You are currently viewing documentation for Moodle 2.5. Up-to-date documentation for the latest stable version of Moodle may be available here: Using Database.

Using Database: Difference between revisions

From MoodleDocs
(Created page with "{{Database}} <p class="note">'''Please refer to these notes before editing this page.'''</p>")
 
(→‎Exporting entries: forum discussion link)
 
(9 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Database}}
{{Database}}
<p class="note">'''Please refer to [[Page_notes#Database|these notes]] before editing this page.'''</p>
==Views==
 
===View list===
 
The list view shows multiple entries, possibly in a more abbreviated form to ensure all the information fits. You may use the controls at the bottom of the screen to search and sort the contents.
 
* ''View single'': one item at a time
* ''View list'' (red arrow): several items at a time (number is user defined)
* ''Add entry'' (green arrows): add an item to the database
 
The icons highlighted in yellow are for editing, viewing and deleting an item in the database.
 
[[Image:Dbasetabs.gif]]
 
=== View single ===
 
Alternatively, you may view only one entry at a time. This might allow you to view more detailed information than the list view.
 
=== Add comment ===
 
If comments have been enabled, you may add a comment.
 
=== Rate entries ===
 
If ratings have been enabled, and made viewable, by the database editor, you may [[Grades|grade]] other database entries, and view these ratings.
 
==Adding an entry==
 
Go to the "Add entry" tab and fill in the form.
 
==Automatically linking database entries==
 
If the [[Database auto-linking filter]] is enabled, any entries in a database will be automatically linked to where the concept words and/or phrases appear within the same course. This includes forum postings, internal resources, week summaries etc.
 
Note: If you do not want particular text to be linked (in a forum posting, say) then you should add <nolink> and </nolink> tags around the text. Alternatively the filter can be disabled for a particular activity.
 
==Importing many entries==
You can import entries via a CSV file if you click the "Import entries" link in the Database activity administration block. CSV means Comma-Separated-Values and is a common format for text interchange.
 
[[image:Databaseupload.png]]
 
The easiest way to determine the format of the text file is to manually add an entry to the database and then export it. The resulting export text file may then be edited and used for importing entries. Here's a sample of what a very simple file will look like.
 
[[Image:Upload_csv_sample.png]]
 
The expected file format is a plain text file with a list of field names as the first record. The data then follows, one record per line.
 
The field delimiter defaults to a comma character and the field enclosure is not set by default (field enclosures are characters that surround each field in each record).
 
Records should be delimited by new lines (usually generated by pressing RETURN or ENTER in your text editor). Tabs can be specified using \t and newlines by \n.
 
Sample file:
 
  name,height,weight
  Kai,180cm,80kg
  Kim,170cm,60kg
  Koo,190cm,20kg
 
Note: Certain field types may not be supported.
 
Do not put spaces after your commas or upload will fail!
 
After upload page import.php comes back blank if it failed.
If successful you'll read a message like, "1 entries saved".
 
==Exporting entries==
 
You can export entries either in CSV (comma separated values) or ODS (OpenOffice Calc) formats by clicking the tab at the top or by clicking the "Export entries" link in the Database Activity administration block. (Both CSV and ODS formats can be opened with MS Excel.)
 
[[File:Databasexport.png]]
 
When using the CSV format, the user can select either the comma, semicolon, or tab to separate the fields. The selection of the proper character is important. If users select to use a comma to separate the fields and some of the fields contain data with commas then the number of columns is going to be misaligned and likely cause confusion.
 
Users can select which fields from the database they wish to have exported. By default, all fields are checked to be included. Choose the fields that you wish to have included in the export.
 
Once the export type and the fields to be exported have been selected, clicking on the Export entries pushbutton will generate the file. The user will usually have the option of either opening or saving the file.
 
For information on converting the date export (and import) format, see the discussion [https://moodle.org/mod/forum/discuss.php?d=220505 Standard Database Module - Dates].
 
==Exporting to an external portfolio==
 
If an external [[Portfolios|portfolio]] such as [[Mahara_portfolio|Mahara]] has been enabled by the administrator then users have the option to export individual entries to that portfolio. They will see at the bottom of a database entry an "export" icon to click on and select the portfolio to export to:
 
[[File:Exportdatabasentry.png]]
 
== Example databases ==
 
Moodle.org has two good examples of the database module in action:
 
* [http://moodle.org/mod/data/view.php?id=6140 Moodle Buzz], a database of the titles, authors and web links to news articles mentioning Moodle
* [http://moodle.org/mod/data/view.php?d=26 Themes], a database with screenshots, download links and user comments about Moodle [[Themes|themes]]
 
== Creative uses ==
 
You could use the database module to:
 
* allow collaboration on building a collection of web links/books/journal references related to a particular subject
* display student created photos/posters/websites/poems for peer comment and review
* gather comments and votes on a shortlist of potential logos/mascot names/project ideas
* provide a [http://moodle.org/mod/forum/discuss.php?d=52699 student file storage area]
* maintain a log of what was done in a face-to-face class each day, so that absent students can get caught up themselves.  [http://moodle.org/mod/forum/discuss.php?d=115047 Example]
 
== See also ==
 
*[http://school.demo.moodle.net/course/view.php?id=127&section=3 Examples of databases in the School demo site] (available for download)
* [[Dataform module]], which is a major enhancement of the Database module with improved browsing, editing, searching and other features.
* [[Glossary module]], which performs a similar though more specialised, text-based role
* [[Using Moodle book]] Chapter 12: Databases
* Using Moodle [http://moodle.org/mod/forum/view.php?id=3505 Database activity module forum]
* [http://treadwell.cce.cornell.edu/moodle_doc/database_moodle/index.html Screencast introducing the Database Module and walking through creating a database]
* [http://moodle.org/mod/data/view.php?rid=2424 Tracking Students' Reading with the Moodle Database Module] presentation
Using Moodle forum discussions:
* [http://moodle.org/mod/forum/discuss.php?d=72260 Database Module: Each learner Private DB?]
* [http://moodle.org/mod/forum/discuss.php?d=84487 Database for Dummies please!]
* [http://moodle.org/mod/forum/discuss.php?d=89117 Restricting access to database content by user?]
* [http://moodle.org/mod/forum/discuss.php?d=139137 How to use the database activity module?]
 
[[de:Datenbank nutzen]]

Latest revision as of 10:36, 25 January 2013

Views

View list

The list view shows multiple entries, possibly in a more abbreviated form to ensure all the information fits. You may use the controls at the bottom of the screen to search and sort the contents.

  • View single: one item at a time
  • View list (red arrow): several items at a time (number is user defined)
  • Add entry (green arrows): add an item to the database

The icons highlighted in yellow are for editing, viewing and deleting an item in the database.

Dbasetabs.gif

View single

Alternatively, you may view only one entry at a time. This might allow you to view more detailed information than the list view.

Add comment

If comments have been enabled, you may add a comment.

Rate entries

If ratings have been enabled, and made viewable, by the database editor, you may grade other database entries, and view these ratings.

Adding an entry

Go to the "Add entry" tab and fill in the form.

Automatically linking database entries

If the Database auto-linking filter is enabled, any entries in a database will be automatically linked to where the concept words and/or phrases appear within the same course. This includes forum postings, internal resources, week summaries etc.

Note: If you do not want particular text to be linked (in a forum posting, say) then you should add <nolink> and </nolink> tags around the text. Alternatively the filter can be disabled for a particular activity.

Importing many entries

You can import entries via a CSV file if you click the "Import entries" link in the Database activity administration block. CSV means Comma-Separated-Values and is a common format for text interchange.

Databaseupload.png

The easiest way to determine the format of the text file is to manually add an entry to the database and then export it. The resulting export text file may then be edited and used for importing entries. Here's a sample of what a very simple file will look like.

Upload csv sample.png

The expected file format is a plain text file with a list of field names as the first record. The data then follows, one record per line.

The field delimiter defaults to a comma character and the field enclosure is not set by default (field enclosures are characters that surround each field in each record).

Records should be delimited by new lines (usually generated by pressing RETURN or ENTER in your text editor). Tabs can be specified using \t and newlines by \n.

Sample file:

 name,height,weight
 Kai,180cm,80kg
 Kim,170cm,60kg
 Koo,190cm,20kg

Note: Certain field types may not be supported.

Do not put spaces after your commas or upload will fail!

After upload page import.php comes back blank if it failed. If successful you'll read a message like, "1 entries saved".

Exporting entries

You can export entries either in CSV (comma separated values) or ODS (OpenOffice Calc) formats by clicking the tab at the top or by clicking the "Export entries" link in the Database Activity administration block. (Both CSV and ODS formats can be opened with MS Excel.)

Databasexport.png

When using the CSV format, the user can select either the comma, semicolon, or tab to separate the fields. The selection of the proper character is important. If users select to use a comma to separate the fields and some of the fields contain data with commas then the number of columns is going to be misaligned and likely cause confusion.

Users can select which fields from the database they wish to have exported. By default, all fields are checked to be included. Choose the fields that you wish to have included in the export.

Once the export type and the fields to be exported have been selected, clicking on the Export entries pushbutton will generate the file. The user will usually have the option of either opening or saving the file.

For information on converting the date export (and import) format, see the discussion Standard Database Module - Dates.

Exporting to an external portfolio

If an external portfolio such as Mahara has been enabled by the administrator then users have the option to export individual entries to that portfolio. They will see at the bottom of a database entry an "export" icon to click on and select the portfolio to export to:

Exportdatabasentry.png

Example databases

Moodle.org has two good examples of the database module in action:

  • Moodle Buzz, a database of the titles, authors and web links to news articles mentioning Moodle
  • Themes, a database with screenshots, download links and user comments about Moodle themes

Creative uses

You could use the database module to:

  • allow collaboration on building a collection of web links/books/journal references related to a particular subject
  • display student created photos/posters/websites/poems for peer comment and review
  • gather comments and votes on a shortlist of potential logos/mascot names/project ideas
  • provide a student file storage area
  • maintain a log of what was done in a face-to-face class each day, so that absent students can get caught up themselves. Example

See also

Using Moodle forum discussions: