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

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

44
     #@param db_name str
44
     #@param db_name str
45
     #@param username str
45
     #@param username str
46
     #@param password str
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
     #Datasource is write only !
48
     #Datasource is write only !
49
     def __init__(self, host, port, db_name, username, password, read_only = False):
49
     def __init__(self, host, port, db_name, username, password, read_only = False):
50
         ##@brief Connections infos that can be kept securly
50
         ##@brief Connections infos that can be kept securly
88
     #@param target Emclass
88
     #@param target Emclass
89
     #@param field_list list
89
     #@param field_list list
90
     #@param filters list : List of filters
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
     #@param order list : List of column to order. ex: order = 
92
     #@param order list : List of column to order. ex: order = 
93
     #[('title', 'ASC'),]
93
     #[('title', 'ASC'),]
94
     #@param group list : List of tupple representing the column used as 
94
     #@param group list : List of tupple representing the column used as 
203
     ## @brief updates records according to given filters
203
     ## @brief updates records according to given filters
204
     #@param target Emclass : class of the object to insert
204
     #@param target Emclass : class of the object to insert
205
     #@param filters list : List of filters
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
     #@param upd_datas dict : datas to update (new values)
207
     #@param upd_datas dict : datas to update (new values)
208
     #@return int : Number of updated records
208
     #@return int : Number of updated records
209
     def update(self, target, filters, relational_filters, upd_datas):
209
     def update(self, target, filters, relational_filters, upd_datas):
272
         return result
272
         return result
273
 
273
 
274
     ##@brief Connect to database
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
     #MongoDbDatasource::_connections static attribute
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
     #@param username str
277
     #@param username str
281
     #@param password str
278
     #@param password str
282
     #@param ro bool : If True the Datasource is for read only, else the
279
     #@param ro bool : If True the Datasource is for read only, else the

Loading…
Cancel
Save