Browse Source

Consolidated methods documentation in mongodb and dummy datasource

Roland Haroutiounian 8 years ago
parent
commit
9754c9a0d4

+ 1
- 1
plugins/dummy_datasource/datasource.py View File

@@ -39,7 +39,7 @@ class DummyDatasource(object):
39 39
     ## @brief updates records according to given filters
40 40
     #@param target Emclass : class of the object to insert
41 41
     #@param filters list : List of filters
42
-    #@param rel_filters list : List of relational filters
42
+    #@param relational_filters list : List of relational filters
43 43
     #@param upd_datas dict : datas to update (new values)
44 44
     #@return int : Number of updated records
45 45
     def update(self, target, filters, relational_filters, upd_datas):

+ 4
- 7
plugins/mongodb_datasource/datasource.py View File

@@ -44,7 +44,7 @@ class MongoDbDatasource(object):
44 44
     #@param db_name str
45 45
     #@param username str
46 46
     #@param password str
47
-    #@param ro bool : If True the Datasource is for read only, else the
47
+    #@param read_only bool : If True the Datasource is for read only, else the
48 48
     #Datasource is write only !
49 49
     def __init__(self, host, port, db_name, username, password, read_only = False):
50 50
         ##@brief Connections infos that can be kept securly
@@ -88,7 +88,7 @@ class MongoDbDatasource(object):
88 88
     #@param target Emclass
89 89
     #@param field_list list
90 90
     #@param filters list : List of filters
91
-    #@param rel_filters list : List of relational filters
91
+    #@param relational_filters list : List of relational filters
92 92
     #@param order list : List of column to order. ex: order = 
93 93
     #[('title', 'ASC'),]
94 94
     #@param group list : List of tupple representing the column used as 
@@ -203,7 +203,7 @@ class MongoDbDatasource(object):
203 203
     ## @brief updates records according to given filters
204 204
     #@param target Emclass : class of the object to insert
205 205
     #@param filters list : List of filters
206
-    #@param rel_filters list : List of relational filters
206
+    #@param relational_filters list : List of relational filters
207 207
     #@param upd_datas dict : datas to update (new values)
208 208
     #@return int : Number of updated records
209 209
     def update(self, target, filters, relational_filters, upd_datas):
@@ -272,11 +272,8 @@ class MongoDbDatasource(object):
272 272
         return result
273 273
 
274 274
     ##@brief Connect to database
275
-    #@not this method avoid opening two times the same connection using
275
+    #@note this method avoid opening two times the same connection using
276 276
     #MongoDbDatasource::_connections static attribute
277
-    #@param host str : hostname or IP
278
-    #@param port int : mongodb listening port
279
-    #@param db_name str
280 277
     #@param username str
281 278
     #@param password str
282 279
     #@param ro bool : If True the Datasource is for read only, else the

Loading…
Cancel
Save