Merge pull request #8546 from aldbr/fix-dms-add-file-help-7290

[8.0] docs: retrieve dirac-dms-add-file lost documentation

Author: fstagni

docs/docs.conf

@@ -31,6 +31,9 @@ no_inherited_members =
   DIRAC.Core.Utilities.Graphs.GraphUtilities,
   DIRAC.DataManagementSystem.private.HttpStorageAccessHandler,
   DIRAC.FrameworkSystem.private.standardLogging.LogLevels,
+  DIRAC.Resources.IdProvider.OAuth2IdProvider,
+  DIRAC.Resources.IdProvider.CheckInIdProvider,
+  DIRAC.Resources.IdProvider.IAMIdProvider,
 
 # only creating dummy files, because they cannot be safely imported due to sideEffects
 create_dummy_files = lfc_dfc_copy, lfc_dfc_db_copy, JobWrapperTemplate

src/DIRAC/Core/Utilities/ElasticSearchDB.py

@@ -248,7 +248,7 @@ def getDoc(self, index: str, docID: str) -> dict:
         """
         sLog.debug(f"Retrieving document {docID} in index {index}")
         try:
-            return S_OK(self.client.get(index, docID)["_source"])
+            return S_OK(self.client.get(index=index, id=docID)["_source"])
         except NotFoundError:
             sLog.warn("Could not find the document in index", index)
             return S_OK({})
@@ -265,7 +265,7 @@ def getDocs(self, indexFunc, docIDs: list[str]) -> list[dict]:
         sLog.debug(f"Retrieving documents {docIDs}")
         docs = [{"_index": indexFunc(docID), "_id": docID} for docID in docIDs]
         try:
-            response = self.client.mget({"docs": docs})
+            response = self.client.mget(body={"docs": docs})
         except RequestError as re:
             return S_ERROR(re)
         else:
@@ -283,12 +283,12 @@ def updateDoc(self, index: str, docID: str, body) -> dict:
         """
         sLog.debug(f"Updating document {docID} in index {index}")
         try:
-            self.client.update(index, docID, body)
+            self.client.update(index=index, id=docID, body=body)
         except ConflictError:
             # updates are rather "heavy" operations from ES point of view, needing seqNo to be updated.
             # Not ideal, but we just wait and retry.
             time.sleep(1)
-            self.client.update(index, docID, body, params={"retry_on_conflict": 3})
+            self.client.update(index=index, id=docID, body=body, params={"retry_on_conflict": 3})
         except RequestError as re:
             return S_ERROR(re)
         return S_OK()
@@ -302,7 +302,7 @@ def deleteDoc(self, index: str, docID: str):
         """
         sLog.debug(f"Deleting document {docID} in index {index}")
         try:
-            return S_OK(self.client.delete(index, docID))
+            return S_OK(self.client.delete(index=index, id=docID))
         except RequestError as re:
             return S_ERROR(re)
         except NotFoundError:
@@ -317,7 +317,7 @@ def existsDoc(self, index: str, docID: str) -> bool:
         :param docID: document ID
         """
         sLog.debug(f"Checking if document {docID} in index {index} exists")
-        return self.client.exists(index, docID)
+        return self.client.exists(index=index, id=docID)
 
     @ifConnected
     def _Search(self, indexname):
@@ -348,7 +348,7 @@ def getIndexes(self, indexName=None):
             indexName = self.__indexPrefix
         sLog.debug(f"Getting indices alias of {indexName}")
         # we only return indexes which belong to a specific prefix for example 'lhcb-production' or 'dirac-production etc.
-        return list(self.client.indices.get_alias(f"{indexName}*"))
+        return list(self.client.indices.get_alias(index=f"{indexName}*"))
 
     @ifConnected
     def getDocTypes(self, indexName):
@@ -361,7 +361,7 @@ def getDocTypes(self, indexName):
         result = []
         try:
             sLog.debug("Getting mappings for ", indexName)
-            result = self.client.indices.get_mapping(indexName)
+            result = self.client.indices.get_mapping(index=indexName)
         except Exception as e:  # pylint: disable=broad-except
             sLog.exception()
             return S_ERROR(e)
@@ -392,7 +392,7 @@ def existingIndex(self, indexName):
         """
         sLog.debug(f"Checking existance of index {indexName}")
         try:
-            return S_OK(self.client.indices.exists(indexName))
+            return S_OK(self.client.indices.exists(index=indexName))
         except TransportError as e:
             sLog.exception()
             return S_ERROR(e)
@@ -434,7 +434,7 @@ def deleteIndex(self, indexName):
         """
         sLog.info("Deleting index", indexName)
         try:
-            retVal = self.client.indices.delete(indexName)
+            retVal = self.client.indices.delete(index=indexName)
         except NotFoundError:
             sLog.warn("Index does not exist", indexName)
             return S_OK("Nothing to delete")

src/DIRAC/DataManagementSystem/scripts/dirac_dms_add_file.py

@@ -4,27 +4,24 @@
 # Author :  Stuart Paterson
 ########################################################################
 """
-Upload a file to the grid storage and register it in the File Catalog
+Upload a file to the grid storage and register it in the File Catalog.
 
-Usage:
-  dirac-dms-add-file [options] ... LFN Path SE [GUID]
-
-Arguments:
-  LFN:      Logical File Name
-  Path:     Local path to the file
-  SE:       DIRAC Storage Element
-  GUID:     GUID to use in the registration (optional)
-
-**OR**
+The file(s) to upload can be passed either directly as arguments, or listed in a
+local text file given as the only argument (one upload per line).
 
 Usage:
+  dirac-dms-add-file [options] ... LFN Path SE [GUID]
   dirac-dms-add-file [options] ... LocalFile ...
 
 Arguments:
-  LocalFile: Path to local file containing all the above, i.e.::
-
-  lfn1 localfile1 SE [GUID1]
-  lfn2 localfile2 SE [GUID2]
+  LFN:       Logical File Name
+  Path:      Local path to the file
+  SE:        DIRAC Storage Element
+  GUID:      GUID to use in the registration (optional)
+  LocalFile: Path to a local file listing the uploads described above, one per line, i.e.::
+
+               lfn1 localfile1 SE [GUID1]
+               lfn2 localfile2 SE [GUID2]
 
 Example:
   $ dirac-dms-add-file LFN:/formation/user/v/vhamar/Example.txt Example.txt DIRAC-USER

src/DIRAC/RequestManagementSystem/DB/RequestDB.py

@@ -5,18 +5,19 @@
 
 # We disable pylint no-callable because of https://github.com/PyCQA/pylint/issues/8138
 
-""" Frontend for ReqDB
+"""Frontend for ReqDB
 
-    :mod: RequestDB
+:mod: RequestDB
 
-    =======================
+=======================
 
-    .. module: RequestDB
+.. module: RequestDB
 
-    :synopsis: db holding Requests
+:synopsis: db holding Requests
 
-    db holding Request, Operation and File
+db holding Request, Operation and File
 """
+
 import errno
 import random
 from urllib.parse import quote_plus
@@ -600,7 +601,9 @@ def getDBSummary(self):
 
             operationQuery = (
                 session.query(
-                    Operation.Type, Operation._Status, func.count(Operation.OperationID)  # pylint: disable=not-callable
+                    Operation.Type,
+                    Operation._Status,
+                    func.count(Operation.OperationID),  # pylint: disable=not-callable
                 )
                 .group_by(Operation.Type, Operation._Status)
                 .all()
@@ -759,8 +762,9 @@ def getRequestCountersWeb(self, groupingAttribute, selectDict):
                 groupingColumn = self._get_column("Request", groupingAttribute)
 
             summaryQuery = session.query(
-                groupingColumn, func.count(Request.RequestID)
-            )  # pylint: disable=not-callable,no-member
+                groupingColumn,
+                func.count(Request.RequestID),  # pylint: disable=not-callable
+            )
 
             for key, value in selectDict.items():
                 if key == "ToDate":