]> code.communitydata.science - rises_declines_wikia_code.git/blob - mediawiki_dump_tools/Mediawiki-Utilities/doc/core/database.rst
Initial commit
[rises_declines_wikia_code.git] / mediawiki_dump_tools / Mediawiki-Utilities / doc / core / database.rst
1 .. _mw.database:
2
3 =========================================
4 mw.database -- MySQL database abstraction
5 =========================================
6
7 This module contains a set of utilities for interacting with MediaWiki databases.
8
9 Here's an example of a common usage pattern:
10 ::
11         
12         from mw import database
13         
14         db = database.DB.from_params(
15                 host="s1-analytics-slave.eqiad.wmnet", 
16                 read_default_file="~/.my.cnf", 
17                 user="research", 
18                 db="enwiki"
19         )
20         revisions = db.revisions.query(user_id=9133062)
21         
22         for rev_row in revisions:
23                 rev_row['rev_id']
24
25
26 DB
27 ======
28
29 .. autoclass:: mw.database.DB
30    :members:
31    :member-order: bysource
32    
33
34 Collections
35 ===========
36
37 .. autoclass:: mw.database.Archives
38    :members:
39
40 .. autoclass:: mw.database.AllRevisions
41    :members:
42
43 .. autoclass:: mw.database.Pages
44    :members:
45
46 .. autoclass:: mw.database.RecentChanges
47    :members:
48
49 .. autoclass:: mw.database.Revisions
50    :members:
51
52 .. autoclass:: mw.database.Users
53    :members:

Community Data Science Collective || Want to submit a patch?